Remove-Snapshot

NAME Remove-Snapshot



SYNOPSIS

This cmdlet removes the specified virtual machine snapshots.





SYNTAX

Remove-Snapshot [-Snapshot] <Snapshot[]> [-RemoveChildren] [-RunAsync] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

This cmdlet removes the specified virtual machine snapshots. If the value of the RemoveChildren parameter is

$true, the cmdlet removes the child snapshots as well.





PARAMETERS

-RemoveChildren [<SwitchParameter>]

Indicates that you want to remove the children of the specified snapshots as well.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-RunAsync [<SwitchParameter>]

Indicates that the command returns immediately without waiting for the task to complete. In this mode, the

output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help

About_RunAsync" in the VMware PowerCLI console.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Snapshot <Snapshot[]>

Specifies the snapshots you want to remove.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



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



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



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... pshot.html

Get-Snapshot

New-Snapshot

Set-Snapshot