< Back

Get-Inventory

Sun Jan 19, 2020 6:50 pm

NAME Get-Inventory



SYNOPSIS

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





SYNTAX

Get-Inventory -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]



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

[<CommonParameters>]





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

-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.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Location <VIContainer[]>

Specifies vSphere container objects (such as folders, datacenters, and clusters) you want to search for

inventory items.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-Name <String[]>

Specifies the names of the inventory objects you want to retrieve.



Required? false

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-NoRecursion [<SwitchParameter>]

Indicates that you want to disable the recursive behavior of the command.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? 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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Zero or more VIObject objects







NOTES









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



Get-Inventory -Location Datacenter -Name *Pool



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



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... ntory.html

Move-Inventory

Remove-Inventory