Remove-SCVMTemplate

  • リファレンス
モジュール:
VirtualMachineManager

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 ファイル)、スクリプト ファイル (Sysprep.inf や Unattend.xml ファイルを含むスクリプト ファイルまたは応答ファイル スクリプトWindows PowerShell .ps1) があります。

このコマンドレットは、成功すると (プロパティ 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

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

ユーザーに確認せずに、直ちにコマンドを実行します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobVariable

ジョブの進行状況を追跡して、このパラメーターで示す名前の変数に保管するように指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PROTipID

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

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsynchronously

コントロールがコマンド シェルに直ちに戻るように、ジョブが非同期的に実行されることを示します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMTemplate

仮想マシンの作成に使用する VMM テンプレート オブジェクトを指定します。

Type:Template
Aliases:Template
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

出力

SCVMTemplate

このコマンドレットは 、SCVMTemplate オブジェクトを 返します。

メモ

  • Get-SCVMTemplate コマンドレットを使用して取得できる VMM テンプレート オブジェクトが必要です。