Export (0) Print
Expand All
Expand Minimize

Remove-VMSnapshot

Windows Server 2012 R2 and Windows 8.1

Updated: June 10, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Remove-VMSnapshot

Deletes a virtual machine checkpoint.

Syntax

Parameter Set: SnapshotName
Remove-VMSnapshot [-VMName] <String[]> [[-Name] <String[]> ] [-AsJob] [-ComputerName <String[]> ] [-IncludeAllChildSnapshots] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SnapshotObject
Remove-VMSnapshot [-VMSnapshot] <VMSnapshot[]> [-AsJob] [-IncludeAllChildSnapshots] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMObject
Remove-VMSnapshot [-VM] <VirtualMachine[]> [[-Name] <String[]> ] [-AsJob] [-IncludeAllChildSnapshots] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Remove-VMSnapshot deletes a virtual machine checkpoint.

Note: In Windows Server 2012 R2, virtual machine snapshots were renamed to virtual machine checkpoints. For clarity, this document will refer to virtual machine snapshots as checkpoints.

Parameters

-AsJob

Specifies that the cmdlet is to be run as a background job.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ComputerName<String[]>

Specifies one or more Hyper-V hosts on which a checkpoint is to be deleted. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer — use “localhost” or a dot (“.”) to specify the local computer explicitly.


Aliases

none

Required?

false

Position?

named

Default Value

.

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IncludeAllChildSnapshots

Specifies that the checkpoint’s children are to be deleted along with the checkpoint.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies the name of the checkpoint to be deleted.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Passthru

Specifies that an object is to be passed through to the pipeline representing the checkpoint to be deleted.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VM<VirtualMachine[]>

Specifies the virtual machine of which the checkpoint is to be deleted.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-VMName<String[]>

Specifies the name of the virtual machine of which the checkpoint is to be deleted.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMSnapshot<VMSnapshot[]>

Specifies the checkpoint to be deleted.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


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, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None by default; Microsoft.HyperV.PowerShell.VirtualMachine if –PassThru is specified.


Examples

Example 1

Deletes all checkpoints of virtual machine TestVM whose names starts with Experiment.


PS C:\> Get-VM TestVM | Remove-VMSnapshot –Name Experiment*

Example 2

Deletes all checkpoints of virtual machine TestVM older than 90 days.


PS C:\> Get-VMSnapshot -VMName TestVM | Where-Object {$_.CreationTime -lt (Get-Date).AddDays(-90) } | Remove-VMSnapshot

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft