-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
-
-
-
-
-
Get-HypLocalizedString
-
-
-
-
-
-
-
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-HypLocalizedString
Obtains human-readable and locale-aware status messages from a hosting connection.
Syntax
Get-HypLocalizedString [-LiteralPath] <String> [-Locale] <String> [-Category] <String> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [[-LookupKey] <String>] [<CommonParameters>]
<!--NeedCopy-->
Detailed Description
TODO
Related Commands
Parameters
Name | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|
LiteralPath | Specifies the path to the hypervisor connection whose strings are being queried. The path must be in one of the following formats: |
true | true (ByValue) | |
Locale | The requested locale for the message, such as “en-US”. | true | false | |
Category | The category of the localized string. | true | 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 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. |
LookupKey | The lookup key or message ID. | false | false |
Input Type
System.String
You Can Pipe A String That Contains A Path To Get-Hyplocalizedstring (Literalpath Parameter).
Return Values
Citrix.Host.Sdk.Hypervisorstring
Get-HypLocalizedString returns zero or more instances of the HypervisorString object, each of which contain the following properties:
-
Category <string>
Specifies the category of the string, such as “Exception”. -
LookupKey <string>
Specifies the unique lookup key or message ID within the category. -
DisplayText <string>
Specifies the locale-aware and human-readable text.
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.
-
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-HypLocalizedString -LiteralPath XDHyp:\Connections\MyCloud -Category Exception -Locale "en-US" -LookupKey "MyCloud.InsufficientFreeIpSpace"
Category : Exception
LookupKey : MyCloud.InsufficientFreeIpSpace
DisplayText : There are not enough free IP addresses on the network {0}
<!--NeedCopy-->
Description
This command illustrates how a single error/exception message can be obtained for a hosting operation that failed (such as a provisioning operation). The caller specifies that they need to display the message in the en-US locale. They also specify a lookup key or message ID for the message, which will have been obtained as an exception code from the failed operation. The locale and key/ID are traded for a readable message, which also includes substitutions.
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.