Citrix Virtual Apps and Desktops SDK

New-ConfigZone

Creates a new zone in the site.

Syntax

New-ConfigZone
   [-Description <String>]
   [-EnableHybridConnectivityForResourceLeases <Boolean>]
   [-EnableVdaConnectivityForResourceLeases <Boolean>]
   [-ExternalUid <Guid>]
   [-Name] <String>
   [-TenantId <Guid>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

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

$zone = New-ConfigZone -Name "London" -Description "London branch office"
Set-ConfigSite -PrimaryZone $zone
Set-ConfigService -Service "S-1-5-21-3384143951-2794580461-1950386216-8227" -Zone $zone
<!--NeedCopy-->

Parameters

-Name

Specifies the name of the zone. Each zone in a site must have a unique name.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Length range: 1 to 64
Disallowed characters: \/#?<>\|[]

-Description

Specifies the description of the zone.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Length range: 0 to 256

-EnableHybridConnectivityForResourceLeases

Specifies the EnableHybridConnectivityForResourceLeases property associated with the zone. This enables both Gateway-Service and Direct launch for resource leases.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2012

-EnableVdaConnectivityForResourceLeases

Specifies the EnableVdaConnectivityForResourceLeases property associated with the zone. This enables connectorless lease connection (ResolutionTypeVda) instead of lease connection with connectors.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2209

-ExternalUid

Specifies the ExternalUid of the zone. This is used for cloud sites to link with the Citrix Resource Location.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TenantId

Specifies the Tenant ID that the zone is associated with. This is used for cloud sites to associate zones with particular customers.

Type: Guid
Position: Named
Default value: None
Required: False
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

None

You cannot pipe input into this cmdlet.

Outputs

Citrix.Configuration.Sdk.Zone

The newly created zone.

New-ConfigZone