Set-SCVMCheckpoint

[アーティクル]
11/16/2015

Set-SCVMCheckpoint

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

構文

Parameter Set: Default
Set-SCVMCheckpoint -VMCheckpoint <VMCheckpoint> [-Description <String> ] [-JobVariable <String> ] [-Name <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [ <CommonParameters>]

詳細説明

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.

パラメーター

-Description<String>

States a description for the specified object.

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-JobVariable<String>

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

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Name<String>

Specifies the name of a VMM object.

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-OnBehalfOfUser<System.String>

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-RunAsynchronously

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

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-VMCheckpoint<VMCheckpoint>

Specifies a VMM virtual machine checkpoint object.

エイリアス	none
必須?	true
位置は?	named
既定値	none
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

VMCheckpoint

注

This cmdlet requires a VMM checkpoint object, which can be retrieved by using the Get-SCVMCheckpoint cmdlet.

例

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

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

Example Example 3: Modify a specific checkpoint in an array of checkpoints.

The first command gets the virtual machine object named VM03, and then stores the object in the $VM variable.

The second 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"

Set-SCVMCheckpoint