Remove-SCVMCheckpoint
Applies To: System Center 2012 R2 Virtual Machine Manager
Remove-SCVMCheckpoint
Removes a virtual machine checkpoint object from the VMM database.
Syntax
Parameter Set: Default
Remove-SCVMCheckpoint -VMCheckpoint <VMCheckpoint> [-JobGroup <Guid> ] [-JobVariable <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-SCVMCheckpoint cmdlet removes a virtual machine checkpoint object from the Virtual Machine Manager (VMM) database.
Parameters
-JobGroup<Guid>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMCheckpoint<VMCheckpoint>
Specifies a VMM virtual machine checkpoint object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before executing the command.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
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.
Notes
- This cmdlet requires a VMM checkpoint object, which can be retrieved by using the Get-SCVMCheckpoint cmdlet.
Examples
Example 1: Remove the most recent checkpoint for a virtual machine
The first command gets all checkpoint objects for VM01, and then 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.
PS C:\> $Checkpoint = Get-VMCheckpoint -VM "VM01" -MostRecent
PS C:\> Remove-SCVMCheckpoint -VMCheckpoint $Checkpoint -Confirm
Example 2: Remove a specified checkpoint for a virtual machine
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 in the $Checkpoints array, which is the first checkpoint created for VM01. The command prompts you for confirmation before proceeding.
PS C:\> $Checkpoints = Get-VMCheckpoint -VM "VM01"
PS C:\> Remove-VMCheckpoint -VMCheckpoint $Checkpoints[0] -Confirm