Move-BrokerCatalog
Introduced in: Citrix Virtual Apps and Desktop 7 2112
Move a catalog from one admin folder to another
Syntax
Move-BrokerCatalog
[-InputObject] <Catalog[]>
[-PassThru]
[-Destination] <AdminFolder>
[-NewName <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Move-BrokerCatalog
[-Name] <String>
[-PassThru]
[-Destination] <AdminFolder>
[-NewName <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
The Move-BrokerCatalog cmdlet moves a catalog from one place to another in the tree of admin folders, optionally renaming it in the process (if you only want to change the name of the catalog for administrative purposes and not its location in the tree, use the Rename-BrokerCatalog cmdlet).
The location and name of a catalog in this sense is only of interest to the administrator, changes do not affect the end-user experience.
Examples
Parameters
-InputObject
The catalog(s) to be moved
| Type: | Catalog[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Name
The name of the catalog to be moved
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-Destination
The destination location within the admin folder hierarchy.
| Type: | AdminFolder |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NewName
The new name of the catalog in its new destination
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 64 |
| Disallowed characters: | /;:#.*?=<>\|[]()"' and all ASCII control characters |
-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
Citrix.Broker.Admin.SDK.Catalog
You can pipe catalogs to Move-BrokerCatalog.
Outputs
None or Citrix.Broker.Admin.SDK.Catalog
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.Catalog object.