Share via

Remove-SCVMCheckpoint

  • Reference
Module:
VirtualMachineManager

Removes a virtual machine checkpoint object from the VMM database.

Syntax

Remove-SCVMCheckpoint
      -VMCheckpoint <VMCheckpoint>
      [-JobGroup <Guid>]
      [-RunAsynchronously]
      [-PROTipID <Guid>]
      [-JobVariable <String>]
      [-WhatIf]
      [-Confirm]
      [-OnBehalfOfUser <String>]
      [-OnBehalfOfUserRole <UserRole>]
      [<CommonParameters>]

Description

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

Examples

Example 1: Remove the most recent checkpoint for a virtual machine

PS C:\> $Checkpoint = Get-SCVMCheckpoint -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.

Example 2: Remove a specified checkpoint for a virtual machine

PS C:\> $Checkpoints = Get-SCVMCheckpoint -VM "VM01" 
PS C:\> Remove-SCVMCheckpoint -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.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobGroup

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.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

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

-OnBehalfOfUser

Specifies the name of a user. This cmdlet sets the on behalf of user as the user that this parameter specifies.

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

-OnBehalfOfUserRole

Specifies a user role. This cmdlet sets the on behalf of user role as the user role that this parameter specifies. To obtain a user role object, use the Get-SCUserRole cmdlet.

Type:UserRole
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

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

-VMCheckpoint

Specifies a VMM virtual machine checkpoint object.

Type:VMCheckpoint
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Notes

  • Requires a VMM checkpoint object, which you can retrieve by using the Get-SCVMCheckpoint cmdlet.