System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Remove-SCVMCheckpoint コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Remove-SCVMCheckpoint」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Remove-SCVMCheckpoint コマンドレット
名前
Remove-SCVMCheckpoint
概要
VMM データベースから仮想マシン チェックポイント オブジェクトを削除します。
構文
| Remove-SCVMCheckpoint [-Confirm] [-JobGroup <Guid>] [-JobVariable <String>] [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>] [-PROTipID <Guid>] [-RunAsynchronously] -VMCheckpoint <VMCheckpoint> [-WhatIf] [<CommonParameters>] |
説明
Remove-SCVMCheckpoint コマンドレットは、Virtual Machine Manager (VMM) データベースから仮想マシン チェックポイント オブジェクトを削除します。
パラメーター
-Confirm [<SwitchParameter>]
コマンドレットの実行前に確認のプロンプトを表示します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-JobGroup <Guid>
同じジョブ グループ識別子を含む最後のコマンドが実行される直前に、一連のコマンドを実行する一連のコマンドの識別子を指定します。
| 必須 | 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>
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 を参照してください。
入力
出力
メモ
Get-SCVMCheckpoint コマンドレットを用いて取得可能な VMM チェックポイント オブジェクトが必要となります。
例
例 1 : 仮想マシンの最新のチェック ポイントを削除する
コマンド
$Checkpoint = Get-SCVMCheckpoint -VM "VM01" -MostRecent Remove-SCVMCheckpoint -VMCheckpoint $Checkpoint -Confirm
コマンドの説明
最初のコマンドは、”VM01″ のすべてのチェックポイントオブジェクトを取得し、これらのオブジェクトを $Checkpoints オブジェクト配列に格納します。この例では、VM01 に複数のチェックポイントがあることを前提としています。
2 番目のコマンドは、配列 ($Checkpoints[0]) の最初のチェックポイントを削除します。Confirm パラメーターは、チェックポイントを削除するかどうかを確認するメッセージを表示します。
例 2 : 仮想マシンの指定されたチェックポイントを削除する
コマンド
$Checkpoints = Get-SCVMCheckpoint -VM "VM01" Remove-SCVMCheckpoint -VMCheckpoint $Checkpoints[0] -Confirm
コマンドの説明
最初のコマンドは、”VM01″ のすべてのチェックポイント オブジェクトを取得し、そのオブジェクトを $Checkpoints オブジェクト配列に格納します。この例では、VM01 に少なくとも 2 つのチェックポイントがあることを前提としています。
2 番目のコマンドは、VM01 用に作成された最初のチェック ポイントである $Checkpoints 配列に格納されている最初のチェックポイントを削除します。続行する前に、確認を求めるプロンプトが表示されます。
関連するリンク
- Get-SCVMCheckpoint
- New-SCVMCheckpoint
- Restore-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 - Remove-SCVMCheckpoint (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/remove-scvmcheckpoint?view=systemcenter-ps-2016