Citrix Virtual Apps and Desktops SDK

New-Configzone

August 3, 2023

Contributed by:

Creates a new zone in the site.

Syntax

New-ConfigZone [-Name] <String> [-Description <String>] [-ExternalUid <Guid>] [-TenantId <Guid>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Creates a new zone in the site.

A Zone represents a subset of the site infrastructure residing in a particular geographical location.

By default any new zone will be marked as secondary. To specify the primary zone use the Set-ConfigSite cmdlet.

To associate controllers with a zone use the Set-ConfigService cmdlet.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Name	Specifies the name of the zone. Each zone in a site must have a unique name.	true	true (ByPropertyName)
Description	Specifies the description of the zone.	false	true (ByPropertyName)
ExternalUid	Specifies the ExternalUid of the zone. This is used for cloud sites to link with the Citrix Resource Location.	false	true (ByPropertyName)
TenantId	Specifies the Tenant ID that the zone is associated with. This is used for cloud sites to associate zones with particular customers.	false	true (ByPropertyName)
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.	false	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminAddress	Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

None

You cannot pipe input into this cmdlet.

Return Values

Citrix.Configuration.Sdk.Zone

The newly created zone.

Examples

Example 1

C:\PS> $zone = New-ConfigZone -Name "London" -Description "London branch office"

C:\PS> Set-ConfigSite -PrimaryZone $zone

C:\PS> Set-ConfigService -Service "S-1-5-21-3384143951-2794580461-1950386216-8227" -Zone $zone
<!--NeedCopy-->

Description

Creates a new zone called ‘London’, marks it as the primary zone and moves a controller to that zone.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

New-Configzone

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

New-Configzone

Syntax

Detailed Description

Related Commands

Parameters

Input Type

None

Return Values

Citrix.Configuration.Sdk.Zone

Examples

Example 1

Description

In this article