Citrix Virtual Apps and Desktops SDK

Set-ConfigZone

Set the description of the zone.

Syntax

Set-ConfigZone
   [-NewUid <Guid>]
   [-InputObject] <Zone[]>
   [-Description <String>]
   [-EnableHybridConnectivityForResourceLeases <Boolean>]
   [-EnableVdaConnectivityForResourceLeases <Boolean>]
   [-ExternalUid <Guid>]
   [-TenantId <Guid>]
   [-PassThru]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-ConfigZone
   [-NewUid <Guid>]
   [-Uid] <Guid[]>
   [-Description <String>]
   [-EnableHybridConnectivityForResourceLeases <Boolean>]
   [-EnableVdaConnectivityForResourceLeases <Boolean>]
   [-ExternalUid <Guid>]
   [-TenantId <Guid>]
   [-PassThru]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-ConfigZone
   [-NewUid <Guid>]
   [-Name] <String[]>
   [-Description <String>]
   [-EnableHybridConnectivityForResourceLeases <Boolean>]
   [-EnableVdaConnectivityForResourceLeases <Boolean>]
   [-ExternalUid <Guid>]
   [-TenantId <Guid>]
   [-PassThru]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

This cmdlet allows you to change the description of a zone.

Controllers can be moved between zones using Set-ConfigService cmdlet. To mark zone as primary use Set-ConfigSite cmdlet.

To update the metadata associated with a zone, use the Set-ConfigZoneMetadata and Remove-ConfigZoneMetadata cmdlets.

To change the name of a zone use Rename-ConfigZone cmdlet.

Examples

EXAMPLE 1

Change the description of the ‘Sydney’ zone.

Set-ConfigZone -Name 'Sydney' -Description 'Sydney branch office'
<!--NeedCopy-->

Parameters

-InputObject

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

Type: String[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NewUid

Specifies the new uid of the Zone object.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Description

Supplies the new description.

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

-EnableHybridConnectivityForResourceLeases

Supplies the EnableHybridConnectivityForResourceLeases property of the zone

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

-EnableVdaConnectivityForResourceLeases

Supplies the EnableVdaConnectivityForResourceLeases property of the zone

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

-ExternalUid

Supplies the external Uid of the zone

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-TenantId

Supplies the Tenant ID of the zone

Type: Guid
Position: Named
Default value: None
Required: False
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 zones to be updated 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 generates a Zone object.

Set-ConfigZone