## PowerCLI Reference

# Get-Inventory

## Synopsis

This cmdlet retrieves the inventory items available on a vCenter Server system.

Syntax

Get-Inventory [-Location <VIContainer[]>] [[-Name] <String[]>] [-NoRecursion] [-Server <VIServer[]>] [<CommonParameters>]
Get-Inventory -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online version
Move-Inventory
Remove-Inventory

Detailed Description

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.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
Name | String[] | Specifies the names of the inventory objects you want to retrieve. | false | false
Id | String[] | 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. | true | false
Location | VIContainer[] | Specifies vSphere container objects (such as folders, datacenters, and clusters) you want to search for inventory items. | false | true (ByValue)
NoRecursion | SwitchParameter | Indicates that you want to disable the recursive behavior of the command. | false | false
Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no 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. | false | false

Return Type

Zero or more VIObject objects

Notes

Examples

-------------- Example 1 --------------

    Get-Inventory -Location Datacenter -Name *Pool

Retrieves all inventory items in the Datacenter datacenter, whose names end with "Pool".

Copyright © VMware, Inc. All rights reserved.