Move-BrokerAdminFolder
Moves a folder to another place in the hierarchy, optionally renaming it
Syntax
Move-BrokerAdminFolder
[-InputObject] <AdminFolder[]>
[-Destination] <AdminFolder>
[-NewName <String>]
[-PassThru]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Move-BrokerAdminFolder
[-Name] <String>
[-Destination] <AdminFolder>
[-NewName <String>]
[-PassThru]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
The Move-BrokerAdminFolder cmdlet moves a folder for organising objects for administration purposes (for example, Applications) to another position in the hierarchy.
The following special characters are not allowed in the new FolderName: \ / ; : # . * ? = \< \> \| \[ \] ( ) " ' \`
Examples
EXAMPLE 1
Moves the folder called XXX within the folder F1\ to a new home in F2\
Move-BrokerAdminFolder F1\XXX\ F2\
EXAMPLE 2
Moves the folder called XXX within the folder F1\ to a new home in F2\ renaming it to YYY in the process
Move-BrokerAdminFolder F1\XXX\ F2\ -NewName YYY
Parameters
-InputObject
The folder(s) to be moved
| Type: | AdminFolder[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Name
A pattern matching the names of folders to be moved
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-Destination
The destination folder the folder being moved should end up in
| Type: | AdminFolder |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NewName
The name the new folder should have in the destination folder
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoggingId
Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Depends on parameter
Parameters can be piped by property name.
Outputs
None or Citrix.Broker.Admin.SDK.AdminFolder
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.AdminFolder object.