< Back
Remove-Folder
Post
NAME Remove-Folder
SYNOPSIS
This cmdlet removes the specified folders from their locations.
SYNTAX
Remove-Folder [-Folder] <Folder[]> [-DeletePermanently] [-Server <VIServer[]>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet removes the specified folders and their children objects from their locations.
PARAMETERS
-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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Folder <Folder[]>
Specifies the folders you want to remove.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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
OUTPUTS
None
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... older.html
Get-Folder
Move-Folder
New-Folder
Set-Folder
SYNOPSIS
This cmdlet removes the specified folders from their locations.
SYNTAX
Remove-Folder [-Folder] <Folder[]> [-DeletePermanently] [-Server <VIServer[]>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet removes the specified folders and their children objects from their locations.
PARAMETERS
-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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Folder <Folder[]>
Specifies the folders you want to remove.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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
OUTPUTS
None
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... older.html
Get-Folder
Move-Folder
New-Folder
Set-Folder