Set-SCVMCheckpoint
VMM の仮想マシン チェックポイント オブジェクトのプロパティを変更します。
構文
Set-SCVMCheckpoint
-VMCheckpoint <VMCheckpoint>
[-Description <String>]
[-Name <String>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>]
説明
Set-SCVMCheckpoint コマンドレットは、仮想マシン マネージャー (VMM) の仮想マシン チェックポイント オブジェクトのプロパティを変更します。
VMM チェックポイントの作成については、「Get-Help New-SCVMCheckpoint -Detailed
」と入力します。
例
例 1: すべてのチェックポイントの説明を指定された文字列に設定する
PS C:\> Get-SCVMCheckpoint | Set-SCVMCheckpoint -Description "All checkpoints created prior to upgrade"
このコマンドは、VMM データベースから既存のすべてのチェックポイント オブジェクトを取得し、これらのチェックポイントの説明を更新します。
例 2: すべてのチェックポイントの名前と説明を変更する
PS C:\> Get-SCVMCheckpoint | Set-SCVMCheckpoint -Name "Checkpoint Before Upgrade" -Description "Checkpoint was created prior to upgrade"
このコマンドは、既存のすべてのチェックポイント オブジェクトを取得し、各オブジェクトの名前と説明を変更します。
例 3: チェックポイントの配列内の特定のチェックポイントを変更する
PS C:\> $VM = Get-SCVirtualMachine -Name "VM03"
PS C:\> Set-SCVMCheckpoint -VMCheckpoint $VM.VMCheckpoints[0] -Description "First Checkpoint Before Upgrade"
最初のコマンドは、VM03 という名前の仮想マシン オブジェクトを取得し、そのオブジェクトを $VM 変数に格納します。
最後のコマンドは、VM03 の VMCheckpoints 配列内の最初のチェックポイント オブジェクトの説明を変更します。
パラメーター
-Description
チェックポイントの説明を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-JobVariable
ジョブの進行状況を追跡し、このパラメーターによって指定された変数に格納することを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Name
VMM オブジェクトの名前を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-OnBehalfOfUser
ユーザーの名前を指定します。 このコマンドレットは、このパラメーターが指定するユーザーとしてユーザーの代理を設定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-OnBehalfOfUserRole
ユーザー ロールを指定します。 このコマンドレットは、このパラメーターが指定するユーザー ロールとしてユーザー ロールの代理を設定します。 ユーザー ロール オブジェクトを取得するには、Get-SCUserRole コマンドレットを使用します。
型: | UserRole |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PROTipID
このアクションをトリガーしたパフォーマンスとリソースの最適化のヒント (PRO ヒント) の ID を指定します。 このパラメーターを使用すると、PRO のヒントを監査できます。
型: | Guid |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RunAsynchronously
コントロールがコマンド シェルにすぐに戻るように、ジョブが非同期的に実行されることを示します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-VMCheckpoint
VMM 仮想マシンチェックポイント オブジェクトを指定します。
型: | VMCheckpoint |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
出力
VMCheckpoint
このコマンドレットは、VMCheckpoint オブジェクトを返します。
メモ
- Get-SCVMCheckpoint コマンドレットを使用して取得できる VMM チェックポイント オブジェクトが必要です。