Remove-Folder Command | Vmware PowerCLI Reference

Remove-Folder

This cmdlet removes the specified folders and their children objects from their locations.

Syntax

Remove-Folder
-Folder < Folder[] >
[-DeletePermanently ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Folder Folder[] named
  • pipeline
  • wildcards
Specifies the folders you want to remove.
optional DeletePermanently SwitchParameter named
Indicates 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.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.

Output

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.

Related Commands

Folder

This cmdlet retrieves the folders available on a vCenter Server system.

This cmdlet moves a vCenter Server folder from one location to another.

This cmdlet creates a new folder on a vCenter Server system.

This cmdlet removes the specified folders from their locations.

This cmdlet modifies the properties of the specified folder.