Syntax
Remove-Folder [-Folder] <Folder[]> [-DeletePermanently] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]Related Commands
Online versionDetailed Description
This cmdlet removes the specified folders and their children objects from their locations.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Folder | Folder[] | Specifies the folders you want to remove. | true | true (ByValue) | |
| 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. | false | false | |
| DeletePermanently | SwitchParameter | 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. | false | 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. | false | false | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false |
Return Type
NoneNotes
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.