Export (0) Print
Expand All
Expand Minimize

Get-SCVMCheckpoint

Updated: April 29, 2014

Applies To: System Center 2012 R2 Virtual Machine Manager

Get-SCVMCheckpoint

Gets virtual machine checkpoint objects from the VMM database.

Syntax

Parameter Set: Connection
Get-SCVMCheckpoint [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: ID
Get-SCVMCheckpoint [-ID <Guid> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: VM
Get-SCVMCheckpoint [-MostRecent] [-VM <VM> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]




Detailed Description

The Get-SCVMCheckpoint cmdlet gets one or more virtual machine checkpoint objects from the Virtual Machine Manager (VMM) database.

A virtual machine checkpoint is a point-in-time snapshot of a virtual machine. You can use the checkpoint to revert a virtual machine to a previous state. For more information about VMM checkpoints, type Get-Help New-VMCheckpoint -detailed.

Parameters

-ID<Guid>

Specifies the numerical identifier as a globally unique identifier (GUID) for a specific object.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MostRecent

Specifies the most recent VMM virtual machine checkpoint object.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VM<VM>

Specifies a virtual machine object.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-VMMServer<ServerConnection>

Specifies a VMM server object.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

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.

  • VMCheckpoint

Examples

Example 1: Get all existing checkpoints for each virtual machine

This command gets all existing checkpoint objects for each virtual machine managed by VMMServer01, and then displays information about these checkpoint objects.


PS C:\> Get-SCVMCheckpoint -VMMServer "VMMServer01.Contoso.com"

Example 2: Get all checkpoints for one or more virtual machines with a specific name

The first command gets all checkpoint objects for virtual machine VM01, and then stores the objects in the $Checkpoints object array.

The second command displays information about the checkpoint objects in $Checkpoints.


PS C:\> $Checkpoints = Get-SCVMCheckpoint -VM "VM01"
PS C:\> $Checkpoints

Example 3: Get the hardware profile of the most recently created checkpoint on a VM deployed on a Hyper-V host

The first command gets the virtual machine object named VM01, and then stores the object in the $VM variable.

The second command gets the most recent checkpoint object created for VM01, and then stores the object in the $Checkpoint variable.

The last command displays information about the hardware profile for checkpoint stored in $Checkpoint. This is the most recent checkpoint object created for VM01.


PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> $Checkpoint = $VM | Get-SCVMCheckpoint -MostRecent
PS C:\> $Checkpoint.CheckpointHWProfile

Example 4: Display the .NET type, events, methods, and properties for checkpoint objects

The first command gets all checkpoint objects on VMMServer01, and then stores the objects in the $Checkpoints object array.

The second command passes each checkpoint object in $Checkpoints to the Get-Member cmdlet, which displays the .NET TypeName and the Name, MemberType, and Definition for each event, method, and property associated with this object type.

The last command is the same as the second command except that it passes the output to the Format-List cmdlet by using the pipeline operator so that you can see the complete definition for each event, method, and property for the checkpoint object type.


PS C:\> $Checkpoints = Get-SCVMCheckpoint -VMMServer "VMMServer01.Contoso.com"
PS C:\> $Checkpoints | Get-Member
PS C:\> $Checkpoints | Get-Member | Format-List

Related topics

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