Set-SCVMCheckpoint

Modifies the properties of a virtual machine checkpoint object in VMM.

Description

The Set-SCVMCheckpoint cmdlet modifies the properties of a virtual machine checkpoint object in System Center Virtual Machine Manager (VMM). 

For information about creating VMM checkpoints, type: "Get-Help New-SCVMCheckpoint -detailed".

For more information about Set-SCVMCheckpoint, type: "Get-Help Set-SCVMCheckpoint -online".

Parameters

VMCheckpoint

Required? true
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a VMM virtual machine checkpoint object.

Description

Required? false
Accept Pipeline Input? false
Position? named 
States a description for the specified object.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named 
Specifies that job progress is tracked and stored in the variable named by this parameter.

Name

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the name of a VMM object.

PROTipID

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named 
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

Requires a VMM checkpoint object, which can be retrieved by using the Get-SCVMCheckpoint cmdlet.

Examples

1: Set the description for all checkpoints to a specified string. 
PS C:\> Get-SCVMCheckpoint | Set-SCVMCheckpoint -Description "All checkpoints created prior to upgrade"

This command gets all existing checkpoint objects from the VMM database and updates the description for these checkpoints.
2: Modify the name and description for all checkpoints. 
PS C:\> Get-VMCheckpoint | Set-VMCheckpoint –Name “Checkpoint Before Upgrade” -Description "Checkpoint was created prior to upgrade"

This command gets all existing checkpoint objects and modifies the name and description for each object.
3: Modify a specific checkpoint in an array of checkpoints. 
PS C:\> $VM = Get-SCVirtualMachine -Name "VM03"
PS C:\> Set-SCVMCheckpoint -VMCheckpoint $VM.VMCheckpoints[0] -Description “First Checkpoint Before Upgrade”

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

The last command modifies the description for the first checkpoint object in the VMCheckpoints array for VM03.

See Also