Get-HypConfigurationObjectForItem
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-HypConfigurationObjectForItem
[-LiteralPath] <String>
[<CitrixCommonParameters>]
[<CommonParameters>]
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 (GB).
Examples
EXAMPLE 1
This command gets the configuration properties for a VM called 'MyVm.vm' within a hypervisor connection called 'MyConnection'.
Get-HypConfigurationDataForItem -LiteralPath XDHyp:\Connections\MyConnection\MyVm.vm
CpuCount MemoryMB HardDiskSizeGB
-------- -------- --------------
1 1024 24
EXAMPLE 2
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).
XDHyp:\HostingUnits\PS>Get-HypConfigurationDataForItem -LiteralPath .\MyVm.vm
CpuCount MemoryMB HardDiskSizeGB
-------- -------- --------------
1 1024 24
EXAMPLE 3
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 \<ItemPath\>) \| Get-Member".
(Get-HypConfigurationDataForItem -LiteralPath XDHyp:\Connections\MyConnection\MyVm.vm).CPUCount
Parameters
-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;
\<drive\>:\Connections\\\<Connection Name\>\\\<Item Path of VM object\>
or \<drive\>:\Connections\{\<connection Uid\>\\\<Item Path of VM object\>}
or \<drive\>:\HostingUnits\\\<HostingUnit Name\>\\\<Item Path of VM object\>
or \<drive\>:\HostingUnits\{\<hostingUnit Uid\>\\\<Item Path of VM object\>}
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
You can pipe a string the contains a path to Get-HypConfigurationDataForItem
Outputs
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.
Network Map
The networks that this VM or Snaphot is connected to.
Notes
For this release this cmdlet only provides configuration data for VM objects in the provider. Using a path to an item that is not a VM will result in a error.
In the case of failure the following errors can be produced.
Error Codes
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 whilst attempting a database operation.
DatabaseNotConfigured
The operation could not be completed as the database for the service is not configured.
DataStoreException
An error occurred in the service whilst attempting a database operation - communication to database failed for
for various reasons.
CommunicationError
An error occurred whilst 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. To locate more details see the Windows event logs on the controller being used, or examine the XenDesktop logs.