powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Remove-Folder



NAME
Remove-Folder

SYNOPSIS
Removes the specified folders from their locations.

SYNTAX
Remove-Folder [-Folder] [-DeletePermanently] [-Server ] [-WhatIf] [-Confirm] [ ers>]


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


PARAMETERS
-Folder
Specify the folders you want to remove.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-DeletePermanently
Indicate 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.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm
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


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
None


NOTES




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

C:\PS>Remove-Folder -Folder "testFolder"


Removes a folder by name.





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

C:\PS>Get-Folder -Name "testFolder" | Remove-Folder


Removes a folder by object.





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

C:\PS>Get-Folder -Name "testFolder" | Remove-Folder -DeletePermanently


Permanently removes a folder.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Remove-Folder.html
Get-Folder
Move-Folder
New-Folder
Set-Folder