Share via

Set-SCVMCheckpoint

  • Reference
Module:
VirtualMachineManager

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

Syntax

Set-SCVMCheckpoint
   -VMCheckpoint <VMCheckpoint>
   [-Description <String>]
   [-Name <String>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

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.

Examples

Example 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.

Example 2: Modify the name and description for all checkpoints

PS C:\> Get-SCVMCheckpoint | Set-SCVMCheckpoint -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.

Example 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.

Parameters

-Description

Specifies a description for a checkpoint.

Type:String
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

-Name

Specifies the name of a VMM object.

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

Outputs

VMCheckpoint

This cmdlet returns a VMCheckpoint object.

Notes

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