-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
-
-
-
-
-
Get-HypInventoryItem
-
-
-
-
-
-
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-HypInventoryItem
Introduced in: Citrix Virtual Apps and Desktop 7 2303
Gets the resource items and child items from specified inventory locations using the resource type and a set of filtering and pagination parameters.
Syntax
Get-HypInventoryItem
-ResourceType <String[]>
[-ContinuationToken <String>]
[-MaxRecords <Int32>]
[-Skip <Int32>]
[-ContainsName <String>]
[-ForwardDirection <Boolean>]
[-Tags <String>]
[-Id <String>]
[-AdditionalDataFilter <String>]
[-Template <String>]
[-Warn <Boolean>]
[-Force <Boolean>]
[-LiteralPath] <String>
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
The `Get-HypInventoryItem` cmdlet gets the resource items and child items from specified inventory locations using the resource type and a set of filtering and pagination parameters.
`Get-HypInventoryItem` requires a Hosting Unit path and the ResourceType parameter. The ResourceType specifies the resource extension, such as `template`, `vm`, etc.
Optional parameters control how many items to return, where to start the list of items and how to filter items so that only a subset are returned.
Examples
EXAMPLE 1
Gets the first template resource from the ctx-test Hosting Unit
PS C:\Users\admin> Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType vm
AdditionalData : {[ServiceOfferingDescription, T3 Micro Instance], [TenancyType, Shared], [NetworkMappings,
[[["subnet-074242d7489b7209e","us-east-1a.availabilityzone\\10.0.128.0/17
(vpc-0fa6e41d72507f877).network"]]]], [SecurityGroups, ["private.securitygroup"]]...}
FullName : aws-test-non-persistent-vda-win2022 (i-0d2abbcbc89876ed2).vm
FullPath :
Id : i-0d2abbcbc89876ed2
IsContainer : False
IsMachine : True
IsSnapshotable : True
IsSymLink : False
Name : aws-test-non-persistent-vda-win2022 (i-0d2abbcbc89876ed2)
ObjectPath : /aws-test-non-persistent-vda-win2022 (i-0d2abbcbc89876ed2).vm
ObjectType : Vm
ObjectTypeName : vm
PS C:\Users\admin> Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template
Description : Canonical, Ubuntu, 16.04 LTS, amd64 xenial image build on 2019-06-28
HasPersistentRootVolume : True
IsWindowsTemplate : True
Owner : 679593333241
AdditionalData : {[BlockDeviceCount, 1], [EnaSupport, True], [HibernationSupported, False], [Warning, Unable
to find snapshot or instance for AMI;]...}
FullName : ubuntu/images/hvm-ssd/ubuntu-xenial-16.04-amd64-server-20190628-d83d0782-cb94-
46d7-8993-f4ce15d1a484-ami-0cfee17793b08a293.4 (ami-021d9d94f93a07a43).template
FullPath :
Id : ami-021d9d94f93a07a43
IsContainer : False
IsMachine : False
IsSnapshotable : False
IsSymLink : False
Name : ubuntu/images/hvm-ssd/ubuntu-xenial-16.04-amd64-server-20190628-d83d0782-cb94-
46d7-8993-f4ce15d1a484-ami-0cfee17793b08a293.4 (ami-021d9d94f93a07a43)
ObjectPath : /ubuntu/images/hvm-ssd/ubuntu-xenial-16.04-amd64-server-20190628-d83d0782-cb94
-46d7-8993-f4ce15d1a484-ami-0cfee17793b08a293.4 (ami-021d9d94f93a07a43).template
ObjectType : Template
ObjectTypeName : template
PS C:\Users\admin> Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType template -ContainName persistent | select Name
Name
----
test-non-persistent-vda-win2022 (ami-0a2d913927e0352f3)
PS C:\Users\admin> Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType vm -MaxRecords 100 | select Name
Name
----
test-non-persistent-vda-win2022 (i-0f33601c7439a81aa)
test-Automation (i-021f404ff81e4b3b3)
test-non-persistent-vda-win2022-2 (i-0821ca8ba8c3d171c)
test-Bastion (i-026182c752bd20329)
test-AD (i-09dcfc3180ac723ea)
test-non-persistent-hibernation-vda-win2022 (i-02747245f4fd643e6)
test-Ubuntu-MP-test (i-0f311930f6509955b)
test-persistent-vda (i-00c55f1107b662c04)
aws-test-non-persistent-vda-win2022 (i-0d2abbcbc89876ed2)
PS C:\Users\admin> Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType vm -MaxRecords 100 -Skip 2 | select Name
Name
----
test-non-persistent-vda-win2022-2 (i-0821ca8ba8c3d171c)
test-Bastion (i-026182c752bd20329)
test-AD (i-09dcfc3180ac723ea)
test-non-persistent-hibernation-vda-win2022 (i-02747245f4fd643e6)
test-Ubuntu-MP-test (i-0f311930f6509955b)
test-persistent-vda (i-00c55f1107b662c04)
aws-test-non-persistent-vda-win2022 (i-0d2abbcbc89876ed2)
<!--NeedCopy-->
EXAMPLE 2
This will return first 100 launch template versions in that hosting unit.
PS C:\Users\admin> Get-HypInventoryItem -ResourceType "launchtemplateversion" -LiteralPath "XDHyp:\HostingUnits\ctx-test" -MaxRecords 100
<!--NeedCopy-->
EXAMPLE 3
This will return 100 launch template versions after skipping first 100 in that hosting unit.
PS C:\Users\admin> Get-HypInventoryItem -ResourceType "launchtemplateversion" -LiteralPath "XDHyp:\HostingUnits\ctx-test" -MaxRecords 100 -Skip 100
<!--NeedCopy-->
EXAMPLE 4
Examples of Additional Data returned for launch template version and different filters and Parameters.
PS C:\Users\admin> $items = Get-HypInventoryItem -ResourceType "launchtemplateversion" -LiteralPath "XDHyp:\HostingUnits\ctx-test" -MaxRecords 200
PS C:\Users\admin> $items[0].AdditionalData
Key Value
--- -----
ServiceOfferingDescription T3 Large Instance
TenancyType Shared
HibernationSupported False
NetworkMappings [[["subnet-074242d7489b7209e","us-east-1a.availabilityzone\\10.0.128.0/17 (vpc-0fa6e41d72507f877).network"]]]
SecurityGroups ["private.securitygroup"]
PositionAndCount {"Item1":1,"Item2":1}
Hypervisor nitro
TotalItemsCount 29
TotalFilteredItemsCount 29
Tags {"user":["test-user"]}
PS C:\Users\admin> $items[5].AdditionalData
Key Value
--- -----
ServiceOfferingDescription T3 Small Instance
TenancyType Shared
HibernationSupported False
NetworkMappings [[["subnet-074242d7489b7209e","us-east-1a.availabilityzone\\10.0.128.0/17 (vpc-0fa6e41d72507f877).network"]],[["subnet-074242d7489b7209e","us-east-1a.availabilityzone\\10.0.128.0/17 (vpc-0fa6e41d72507f877).network"]]]
SecurityGroups ["private.securitygroup"]
PositionAndCount {"Item1":2,"Item2":12}
Hypervisor nitro
PS C:\Users\admin> $items = Get-HypInventoryItem -ResourceType "launchtemplateversion" -LiteralPath "XDHyp:\HostingUnits\ctx-test" -MaxRecords 200 -Template "ami-01548d6ca90670e7e" -Warn $true
PS C:\Users\admin> $items[3].AdditionalData
Key Value
--- -----
ServiceOfferingDescription T2 Medium Instance
TenancyType Shared
HibernationSupported False
PositionAndCount {"Item1":1,"Item2":1}
Hypervisor xen
Warning Block device count mismatch;
PS C:\Users\admin> Get-HypInventoryItem -ResourceType "launchtemplateversion" -LiteralPath "XDHyp:\HostingUnits\ctx-test" -MaxRecords 5 -Warn $true -AdditionalDataFilter "{'Hypervisor' : 'nitro'}" | Select Name
Name
----
lt-0bb652503d45dcbcd (9)
lt-0e1146edd2bbd3d18 (1)
lt-0e1146edd2bbd3d18 (2)
lt-0e1146edd2bbd3d18 (3)
lt-0e1146edd2bbd3d18 (4)
<!--NeedCopy-->
EXAMPLE 5
Gets the first 5 launch template verions and VMs sorted together.
$items = Get-HypInventoryItem -ResourceType "launchtemplateversion" -LiteralPath "XDHyp:\HostingUnits\ctx-test" -MaxRecords 5 | Select FullPath
FullPath
--------
XDHyp:\HostingUnits\ctx-test\us-east-1a.availabilityzone\apollo-MasterVM (i-09dcfc3180ac723ea).vm
XDHyp:\HostingUnits\ctx-test\us-east-1a.availabilityzone\apollo-Test (i-0bc588dfb8e6cf17a).vm
XDHyp:\HostingUnits\ctx-test\Apollo-Test (lt-02f7cda779642e62f).launchtemplate\lt-02f7cda779642e62f (1).launchtemplateversion
XDHyp:\HostingUnits\ctx-test\Apollo-Test (lt-02f7cda779642e62f).launchtemplate\lt-02f7cda779642e62f (2).launchtemplateversion
XDHyp:\HostingUnits\ctx-test\us-east-1a.availabilityzone\apollo-Test2 (i-021f404ff81e4b3b3).vm
<!--NeedCopy-->
EXAMPLE 6
Examples of Additional Data return for snapshot data type with different filtering parameters. Note: Tags and Custom Attributes both are used in -Tags parameter. The first element in AdditionalData will list all possbile Tag values.
PS C:\Users\admin> $items = Get-HypInventoryItem -LiteralPath "XDHyp:\HostingUnits\ctx-test" -ResourceType "snapshot" -MaxRecords 10
PS C:\Users\admin> $items[0].AdditionalData
Key Value
--- -----
GuestOsId windows2022srvNext_64Guest
TotalItemsCount 47
TotalFilteredItemsCount 47
Tags {"Tag_1": ["Category_1]", "Custom_Attribute": ["Custom_Attribute_Value_1", "Custom_Attribute_Value_2"]}
PS C:\Users\admin> $items = Get-HypInventoryItem -LiteralPath 'XDHyp:\HostingUnits\ctx-test' -ResourceType "snapshot" -MaxRecords 10 -Tags '{ "Tag_1": "Category_1", "Custom_Attribute": "Custom_Attribute_Value_1" }' -AdditionalDataFilter '{"GuestOsId": "windows2022srvNext_64Guest"}' | Select Name
Name
----
VMSnapshot20
PS C:\Users\admin> $items[0].AdditionalData
Key Value
--- -----
GuestOsId windows2022srvNext_64Guest
TotalItemsCount 47
TotalFilteredItemsCount 1
Tags {"Tag_1": ["Category_1]", "Custom_Attribute": ["Custom_Attribute_Value_1", "Custom_Attribute_Value_2"]}
<!--NeedCopy-->
Parameters
-ResourceType
This parameter specifies the type of the resources to return. This is a required parameter and corresponds to the resource Name extension, such as `template`, `vm`, ‘launchtemplateversion’ (only supported in AWS), or ‘snapshot’ (supported in VMware, Azure). For Azure and AWS, this parameter supports multiple inputs.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | False |
-LiteralPath
This specifies the XDHyp:\ path to the Hosting Unit for the inventory to use. This parameter is required.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | True |
-ContinuationToken
This parameter controls where to start including items from the inventory. This is usually the `Id` of an item and the included items begin after the given item is found.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | True |
-MaxRecords
The maximum number of items to return for the given call of the cmdlet. The default is to return one item.
Type: | Int32 |
Position: | Named |
Default value: | 1 |
Required: | False |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | False |
-Skip
Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.
Type: | Int32 |
Position: | Named |
Default value: | 0 |
Required: | False |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | False |
-ContainsName
This parameter filters items so that only the ones containing the given string in the `Name` are included.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | True |
-ForwardDirection
Specifies whether the items are returned in forward page order (the default) or reverse.
Type: | Boolean |
Position: | Named |
Default value: | True |
Required: | False |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | False |
-Tags
This parameter specifies a JSON dictionary where the keys are the tag names and the values are the tag values. The parameter is used to filter items which have the given tags. An item must have all the given tags to match. Special values of `Not tagged` and `All values` are supported. For VMware, refer for additional usage details.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | True |
-Id
This parameter returns a single item with the given Identifier.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | True |
-AdditionalDataFilter
This specifies a JSON dictionary of parameters to use in filtering resources using the AdditionalData properties. All values given must match for an item to be included.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | True |
-Template
This parameter is used for the Machine Profile ResourceTypes only. It specifies a Template identifier or name to use in validation of the Machine Profile with the given Template. The validation will pass if the given Machine Profile resource is compatible with the given Template. Only Machine Profiles which pass this validation are included.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | True |
-Warn
This parameter is used for along with any validation filtering parameter (such as TemplateId). It specifies that rather than excluding the items which failed validation, the item is included but with a Warning property added to the AdditionalData. This property carries a string which describes the reason for validation failure.
Type: | Boolean |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | True (ByValue) |
Accept wildcard characters: | False |
-Force
Specifies whether to return the full list of items or whether to exclude the items created as part of Machine Creation Services. The default behavior is to exclude the MCS created items.
Type: | Boolean |
Position: | Named |
Default value: | False |
Required: | False |
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
None
You can’t pipe objects to this cmdlet.
Outputs
PSObject
A list of inventory items which are found in the given Hosting Unit inventory of the given ResourceType and matching any optional filtering parameters. As a convenience the first item of the list contains AdditionalData fields for `TotalItemsCount`, `TotalFilteredItemsCount` and `Tags`. These fields provide the counts of all the items of the ResourceType in the inventory, the set of items which would match the filters and a set of tags which may be used to filter the items, respectively.
Notes
For filtering in VMware, Tag’s name is treated as the key and its category name as the value. Apart from Tags, VMware also has Custom Attributes which are key-value pair based metadata for the resources. Both of them can be applied to filtering using `-Tags` parameter.
In VMware, snapshots don’t have tags or custom attributes of their own. So, these values are fetched from their parent VMs.
Related Links
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.