Citrix Virtual Apps and Desktops SDK

Get-Configzone

August 3, 2023

Contributed by:

Gets zones configured for this site.

Syntax

Get-ConfigZone [[-Name] <String>] [-Uid <Guid>] [-ControllerName <String>] [-ControllerSid <String>] [-Description <String>] [-ExternalUid <Guid>] [-HasValidEdgeServers <Boolean>] [-IsHealthy <Boolean>] [-IsPrimary <Boolean>] [-Metadata <String>] [-TenantId <Guid>] [-Property <String[]>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Retrieves zones matching the specified criteria. If no parameters are specified all zones will be returned.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Name	Gets zones with the specified name.	false	true (ByValue, ByPropertyName)
Uid	Gets the zone with the specified UID.	false	true (ByPropertyName)
ControllerName	Gets the zone that contains a specified Controller identified by Name.	false	false
ControllerSid	Gets the zone that contains a specified Controller identified by SID.	false	false
Description	Gets zones with the specified description.	false	false
ExternalUid	Specifies the ExternalUid of the zone. This is used for cloud sites to link with the Citrix Resource Location.	false	false
HasValidEdgeServers	Gets zones with the specified value of the HasValidEdgeServers property.	false	false
IsHealthy	Gets zones with the specified value of the IsHealthy property.	false	false
IsPrimary	Gets zones with the specified value of the IsPrimary flag. If true, only the primary zone may be returned; if false, all other zones may be returned.	false	false
Metadata	Gets records with matching metadata entries.
The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata “abc:x*” matches records with a metadata entry having a key name of “abc” and a value starting with the letter “x”.	false	false
TenantId	Gets the zones associated with the specified Tenant ID	false	false
Property	Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.	false	false
ReturnTotalRecordCount	When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Config_Filtering for details.	false	false	False
MaxRecordCount	Specifies the maximum number of records to return.	false	false	250
Skip	Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.	false	false	0
SortBy	Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.	false	false	The default sort order is by name or unique identifier.
Filter	Gets records that match a PowerShell-style filter expression. See about_Config_Filtering for details.	false	false
FilterScope	Gets only results allowed by the specified scope id.	false	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	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

Get-ConfigZone returns an object for each matching zone.

Examples

Example 1

C:\PS> Get-ConfigZone -Name "London"
<!--NeedCopy-->

Description

Gets the details of the zone with the specific name.

Example 2

C:\PS> Get-ConfigZone -IsPrimary $false
<!--NeedCopy-->

Description

Lists all non-primary zones.

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

Get-Configzone

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Get-Configzone

Syntax

Detailed Description

Related Commands

Parameters

Input Type

None

Return Values

Citrix.Configuration.Sdk.Zone

Examples

Example 1

Description

Example 2

Description

In this article