Checkpoint-VM

Creates a snapshot of a virtual machine.

Syntax

Checkpoint-VM
          [-Name] <String[]>
          [[-SnapshotName] <String>]
          [-AsJob]
          [-ComputerName <String[]>]
          [-Passthru]
Checkpoint-VM
          [-VM] <VirtualMachine[]>
          [[-SnapshotName] <String>]
          [-AsJob]
          [-Passthru]

Description

The Checkpoint-VM cmdlet creates a snapshot of a virtual machine.

Examples

Example 1

PS C:\>Checkpoint-VM -Name Test -SnapshotName BeforeInstallingUpdates

Checkpoints virtual machine Test, creating a snapshot of it named BeforeInstallingUpdates.

Example 2

PS C:\>Get-VM Test -ComputerName Server1 | Checkpoint-VM

Checkpoints virtual machine Test on Hyper-V host Server1.

Required Parameters

-Name

Specifies the name of the virtual machine of which a snapshot is to be taken.

Type:String[]
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:True
-VM

Specifies the virtual machine of which a snapshot is to be taken.

Type:VirtualMachine[]
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-AsJob

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ComputerName

Specifies one or more virtual machine hosts on which the virtual machine snapshot is to be created. 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.

Type:String[]
Position:Named
Default value:.
Accept pipeline input:False
Accept wildcard characters:False
-Passthru

Specifies that an object is to be passed through to the pipeline representing the virtual machine of which a snapshot is to be taken.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SnapshotName

Specifies the name of the snapshot to be taken. If not provided, a combination of the virtual machine's name and a current timestamp is used.

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Nothing by default; Microsoft.Virtualization.Powershell.Snapshot if -Passthru is specified.