SCVMM 2016 UR5 で利用可能なコマンドレット (Remove-SCVirtualHardDisk) について

スポンサーリンク
Microsoft Store (マイクロソフトストア)

System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。

ここでは Remove-SCVirtualHardDisk コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Remove-SCVirtualHardDisk」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。

Remove-SCVirtualHardDisk コマンドレット

名前

Remove-SCVirtualHardDisk

概要

仮想マシン、テンプレートから、もしくは VMM ライブラリから仮想ハードディスク オブジェクトを削除します。

構文

Remove-SCVirtualHardDisk
 [-VirtualHardDisk] <VirtualHardDisk>
 [-Confirm]
 [-Force]
 [-JobGroup <Guid>]
 [-JobVariable <String>]
 [-PROTipID <Guid>]
 [-RunAsynchronously]
 [-WhatIf]
 [<CommonParameters>]

説明

Remove-SCVirtualHardDisk コマンドレットは、仮想マシン、テンプレートから、もしくは Virtual Machine Manager (VMM) ライブラリから仮想ハード ディスク オブジェクトを削除します。Remove-VirtualHardDisk は、ライブラリ サーバーから対応する仮想ハード ディスク ファイル (Windows ベースの .vhd ファイル、Citrix XenServer ベースの .vhd ファイル、もしくは VMware ベースの .vmdk ファイル) も削除します。

仮想ハード ディスクが仮想マシン、もしくはテンプレート上の仮想ディスク ドライブに接続されている場合 (および Force パラメーターを使用しない場合)、VMM は仮想ハード ディスクを含むコンテナーを一覧表示し、仮想ハードディスクを削除することを確認するように求めます :

  • Yes と応答すると、VMM は仮想ハード ディスクとそれが接続されているコンテナー間の関連付けを削除し、VMM から仮想ハード ディスク オブジェクトを削除します。
  • No と応答すると、操作はキャンセルされます。

このコマンドレットは、成功すると (MarkedForDeletion プロパティが True に設定された) オブジェクトを返します。失敗するとエラー メッセージを返します。

パラメーター

-Confirm [<SwitchParameter>]

コマンドレットの実行前に確認のプロンプトを表示します。

必須false
位置named
既定値False
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-Force [<SwitchParameter>]

ユーザーの確認を求めずにコマンドを強制実行します。

必須false
位置named
既定値False
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-JobGroup <Guid>

同じジョブ グループ識別子を含む最後のコマンドが実行される直前に、一連のコマンドを実行する一連のコマンドの識別子を指定します。

必須false
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-JobVariable <String>

ジョブの進行状況を追跡し、このパラメーターで指定された変数に格納する場合に指定します。

必須false
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-PROTipID <Guid>

このアクションにトリガーされるパフォーマンスとリソースの最適化のヒント (PRO ヒント) を指定します。このパラメーターは、PRO ヒントを監査することができます。

必須false
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-RunAsynchronously [<SwitchParameter>]

ジョブが非同期で実行、制御がすぐにコマンド シェルに戻されるかどうかを指定します。

必須false
位置named
既定値False
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-VirtualHardDisk <VirtualHardDisk>

仮想ハード ディスク オブジェクトを指定します。

必須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-SCVirtualHardDisk コマンドレットを用いて取得可能な VMM 仮想ハード ディスク オブジェクトが必要となります。

例 1 : ライブラリから仮想ハード ディスク オブジェクトを削除する

コマンド
$VHD = Get-SCVirtualHardDisk -VMMServer "VMMServer01.Contoso.com" | where { $_.Name -eq "VHD01.vhd" -and $_.LibraryServer.Name -eq "LibraryServer01.Contoso.com" }
Remove-SCVirtualHardDisk -VirtualHardDisk $VHD
コマンドの説明

最初のコマンドは、”LibraryServer01.Contoso.com” に格納された仮想ハード ディスク オブジェクト “VHD01.vhd” を取得し、返されたオブジェクトを $VHD 変数に格納します。

2 番目のコマンドは、$VHD に格納されている仮想ハード ディスク オブジェクトをライブラリから削除し、ライブラリ サーバー上のファイル システムから対応するファイルを削除します。

例 2 : 仮想マシンから仮想ハード ディスクを削除する

コマンド
Get-SCVMMServer -ComputerName "VMMServer01.Contoso.com"
$VHD = Get-SCVirtualMachine -Name "VM01" | Get-SCVirtualHardDisk | where { $_.Name -match "DataDisk" }
$VHD | Remove-SCVirtualHardDisk
コマンドの説明

最初のコマンドは、”VMMServer01.Contoso.com” に接続します。

2 番目のコマンドは、仮想マシン オブジェクト “VMMServer01.Contoso.com” を取得し、その名前に文字列 “DataDisk” を含む VM01 上のすべての仮想ハード ディスクを取得し、これらの仮想ハード ディスク オブジェクトを $VHD という配列に格納します。

3 番目のコマンドは、$VHD 配列に格納されている各仮想ハード ディスク オブジェクトを仮想マシンから削除し、対応する各ファイルをライブラリ サーバー上のファイル システムから削除します。

関連するリンク

  • Get-SCVirtualHardDisk
  • Get-SCVirtualMachine
  • Get-SCVMMServer
  • Move-SCVirtualHardDisk
  • Set-SCVirtualHardDisk

参考