System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Remove-SCVirtualMachine コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Remove-SCVirtualMachine」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Remove-SCVirtualMachine コマンドレット
名前
Remove-SCVirtualMachine
概要
VMM から仮想マシン オブジェクトを削除します。
構文
| Remove-SCVirtualMachine [-VM] <VM> [-Confirm] [-Force] [-JobVariable <String>] [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>] [-PROTipID <Guid>] [-RunAsynchronously] [-SkipFileRemoval] [-WhatIf] [<CommonParameters>] |
説明
Remove-SCVirtualMachine コマンドレットは、ホストに展開された仮想マシン オブジェクト、もしくは Virtual Machine Manager (VMM) ライブラリ サーバーに格納されている仮想マシン オブジェクトを削除します。
このコマンドレットは、VMM データベースから仮想マシン レコードを削除し、仮想マシンに関連付けられているすべてのファイルを削除し、仮想マシンが展開されているホスト、もしくは仮想マシンを格納しているライブラリ サーバーから削除します。
Hyper-V もしくは VMware の代わりに VMM によってホスト上のフォルダーが作成され、そのフォルダーに他の仮想マシンやその他のデータが含まれていない場合、仮想マシンを削除した後、そのフォルダーを削除するためにファイル システムを使用することが可能です。
Force パラメーターを指定した場合、このコマンドレットは VMM データベースからのみ仮想マシンを削除します。仮想マシン自体は削除されません。
このコマンドレットは、成功時に MarkedForDeletion プロパティの値が $True のオブジェクトを返します。失敗した場合、コマンドレットはエラー メッセージを返します。
パラメーター
-Confirm [<SwitchParameter>]
コマンドレットの実行前に確認のプロンプトを表示します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Force [<SwitchParameter>]
このコマンドレットは VMM データベースからのみ仮想マシンを削除する場合に指定します。仮想マシン自体は削除されません。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | 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 |
-SkipFileRemoval [<SwitchParameter>]
このコマンドレットが仮想マシン関連のファイルを直接削除しない場合に指定します。このパラメーターを指定した場合、ファイルを直接削除しようとはしません。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-VM <VM>
仮想マシン オブジェクトを指定します。
| 必須 | true |
|---|---|
| 位置 | 0 |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-WhatIf [<SwitchParameter>]
コマンドレットを実行する場合の挙動について表示します。コマンドレットは、実際には実行されません。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
メモ
このコマンドレットには、Get-SCVirtualMachine コマンドレットを用いて取得可能な VMM 仮想マシン オブジェクトが必要となります。
例
例 1 : ホストに展開された特定の仮想マシンを削除する
コマンド
$VM = Get-SCVirtualMachine -VMMServer "VMMServer01.Contoso.com" | where { $_.VMHost.Name -eq "VMHost01.Contoso.com" -and $_.Name -eq "VM01" }
Remove-SCVirtualMachine -VM $VM
コマンドの説明
最初のコマンドは、仮想マシン オブジェクト “VM01” を “VMHost01.Contoso.com” に配置してから、その仮想マシン オブジェクトを $VM 変数に格納します。
2 番目のコマンドは、$VM に格納されているオブジェクトを削除し、対応する仮想マシン ファイルをホスト上のファイル システムから削除します。
例 2 : 特定の文字列を含む名前の仮想マシンをすべて削除する
コマンド
$VMs = @(Get-SCVirtualMachine -VMMServer "VMMServer01.Contoso.com" | where { $_.Name -Match "VM0" } )
$VMs | Remove-SCVirtualMachine
コマンドの説明
最初のコマンドは、名前に文字列 “VM0” が含まれるすべてのホストに展開されたすべての仮想マシン オブジェクトを取得し、これらの仮想マシン オブジェクトを $VMs という名前の配列に格納します。
2 番目のコマンドは、$VMs 配列内の各仮想マシン オブジェクトを削除し、対応する仮想マシン ファイルを各ホスト上のファイル システムから削除します。
例 3 : VMM ライブラリ サーバーに格納されている特定の仮想マシンを削除する
コマンド
$VM = Get-SCVirtualMachine -VMMServer "VMMServer01.Contoso.com" | where { $_.LibraryServer.Name -eq "LibraryServer01.Contoso.com" -and $_.Name -eq "VM03" }
Remove-SCVirtualMachine -VM $VM
コマンドの説明
最初のコマンドは、仮想マシン “VM03” を表すオブジェクトを取得し、その仮想マシン オブジェクトを $VM に格納します。 この例では、VM03 という仮想マシンが 1 つだけ存在します。
2 番目のコマンドは、ライブラリから VM03 を表すオブジェクトを削除し、対応する仮想マシン ファイルをライブラリ サーバー上のファイル システムから削除します。
例 4 : VMM ライブラリから複数の格納された仮想マシンを削除する
コマンド
$VMs = Get-SCVirtualMachine -VMMServer "VMMServer01.Contoso.com" | where { $_.LibraryServer.Name -eq "LibraryServer01.Contoso.com" -and $_.Name -match "VM0" }
$VMs | Remove-SCVirtualMachine -Confirm
コマンドの説明
最初のコマンドは、名前に “VM0” という文字列が含まれ、かつ “LibraryServer01.Contoso.com” に格納されて格納されているすべての仮想マシン オブジェクトを取得します。このコマンドは、仮想マシン オブジェクトを $VMs という配列に格納します。
2 番目のコマンドは、$VMs に格納されている各仮想マシン オブジェクトを現在のコマンドレットに渡します。このコマンドレットは、ライブラリから各オブジェクトを削除し、対応する仮想マシン ファイルをライブラリ サーバー上のファイル システムから削除します。Confirm パラメーターは、これらの仮想マシンをそれぞれ削除するかどうかを確認するメッセージを表示します。
関連するリンク
- Get-SCUserRole
- Get-SCVirtualMachine
- Move-SCVirtualMachine
- New-SCVirtualMachine
- Read-SCVirtualMachine
- Repair-SCVirtualMachine
- Resume-SCVirtualMachine
- Save-SCVirtualMachine
- Set-SCVirtualMachine
- Start-SCVirtualMachine
- Stop-SCVirtualMachine
- Suspend-SCVirtualMachine
参考
- 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-SCVirtualMachine (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/remove-scvirtualmachine?view=systemcenter-ps-2016