-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
-
-
-
-
-
Get-HypConnectionRegion
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Get-HypConnectionRegion
Enumerates the regions of a hypervisor connection that are based on cloud technology.
Syntax
Get-HypConnectionRegion [-LiteralPath] <String> [-BearerToken <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.
Related Commands
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: |
true | true (ByValue) | |
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 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.
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.