Get-Inventory
This cmdlet retrieves the inventory items available on a vCenter Server system. The cmdlet returns a set of inventory items that correspond to the filter criteria specified by the provided parameters. To specify a server different from the default one, use the -Server parameter.
Syntax
[-Location
<VIContainer[]>]
[-Name <String[]>]
[-NoRecursion]
[-Server <VIServer[]>]
[CommonParameters]
[-Name <String[]>]
[-NoRecursion]
[-Server <VIServer[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional |
|
VIContainer[] | named |
|
Specifies vSphere container objects (such as folders, datacenters, and clusters) you want to search for inventory items. | optional |
|
String[] | named |
|
Specifies the names of the inventory objects you want to retrieve. | optional |
|
SwitchParameter | named |
|
Indicates that you want to deactivate the recursive behavior of the command. | optional |
|
VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String[] | named |
|
Specifies the IDs of the inventory objects you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list. | optional |
|
VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. |
Output
VMware.VimAutomation.ViCore.Types.V1.Inventory.InventoryItem
Examples
Example 1
Get-Inventory -Location Datacenter -Name *Pool
Retrieves all inventory items in the Datacenter datacenter, whose names end with "Pool".
Related Commands
Inventory
This cmdlet retrieves the inventory items available on a vCenter Server system.
This cmdlet moves a vCenter Server inventory item from one location to another.
This cmdlet removes the specified inventory items from their locations.
