Rename-BrokerCatalog
Renames a catalog.
Syntax
Rename-BrokerCatalog
[-InputObject] <Catalog[]>
[-PassThru]
[-NewName] <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Rename-BrokerCatalog
[-Name] <String>
[-PassThru]
[-NewName] <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
The Rename-BrokerCatalog cmdlet changes the name of a catalog. A catalog cannot have the same name as another catalog.
The following special characters are not allowed in a catalog name: \ / ; : # . * ? = \< \> \| \[ \] ( ) " ' \`
Examples
EXAMPLE 1
Renames the catalog with the name "Old Name" to "New Name".
Rename-BrokerCatalog -Name "Old Name" -NewName "New Name"
EXAMPLE 2
Renames the catalog with the name "Old Name" to "New Name".
c:\$catalog = Get-BrokerCatalog -Name "Old Name"
Rename-BrokerCatalog -InputObject $catalog -NewName "New Name"
Parameters
-InputObject
Specifies the catalog to rename.
| Type: | Catalog[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Name
Specifies the name of the catalog to rename.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-NewName
Specifies the new name of the catalog.
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| 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 Rename-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.