powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Remove-Snapshot



NAME
Remove-Snapshot

SYNOPSIS
Removes the specified virtual machine snapshots.

SYNTAX
Remove-Snapshot [-Snapshot] [-RemoveChildren] [-RunAsync] [-WhatIf] [-Confirm] []


DESCRIPTION
Removes the specified virtual machine snapshots. If the value of the RemoveChildren parameter is $true, the cmdlet
removes the child snapshots as well.


PARAMETERS
-Snapshot
Specify the snapshots you want to remove.

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

-RemoveChildren
Indicate that you want to remove the children of the specified snapshots as well.

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

-RunAsync
Indicate that the command returns immediately without waiting for the task to complete. In this mode, the outpu
t of the cmdlet is a Task object. For more information about the -RunAsync parameter run " help About_RunAsync"
in the vSphere PowerCLI console.

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

-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-Snapshot -Snapshot $snapshot1 -RemoveChildren


Removes the snapshot in the $snapshot variable and its children.






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