Remove-SCVMTemplate
VMM からテンプレート オブジェクトを削除します。
構文
Remove-SCVMTemplate
[-VMTemplate] <Template>
[-Force]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Remove-SCVMTemplate コマンドレットは、仮想マシン マネージャー (VMM) ライブラリからテンプレート オブジェクトを削除します。 テンプレート オブジェクトを削除しても、テンプレートに関連付けられている仮想ハード ディスクは削除されません。
テンプレートに関連付けることができるファイルの種類には、仮想ハード ディスク ファイル (Windows ベースの .vhd ファイル、Citrix XenServer ベースの .vhd ファイル、または VMware ベースの .vmdk ファイル)、仮想フロッピー ディスク ファイル (Windows ベースの .vfd ファイルまたは VMware ベースの .flp ファイル)、スクリプト ファイル (Windows PowerShell .ps1 スクリプト ファイル、Sysprep.inf ファイル、Unattend.xml ファイルなど) が含まれます。
このコマンドレットは、成功した場合にオブジェクトを返すか (MarkedForDeletion プロパティを TRUE に設定)、または失敗した場合にエラー メッセージを返します。
例
例 1: ライブラリから特定のテンプレートを削除する
PS C:\> $Template = Get-SCVMTemplate -VMMServer "VMMServer1.Contoso.com" | where { $_.Name -eq "Template01" }
PS C:\> Remove-SCVMTemplate -VMTemplate $Template
最初のコマンドは、VMMServer01 上のライブラリから Template01 という名前のテンプレート オブジェクトを取得し、そのオブジェクトを $Template 変数に格納します。
2 番目のコマンドは、$Templateに格納されているテンプレート オブジェクトをライブラリから削除します。
例 2: ライブラリからすべてのテンプレートを削除する
PS C:\> $Templates = Get-SCVMTemplate -VMMServer "VMMServer01.Contoso.com"
PS C:\> $Templates | Remove-SCVMTemplate -Confirm
最初のコマンドは、VMMServer01 からすべてのテンプレート オブジェクトを取得し、$Templatesという名前の配列にオブジェクトを格納します。
2 番目のコマンドは、$Templates内の各テンプレート オブジェクトを Remove-SCVMTemplate コマンドレットに渡します。これにより、各テンプレート オブジェクトが VMM ライブラリから削除されます。 Confirm パラメーターは、各テンプレートを削除するかどうかを確認するプロンプトを表示します。
パラメーター
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Force
ユーザーの確認を求めずにコマンドを強制的に実行します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-JobVariable
ジョブの進行状況を追跡し、このパラメーターによって指定された変数に格納することを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PROTipID
このアクションをトリガーしたパフォーマンスとリソースの最適化のヒント (PRO ヒント) の ID を指定します。 このパラメーターを使用すると、PRO のヒントを監査できます。
型: | Guid |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RunAsynchronously
コントロールがコマンド シェルにすぐに戻るように、ジョブが非同期的に実行されることを示します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-VMTemplate
仮想マシンの作成に使用する VMM テンプレート オブジェクトを指定します。
型: | Template |
Aliases: | Template |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
出力
SCVMTemplate
このコマンドレットは、SCVMTemplate オブジェクトを返します。
メモ
- Get-SCVMTemplate コマンドレットを使用して取得できる VMM テンプレート オブジェクトが必要です。