Developer Documentation
Citrix Daas SDK

Remove-ConfigZone

August 9, 2024
Contributed by: 
C C

Removes a zone from the site.

Syntax

Remove-ConfigZone
      [-InputObject] <Zone[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-ConfigZone
      [-Uid] <Guid[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-ConfigZone
      [-Name] <String[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

This cmdlet removes zones from a site.

You cannot remove a zone that is marked as primary or has associated controllers.

Examples

EXAMPLE 1

Remove the zone specified by name. This fails if one of the zones has controllers associated.

Remove-ConfigZone -Name 'Sydney'
<!--NeedCopy-->

EXAMPLE 2

Move all controllers to the primary zone. Remove all non-primary zones.

Get-ConfigService | Set-ConfigService -Zone (Get-ConfigZone -IsPrimary $true)
Get-ConfigZone -IsPrimary $false | Remove-ConfigZone
<!--NeedCopy-->

Parameters

-InputObject

Specifies the zone to remove (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 remove (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 remove (by Name).

Type: String[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
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 zones to be deleted into this command.

Outputs

None

By default, this cmdlet returns no output.

Remove-ConfigZone
August 9, 2024
Contributed by: 
C C
August 9, 2024
Contributed by: 
C C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.