VMware.Image Builder コマンドレットは、Microsoft PowerShell cmdlet として実装され、PowerCLI に含まれます。VMware.Image Builder コマンドレットのユーザーは、すべての PowerCLI 機能を利用できます。

PowerShell に精通しているユーザーは、ほかの PowerShell コマンドレットと同じように VMware.Image Builder コマンドレットを使用することができます。PowerShell および PowerCLI に慣れていない場合は、次のヒントに従ってください。

コマンドレット、パラメータ、およびパラメータの値は、PowerCLI のシェルに入力できます。

  • Get-Help cmdlet_name を実行すると、任意のコマンドレットのヘルプを表示することができます。
  • PowerShell は大文字と小文字を区別しないことに注意してください。
  • コマンドレット名やパラメータ名には、タブ補完を使用します。
  • Format-List または Format-Table(短縮形式は fl または ft)を使用して、任意の変数およびコマンドレットの出力の形式を整えることができます。Get-Help Format-List を参照してください。
  • VIB やイメージ プロファイルの検索およびフィルタリングにワイルドカードを使用します。すべてのワイルドカードの式がサポートされています。

名前によるパラメータの指定

パラメータは多くの場合名前で渡すことができ、スペースや特殊文字を含むパラメータの値は二重引用符で囲むことができます。

Add-EsxSoftwarePackage -ImageProfile profile42 -SoftwarePackage "partner package 35"

オブジェクトによるパラメータの指定

スクリプト処理や自動化を実施する場合は、パラメータをオブジェクトとして渡すことができます。このテクニックは、複数のオブジェクトを返す cmdlet または単一のオブジェクトを返す cmdlet に使用できます。

  1. 複数のオブジェクトを返す cmdlet の出力を変数にバインドします。
    $profs = Get-EsxImageProfile
  2. そのオブジェクトを入力として必要とする cmdlet を実行する場合は、そのオブジェクトに位置 (0 から始まるリスト) でアクセスします。
    Add-EsxSoftwarePackage -ImageProfile $profs[4] -SoftwarePackage partner-pkg

この例では、指定されたソフトウェア パッケージが、Get-EsxImageProfile から返されるリストの 5 番目のイメージ プロファイルに追加されます。

vCenter Server のインストールとセットアップドキュメントのほとんどの例では、パラメータは名前で渡されます。PowerCLIコマンドレットを使用した vSphere ESXi Image Builder のワークフローには、パラメータをオブジェクトとして渡す例が含まれています。

VMware.ImageBuilder コマンドレットの概要

VMware PowerCLI の VMware.Image Builder コンポーネントは、ソフトウェア デポの VIB、イメージ プロファイル、およびその他のコンテンツを管理するためのコマンドレットを提供します。

vSphere 7.0 以降では、レガシーの通知やパッチとともに VIB をパッケージ化する新しい方法が導入され、ソフトウェア デポには基本イメージ、ベンダー アドオンとコンポーネント、および VIB とイメージ プロファイルが含まれています。VMware PowerCLI 12.0 以降には、ソフトウェア デポの新しいコンテンツと連携するコマンドレットが提供されています。

VMware.ImageBuilder には、次のコマンドレットが含まれています。
注: VMware.ImageBuilder コマンドレットを実行する場合は、コマンドレットを起動するときにコマンド ラインですべてのパラメータを指定します。対話モードでのパラメータの提供は推奨されません。
詳細な参照情報を確認するには、 PowerCLI プロンプトで Get-Help cmdlet_name を実行します。
表 1. ソフトウェア デポのレガシー コンテンツで使用される VMware.ImageBuilder コマンドレット
コマンドレット 説明
Add-EsxSoftwareDepot 指定された場所にあるソフトウェア デポまたは ZIP ファイルを現在の環境に追加します。デポからメタデータをダウンロードし、VIB の依存関係を分析します。
Remove-EsxSoftwareDepot 指定されたソフトウェア デポとの接続を解除します。
Get-EsxSoftwareDepot 現在の環境に存在するソフトウェア デポのリストを戻します。イメージ プロファイルと VIB を調べて管理する場合は、まず対応するソフトウェア デポを環境に追加する必要があります。
Get-EsxSoftwarePackage ソフトウェア パッケージ オブジェクト (VIB) のリストを返します。この cmdlet のオプションを使用して、結果をフィルタリングします。
Get-EsxImageProfile 現在追加されているすべてのデポから ImageProfile オブジェクトのアレイを返します。
New-EsxImageProfile 新しいイメージ プロファイルを作成します。多くの場合は、既存のプロファイルのクローンを作成して新しいプロファイルを作成することが推奨されます。PowerCLI コマンドレットを使用したイメージ プロファイルのクローン作成を参照してください。
Set-EsxImageProfile ローカルの ImageProfile オブジェクトを変更して、変更されたプロファイルで検証テストを実行します。この cmdlet は、変更されたオブジェクトを返しますが、維持はしません。
Export-EsxImageProfile イメージ プロファイルを、ESXi インストール用の ESXi ISO イメージまたは ZIP ファイルとしてエクスポートします。
Compare-EsxImageProfile 2 つのプロファイルの VIB リストと許容レベルが同じかどうかを示す、ImageProfileDiff の構造を返します。許容レベルの操作を参照してください。
Remove-EsxImageProfile ソフトウェア デポからイメージ プロファイルを削除します。
Add-EsxSoftwarePackage 既存のイメージ プロファイルに 1 つ以上の新しいパッケージ (VIB) を追加します。
Remove-EsxSoftwarePackage イメージ プロファイルから 1 つ以上のパッケージ (VIB) を削除します。
Set-ESXImageProfileAssociation 指定されたイメージ プロファイルを指定された ESXi システムに関連付けます。
表 2. ソフトウェア デポの新しいコンテンツで使用される VMware.ImageBuilder コマンドレット
コマンドレット 説明
Get-DepotAddons ソフトウェア デポのアドオンに関する基本情報を提供するオブジェクトの配列を取得します。
Get-DepotBaseImages ソフトウェア デポの基本イメージに関する基本情報を提供するオブジェクトの配列を取得します。
Get-DepotComponents ソフトウェア デポのコンポーネントに関する基本情報を提供するオブジェクトの配列を取得します。
Get-DepotInfo 指定したファイル パスまたは URL アドレスにあるソフトウェア デポに関する基本情報を取得します。
Get-DepotVibs ソフトウェア デポの VIB に関する基本情報を提供するオブジェクトの配列を取得します。
New-IsoImage 指定したファイル パスにある指定したソフトウェア デポとソフトウェア仕様を使用して ISO イメージを生成します。
New-PxeImage 指定したファイル パスにある指定したソフトウェア デポとソフトウェア仕様を使用して PXE イメージを生成します。