vSphere PowerCLI Reference

Get-Inventory

Synopsis

Retrieves the inventory items available on a vSphere server.

Syntax

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

Related Commands

Online version
Move-Inventory
Remove-Inventory

Detailed Description

Retrieves the inventory items available on a vSphere server. 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

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specify the names of the inventory objects you want to retrieve.falsefalse
IdString[]Specify the IDs of the inventory objects you want to retrieve.falsefalse
LocationVIContainer[]Specify vSphere container objects (such as folders, datacenters, and clusters) you want to search for inventory items.falsetrue (ByValue)
NoRecursionSwitchParameterIndicate that you want to disable the recursive behavior of the command.falsefalse
ServerVIServer[]Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse

Return Type

VIObject

Notes

Examples

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

Get-Inventory -Location Datacenter -Name *Pool

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


Copyright © 1998 - 2011 VMware, Inc. All rights reserved.