Set-SCVMCheckpoint
Set-SCVMCheckpoint
Modifies the properties of a virtual machine checkpoint object in VMM.
Syntax
Parameter Set: Default
Set-SCVMCheckpoint -VMCheckpoint <VMCheckpoint> [-Description <String> ] [-JobVariable <String> ] [-Name <String> ] [-PROTipID <Guid> ] [-RunAsynchronously] [ <CommonParameters>]
Detailed Description
The Set-SCVMCheckpoint cmdlet modifies the properties of a virtual machine checkpoint object in Virtual Machine Manager (VMM).
For information about creating VMM checkpoints, type: "Get-Help New-SCVMCheckpoint -detailed".
Parameters
-Description<String>
States a description for the specified object.
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 |
-Name<String>
Specifies the name of a VMM object.
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 |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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
Notes
- 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.
This command gets all existing checkpoint objects from the VMM database and updates the description for these checkpoints.
PS C:\> Get-SCVMCheckpoint | Set-SCVMCheckpoint -Description "All checkpoints created prior to upgrade"
2: Modify the name and description for all checkpoints.
This command gets all existing checkpoint objects and modifies the name and description for each object.
PS C:\> Get-VMCheckpoint | Set-VMCheckpoint –Name “Checkpoint Before Upgrade” -Description "Checkpoint was created prior to upgrade"
3: Modify a specific checkpoint in an array of checkpoints.
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.
PS C:\> $VM = Get-SCVirtualMachine -Name "VM03"
PS C:\> Set-SCVMCheckpoint -VMCheckpoint $VM.VMCheckpoints[0] -Description “First Checkpoint Before Upgrade”