vSphere PowerCLI Reference

Remove-Inventory

Synopsis

Removes the specified inventory items from their locations.

Syntax

Remove-Inventory [-Item] <InventoryItem[]> [-RunAsync] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-Inventory
Move-Inventory

Detailed Description

Removes the specified inventory items and their children from their locations.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
ItemInventoryItem[]Specify the inventory items you want to remove. Accepts Folder, ResourcePool, Datacenter, VirtualMachine, VMHost, Cluster, Template, and VApp objects.truetrue (ByValue)
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falsefalse$true
RunAsyncSwitchParameterIndicate that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the -RunAsync parameter run " help About_RunAsync" in the vSphere PowerCLI console.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
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

None

Notes

Examples

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

Get-Folder Folder| Get-Inventory -NoRecursion | Remove-Inventory

Removes all objects from the Folder folder.


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