vSphere PowerCLI Reference

Remove-Folder

Synopsis

Removes the specified folders from their locations.

Syntax

Remove-Folder [-Folder] <Folder[]> [-DeletePermanently] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-Folder
Move-Folder
New-Folder
Set-Folder

Detailed Description

Removes the specified folders and their children objects from their locations.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
FolderFolder[]Specify the folders you want to remove.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
DeletePermanentlySwitchParameterIndicate that you want to delete from the disk any virtual machines contained in the specified folder, and not only to remove them from the inventory. This parameter is supported only for VirtualMachine folders.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 --------------

Remove-Folder -Folder "testFolder"

Removes a folder by name.

-------------- Example 2 --------------

Get-Folder -Name "testFolder" | Remove-Folder

Removes a folder by object.

-------------- Example 3 --------------

Get-Folder -Name "testFolder" | Remove-Folder -DeletePermanently

Permanently removes a folder.


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