-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
-
-
-
-
-
Get-HypConfigurationDataForItem
-
-
-
-
-
-
-
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-HypConfigurationDataForItem
Retrieves the configuration data for an item in the Host Service provider path. Note: For this release, only VM items are supported for this operation.
Syntax
Get-HypConfigurationDataForItem [-LiteralPath] <String> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->
Detailed Description
This command provides a mechanism for retrieving extra data about an entry in the hosting unit service provider. The referenced item must be contained within the connections directory in the provider (i.e. XDHyp:\Connections).
This mechanism is used for obtaining data that is not required frequently and/or has a high overhead associated with its retrieval (so as to maintain the responsiveness of the provider). For this release of the PowerShell snap-in, the only provider items that can be used with this operation are VM items. For a VM, this provides a mechanism to obtain the number of CPUs, the amount of Memory (in MB) and hard disk drive capacity (in GB).
Related Commands
Parameters
Name | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|
LiteralPath | Specifies the path within a hosting unit provider to the item for which configuration data is to be retrieved. The path specified must be in one of the following formats; |
-
or <drive>
:\HostingUnits<HostingUnit Name><Item Path of VM object> or:\HostingUnits{ \ - }
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 that the PowerShell snap-in connects 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
System.String
You Can Pipe A String That Contains A Path To Get-Hypconfigurationdataforitem
Return Values
Psobject
Get-HypConfigurationDataForItem returns a PSObject containing the properties that are appropriate for the item specified by the path. Properties for VM Item
-
CPUCount <int>
Specifies the number of CPUs assigned to the VM. -
MemoryMB <int>
The amount of memory allocated to the VM. -
HardDiskSizeGB <int>
The capacity of the primary hard drive assigned to the VM.
Notes
For this release, this cmdlet provides only configuration data for VM objects in the provider. Using a path to an item that is not a VM results in a error. In the case of failure the following errors can result.
-
InputHypervisorItemPathInvalid: The path provided is not to an item in a sub-directory of a connection item or a hosting unit item.
-
InvalidHypervisorItemPath: No item exists with the specified path.
-
InvalidHypervisorItem: The item specified by the path exists, but is not a VM Item.
-
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.
-
InvalidFilter: A filtering expression was supplied that could not be interpreted for this cmdlet.
-
HypervisorPermissionDenied: The hypervisor login used does not provide authorization to access the data for this item.
-
ExceptionThrown: An unexpected error occurred. For more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.
Examples
Example 1
C:\PS>Get-HypConfigurationDataForItem -LiteralPath XDHyp:\Connections\MyConnection\MyVm.vm
CpuCount MemoryMB HardDiskSizeGB
-------- -------- --------------
1 1024 24
<!--NeedCopy-->
Description
This command gets the configuration properties for a VM called ‘MyVm.vm’ within a hypervisor connection called ‘MyConnection’.
Example 2
XDHyp:\HostingUnits\PS>Get-HypConfigurationDataForItem -LiteralPath .\MyVm.vm
CpuCount MemoryMB HardDiskSizeGB
-------- -------- --------------
1 1024 24
<!--NeedCopy-->
Description
This command gets the configuration properties for a VM called ‘MyVm.vm’ within the current directory. The dot (.) represents the current location (not its contents).
Example 3
C:\PS>(Get-HypConfigurationDataForItem -LiteralPath XDHyp:\Connections\MyConnection\MyVm.vm).CPUCount
<!--NeedCopy-->
Description
This command gets the CPU count for a VM called ‘MyVm.vm’. The CPUCount is just one property of the VM items. To see all properties of an item, type “(Get-HypConfigurationDataForItem |
Get-Member”. |
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.