System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Restore-SCVMCheckpoint コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Restore-SCVMCheckpoint」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Restore-SCVMCheckpoint コマンドレット
名前
Restore-SCVMCheckpoint
概要
指定したチェックポイントに仮想マシンを復元します。
構文
| Restore-SCVMCheckpoint [-Confirm] [-JobVariable <String>] [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>] [-PROTipID <Guid>] [-RunAsynchronously] -VMCheckpoint <VMCheckpoint> [-WhatIf] [<CommonParameters>] |
説明
Restore-SCVMCheckpoint コマンドレットは、仮想マシンを指定されたチェックポイントに復元します。仮想マシンのチェックポイントは、仮想マシンの特定時点の “スナップショット” です。チェックポイントを使用すると、仮想マシンを以前の状態に戻すことが可能です。
リストア操作が成功すると、Restore-VMCheckpoint コマンドレットはチェックポイント オブジェクトを返します。操作が失敗した場合、コマンドレットはエラー メッセージを返します。
以前のチェックポイントに仮想マシンを復元すると、直近のチェックポイントが作成された後に仮想マシンに加えられたすべての変更が破棄されます。ただし、仮想マシンを復元するチェックポイント以降に作成されたチェックポイントを含め、すべてのチェックポイントは引き続き使用可能です。したがって、仮想マシンを復元する前に新しいチェックポイントを作成し、リストア操作後に仮想マシンの現在の状態が使用可能になるようにすることを推奨します。
パラメーター
-Confirm [<SwitchParameter>]
コマンドレットの実行前に確認のプロンプトを表示します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-JobVariable <String>
ジョブの進行状況を追跡し、このパラメーターで指定された変数に格納する場合に指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-OnBehalfOfUser <String>
ユーザー名を指定します。このコマンドレットは、このパラメーターが指定するユーザーとしてユーザーの代わりに設定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-OnBehalfOfUserRole <UserRole>
ユーザー ロールを指定します。ユーザー ロールを取得するには、Get-SCUserRole コマンドレットを用います。このコマンドレットは、このパラメーターで指定するユーザー ロールの代わりに操作します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-PROTipID <Guid>
このアクションにトリガーされるパフォーマンスとリソースの最適化のヒント (PRO ヒント) を指定します。このパラメーターは、PRO ヒントを監査することができます。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-RunAsynchronously [<SwitchParameter>]
ジョブが非同期で実行、制御がすぐにコマンド シェルに戻されるかどうかを指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-VMCheckpoint <VMCheckpoint>
Virtual Machine Manager (VMM) 仮想マシンのチェックポイント オブジェクトを指定します。
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-WhatIf [<SwitchParameter>]
コマンドレットを実行する場合の挙動について表示します。コマンドレットは、実際には実行されません。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
- VMCheckpoint
- このコマンドレットは、VMCheckpoint オブジェクトを返します。
メモ
Get-SCVMCheckpoint コマンドレットを用いて取得可能な VMM チェックポイント オブジェクトが必要となります。
例
例 1 : 最新のチェックポイントを仮想マシンに復元する
コマンド
Get-SCVMCheckpoint -VM "VM01" -MostRecent | Restore-SCVMCheckpoint
コマンドの説明
このコマンドは、仮想マシン “VM01” の最新のチェックポイント オブジェクトを取得し、VM01 を最新のチェックポイントが作成された時点の状態に復元します。
例 2 : 指定したチェックポイントに仮想マシンを復元する
コマンド
$Checkpoints = Get-SCVMCheckpoint -VM "VM02" Restore-SCVMCheckpoint -VMCheckpoint $Checkpoints[$Checkpoints.count - 2]
コマンドの説明
最初のコマンドは、仮想マシン “VM02” のすべてのチェックポイント オブジェクトを取得し、オブジェクトを $Checkpoints オブジェクト配列に格納します。
2 番目のコマンドは、VM02 を最後から 2 番目のチェックポイントに復元します (この例では、少なくとも 2 つのチェックポイントがあることを前提としています)。VMM は、リストア先のチェックポイントの後に作成されたチェックポイントを保持し、仮想マシンを後のチェックポイントにリストアすることが可能です。最新のチェックポイントに仮想マシンを復元するには、例 1 を参照してください。
例 3 : 仮想マシン上で最後に復元されたチェックポイントのハードウェア プロファイルを表示する
コマンド
$VM = Get-SCVirtualMachine -Name "VM02" $VM.LastRestoredVMCheckpoint.CheckpointHWProfile
コマンドの説明
最初のコマンドは、仮想マシン オブジェクト “VM02” を取得し、そのオブジェクトを $VM 変数に格納します。この例では、仮想マシンがチェックポイントの 1 つにリストアされているものと想定しています。
2 番目のコマンドは、VM02 上で最後に復元されたチェックポイントのハードウェア プロファイルに関する情報を表示します。
関連するリンク
- Get-SCVirtualMachine
- Get-SCVMCheckpoint
- New-SCVMCheckpoint
- Remove-SCVMCheckpoint
- Set-SCVMCheckpoint
参考
- System Center 2016 – データセンターの管理 | Microsoft
https://www.microsoft.com/ja-jp/cloud-platform/system-center - VirtualMachineManager | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/?view=systemcenter-ps-2016 - Restore-SCVMCheckpoint (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/restore-scvmcheckpoint?view=systemcenter-ps-2016