< Back
Remove-Inventory
Post
NAME Remove-Inventory
SYNOPSIS
This cmdlet removes the specified inventory items from their locations.
SYNTAX
Remove-Inventory [-Item] <InventoryItem[]> [-RunAsync] [-Server <VIServer[]>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet removes the specified inventory items and their children from their locations.
PARAMETERS
-Item <InventoryItem[]>
Specifies the inventory items you want to remove. This parameter accepts Folder, ResourcePool, Datacenter,
VirtualMachine, VMHost, Cluster, Template, and VApp objects.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-RunAsync [<SwitchParameter>]
Indicates 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 VMware PowerCLI console.
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
-Confirm [<SwitchParameter>]
If 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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<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
Folder, ResourcePool, Datacenter, VirtualMachine, VMHost, Cluster, Template, VApp
OUTPUTS
None
NOTES
-------------------------- Example 1 --------------------------
Get-Folder Folder| Get-Inventory -NoRecursion | Remove-Inventory
Removes all objects from the Folder folder.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... ntory.html
Get-Inventory
Move-Inventory
SYNOPSIS
This cmdlet removes the specified inventory items from their locations.
SYNTAX
Remove-Inventory [-Item] <InventoryItem[]> [-RunAsync] [-Server <VIServer[]>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet removes the specified inventory items and their children from their locations.
PARAMETERS
-Item <InventoryItem[]>
Specifies the inventory items you want to remove. This parameter accepts Folder, ResourcePool, Datacenter,
VirtualMachine, VMHost, Cluster, Template, and VApp objects.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-RunAsync [<SwitchParameter>]
Indicates 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 VMware PowerCLI console.
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
-Confirm [<SwitchParameter>]
If 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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<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
Folder, ResourcePool, Datacenter, VirtualMachine, VMHost, Cluster, Template, VApp
OUTPUTS
None
NOTES
-------------------------- Example 1 --------------------------
Get-Folder Folder| Get-Inventory -NoRecursion | Remove-Inventory
Removes all objects from the Folder folder.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... ntory.html
Get-Inventory
Move-Inventory