Citrix Virtual Apps and Desktops SDK

Get-HypConnectionRegion

March 11, 2024

Contributed by:

Enumerates the regions of a hypervisor connection that are based on cloud technology.

Syntax

Get-HypConnectionRegion [-LiteralPath] <String> [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Use this command to enumerate the available regions within a public or private cloud, when making hypervisor connections to cloud services. Sometimes, regions need to be selected and applied before the cloud connection can be used in a meaningful way. This cmdlet allows the supported regions to be listed so that one may be selected.

Once a region has been chosen, use the standard Set-Item provider cmdlet to select it. See the examples for further details.

This cmdlet may return no output, in which case the cloud connection can be considered “regionless” (or, implicitly, all within a single region). In such cases, there is no need to select a region, and the hypervisor connection can be used as is.

Set-Item

Parameters

Name	Description	Required?	Pipeline Input	Default Value
LiteralPath	Specifies the path to the hypervisor connection whose regions are being examined. This cmdlet is valid only for hypervisor connections that have the UsesCloudInfrastructure flag set to true. The path must be in one of the following formats: :\Connections\ or :\Connections{}	true	true (ByValue)
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminClientIP	Specifies the client IP of 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 to which the PowerShell snap-in connects. You can provide a host name or an IP address.	false	false	LocalHost. When a value is provided by any cmdlet, this value becomes the default.

Input Type

System.String

You Can Pipe A String That Contains A Path To Get-Hypconnectionregion (Literalpath Parameter).

Return Values

Citrix.Host.Sdk.Hypervisorregion

Get-HypConnectionRegion returns zero or more instances of the HypervisorConnectionRegion object, each of which contain the following properties:

Name <string> Specifies the unique name of the region. Endpoint <string> Specifies the URL endpoint that is specific to the region, if relevant. This may be an empty string, and is returned only for information purposes. A full list of the hypervisor networks that are exposed for use in the hosting unit.

Notes

In the case of failure, the following errors can be produced.

ConnectionsPathInvalid: The path provided is not to an item in the Connections subdirectory of the host service provider.
HypervisorConnectionObjectNotFound: The path provided could not be resolved to an existing hypervisor connection. The name or GUID is invalid.
HypervisorInMaintenanceMode: The hypervisor for the connection is in maintenance mode.
ConnectionIsNotCloud: The hypervisor connection is not associated with cloud infrastructure, making it invalid to enumerate regions.
DatabaseError: An error occurred in the service while attempting a database operation.
DatabaseNotConfigured: The operation could not be completed because the database for the service is not configured.
DataStoreException: An error occurred in the service while attempting a database operation. Communication with the database failed for various reasons.
CommunicationError: An error occurred while communicating with the service.
PermissionDenied: The user does not have administrative rights to perform this operation.
ExceptionThrown: An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used, or examine the XenDesktop logs.

Examples

Example 1

c:\PS>Get-HypConnectionRegions -LiteralPath XDHyp:\Connections\AWS

          RegionName           : us-east-1

          Endpoint             : ec2.us-east-1.amazonaws.com

          RegionName           : us-west-1

          Endpoint             : ec2.us-west-1.amazonaws.com

          RegionName           : eu-west-1

          Endpoint             : ec2.eu-west-1.amazonaws.com

          (...)

          c:\PS>Set-Item -Path XDHyp:\Connections\AWS -Region "us-east-1"

<!--NeedCopy-->

Description

This sequence of commands enumerates the available regions of an Amazon AWS cloud connection, and then selects one of them for use in the connection.

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-HypConnectionRegion

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Get-HypConnectionRegion

Syntax

Detailed Description

Related Commands

Parameters

Input Type

System.String

Return Values

Citrix.Host.Sdk.Hypervisorregion

Notes

Examples

Example 1

Description

In this article