Rename-ConfigZone

Last published : Oct 31, 2026
Rename a zone.
Related information
about_ConfigConfigurationSnapIn

Syntax

Rename-ConfigZone
      [-InputObject] <Zone>
      [-NewName] <String>
      [-PassThru]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
Rename-ConfigZone
      [-Uid] <Guid>
      [-NewName] <String>
      [-PassThru]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
Rename-ConfigZone
      [-Name] <String>
      [-NewName] <String>
      [-PassThru]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]

Description

This cmdlet renames a zone.
All zone names must be unique.

Examples

EXAMPLE 1

Renames the 'New York' zone to 'Manhattan'.
Rename-ConfigZone -Name 'New York' -NewName 'Manhattan'

Parameters

-InputObject

Specifies the zone to rename (by zone object).
Type: Zone
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Uid

Specifies the zone to rename (by Uid).
Type: Guid
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

Specifies the zone to rename (by name).
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 zone.
Type: String
Position: 3
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Returns the affected record. By default, this cmdlet does not generate any output.
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 this cmdlet call forms a part of. Citrix Studio and 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.Configuration.Sdk.Zone

You can pipe the zone to be renamed into this command.

Outputs

None or Citrix.Configuration.Sdk.Zone

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the zone with new name.