Remove-SCVMCheckpoint

Removes a virtual machine checkpoint object from the VMM database.

Description

The Remove-SCVMCheckpoint cmdlet removes a virtual machine checkpoint object from the System Center Virtual Machine Manager (VMM) database.

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

Parameters

VMCheckpoint

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

Confirm

Required? false
Accept Pipeline Input? false
Position? named 
Prompts for confirmation before running the command.

JobGroup

Required? false
Accept Pipeline Input? false
Position? named 
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs.

JobVariable

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

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: Remove the most recent checkpoint for a virtual machine. 
PS C:\> $Checkpoint = Get-VMCheckpoint -VM "VM01" -MostRecent
PS C:\> Remove-SCVMCheckpoint -VMCheckpoint $Checkpoint -Confirm

The first command gets all checkpoint objects for VM01 and stores these objects in the $Checkpoints object array. This example assumes that VM01 has several checkpoints.

The second command removes the first checkpoint in the array ($Checkpoints[0]). The Confirm parameter prompts you to confirm whether you want to remove the checkpoint.
2: Remove a specified checkpoint for a virtual machine. 
PS C:\> $Checkpoints = Get-VMCheckpoint -VM "VM01" 
PS C:\> Remove-VMCheckpoint -VMCheckpoint $Checkpoints[0] -Confirm

The first command gets all checkpoint objects for VM01 and stores the objects in the $Checkpoints object array. This example assumes that VM01 has at least two checkpoints.

The second command removes the first checkpoint stored inthe $Checkpoints array, which is the first checkpoint created for VM01. The command prompts you for confirmation before proceeding.

See Also