CLI デプロイ用の JSON 構成ファイルを準備する場合、vCenter Server Applianceまたは Platform Services Controller アプライアンスのデプロイのための入力データを提供するために、パラメータと値を設定する必要があります。
JSON デプロイ ファイルの構成パラメータのセクションとサブセクション
CLI アップグレード用の JSON 構成ファイルの構成パラメータは、セクションとサブセクションで構成されます。
セクション | サブセクション | 説明 |
---|---|---|
new.vcsa - デプロイするアプライアンスについて記述します。 |
esxi |
ESXiホストにアプライアンスを直接デプロイする場合のみ使用します。
ターゲット
ESXiホストに関する構成パラメータが含まれます。
new.vcsa セクション、esxi サブセクションの構成パラメータを参照してください。
注:
esxi サブセクションまたは
vc サブセクションのいずれかに記述する必要があります。
|
vc |
vCenter Serverインスタンスのインベントリにアプライアンスをデプロイする場合のみ使用します。 ターゲット ESXiホストまたはvCenter Server インベントリの DRS クラスタに関する構成パラメータを含みます。
注:
vc サブセクションまたは
esxi サブセクションのいずれかに記述する必要があります。
|
|
appliance |
アプライアンスに関する構成パラメータが含まれます。 new.vcsa セクション、appliance サブセクションの構成パラメータを参照してください。 |
|
network |
アプライアンスのネットワーク設定について記述する構成パラメータが含まれます。 new.vcsa セクション、network サブセクションの構成パラメータを参照してください。 |
|
os |
アプライアンスのオペレーティング システム設定について記述する構成パラメータが含まれます。 new.vcsa セクション、os サブセクションの構成パラメータを参照してください。 |
|
sso |
アプライアンスの vCenter Single Sign-On 設定について記述する構成パラメータが含まれます。 new.vcsa セクション、sso サブセクションの構成パラメータを参照してください。 |
|
ovftool.arguments |
インストーラが生成する OVF ツール コマンドに、任意の引数と値を追加するためのオプションのサブセクション。
重要:
vCenter Server Applianceインストーラは、
ovftool.arguments サブセクションの構成パラメータを検証しません。OVF ツールが認識しない引数を設定した場合、デプロイが失敗する可能性があります。
|
|
ceip - VMware カスタマ エクスペリエンス改善プログラム (CEIP) への参加について記述します。 |
settings |
VMware カスタマ エクスペリエンス改善プログラム (CEIP) に参加するかどうかを設定する Platform Services Controllerが組み込まれた vCenter Server Appliance または Platform Services Controller アプライアンスをデプロイする場合のみ必要です。
注:
true に設定されている場合は、CLI のデプロイ コマンドに
--acknowledge-ceip 引数を付けて実行する必要があります。
CEIP の詳細については、『vCenter Server およびホストの管理』の「カスタマ エクスペリエンス改善プログラムの構成」セクションを参照してください。 |
パスワードなどの文字列値には、ASCII 文字のみを含めることができます。拡張 ASCII および非 ASCII 文字はサポートされません。
バックスラッシュ (\) または引用符 (") を含む値を設定するには、バックスラッシュ (\) でその文字をエスケープする必要があります。たとえば、"password":"my\"password"
の場合、パスワードは my"password と設定され、"image":"G:\\vcsa\\VMware-vCenter-Server-Appliance-6.5.0.XXXX-YYYYYYY_OVF10.ova"
では、パス G:\vcsa\VMware-vCenter-Server-Appliance-6.5.0.XXXX-YYYYYYY_OVF10.ova が設定されます。
ブール値には小文字のみを含めることができます。値は true
またはfalse
のいずれかになります。たとえば、"ssh.enable":false
です。
new.vcsa
セクションの構成パラメータ
名前 | タイプ | 説明 |
---|---|---|
hostname |
文字列 | アプライアンスをデプロイするターゲット ESXiホストの IP アドレスまたは完全修飾ドメイン名 (FQDN)。 |
username |
文字列 | root など、ターゲット ESXiホストの 管理権限を持つユーザー名。 |
password |
文字列 | ターゲット ESXiホストの管理権限を持つユーザーのパスワード。 |
deployment.network |
文字列 | アプライアンスを接続するネットワーク名。
注: ネットワークは、ターゲット
ESXiホストからアクセスできる必要があります。
ターゲット ESXiホストが 1 つしかネットワークを持たない場合、無視されます。 |
datastore |
文字列 | アプライアンスの仮想マシンの構成ファイルおよび仮想ディスクのすべてを格納するデータストアの名前。
注:
データストアは、ESXiホストからアクセスできる必要があります。 データストアには、十分な空き容量が必要です。 |
port |
整数型 | ターゲットの ESXiホストの HTTPS リバース プロキシ ポート。 デフォルトのポートは 443 です。ターゲットの ESXiホストがカスタムの HTTPS リバース プロキシ ポートを使用する場合のみ使用します。 |
名前 | タイプ | 説明 |
---|---|---|
hostname |
文字列 | アプライアンスをデプロイするターゲット vCenter Serverインスタンスの IP アドレスまたは完全修飾ドメイン名 (FQDN)。 |
username |
文字列 | ターゲット vCenter Serverインスタンスの vCenter Single Sign-On 管理者ユーザー名。例: [email protected]。 |
password |
文字列 | ターゲットの vCenter Serverインスタンスの vCenter Single Sign-On 管理者ユーザーのパスワード。 |
deployment.network |
文字列 | アプライアンスを接続するネットワーク名。
注: ネットワークは、アプライアンスをデプロイするターゲットの
ESXiホストまたは DRS クラスタからアクセスできる必要があります。
ターゲットの ESXiホストまたは DRS クラスタが 1 つしかネットワークを持たない場合は、無視されます。 |
datacenter |
文字列または配列 | アプライアンスをデプロイするターゲットの ESXiホストまたは DRS クラスタを含む vCenter Server データセンター。
データセンターがフォルダまたはフォルダ構造の中に配置されている場合、値は複数の文字列をカンマ区切りで入力するか、カンマ区切りの複数の文字列を単一の文字列として入力します。次に例を示します。
["parent_folder", "child_folder", "datacenter_name"]または "parent_folder, child_folder, datacenter_name"
注: 値は大文字と小文字を区別します。
|
datastore |
文字列 | アプライアンスの仮想マシンの構成ファイルおよび仮想ディスクのすべてを格納するデータストアの名前。
注:
データストアは、ターゲットの ESXiホストまたは DRS クラスタからアクセスできる必要があります。 データストアには、15 GB 以上の空き容量が必要です。 |
port |
整数 | ターゲット vCenter Serverインスタンスの HTTPS リバース プロキシ ポート。 デフォルトのポートは 443 です。ターゲット vCenter Serverインスタンスがカスタム HTTPS リバース プロキシ ポートを使用する場合のみ使用します。 |
target |
文字列または配列 | アプライアンスをデプロイするターゲット ESXiホストまたは DRS クラスタ。
重要:
vCenter Serverインベントリに表示される名前を指定する必要があります。例えば、ターゲット
ESXiホストの名前が
vCenter Server インベントリ内の IP アドレスである場合、FQDN を指定することはできません。
ターゲット
ESXiホストまたは DRS クラスタがフォルダまたはフォルダ構造の中に配置される場合、値は文字列のカンマ区切りのリストであるか、単一の文字列としてのカンマ区切りのリストである必要があります。次に例を示します。
["parent_folder", "child_folder", "esxi-host.domain.com"]または "parent_folder, child_folder, esxi-host.domain.com"
ターゲット
ESXiホストがクラスタの一部である場合にパスを指定するには、文字列のカンマ区切りのリストか単一の文字列としてのカンマ区切りのリストを使用します。次に例を示します。
["cluster_name", "esxi-host.domain.com"]または "cluster_name, esxi-host.domain.com"
注: 値は大文字と小文字を区別します。
|
vm.folder |
文字列 | オプション。アプライアンスを追加する仮想マシン フォルダ名。 |
名前 | タイプ | 説明 |
---|---|---|
thin.disk.mode |
Boolean | シン仮想ディスクを搭載するアプライアンスをデプロイするには、true に設定します。 |
deployment.option |
文字列 | アプライアンスのサイズ。
|
image |
文字列 | オプション。vCenter Server Applianceインストール パッケージへのローカル ファイル パスまたは URL デフォルトでは、インストーラは、vcsa フォルダの ISO ファイルに含まれるインストール パッケージを使用します。 |
name |
文字列 | アプライアンスの仮想マシン名。 パーセント記号 (%)、バックスラッシュ (\)、スラッシュ (/) 以外の ASCII 文字しか含めることはできません。また、80 文字未満である必要があります。 |
ovftool.path |
文字列 | オプション。OVF ツール実行ファイルへのローカル ファイル パス デフォルトでは、インストーラは、vcsa/ovftool フォルダの ISO ファイルに含まれる OVF ツール インスタンスを使用します。 |
名前 | タイプ | 説明 |
---|---|---|
ip.family |
文字列 | アプライアンスのネットワークの IP アドレスのバージョン。 |
mode |
文字列 | アプライアンスのネットワークの IP アドレスの割り当て。
|
ip |
文字列 | アプライアンスの IP アドレス。 固定割り当てを使用する場合、つまり、 ネットワークの IP アドレスのバージョン、つまり、 IPv4 アドレスは、RFC 790 ガイドラインに準拠する必要があります。 IPv6 アドレスは、RFC 2373 ガイドラインに準拠する必要があります。 |
dns.servers |
文字列値または配列値 | 1 つ以上の DNS サーバの IP アドレス。
複数の DNS サーバを設定するには、文字列のカンマ区切りのリストか単一の文字列としてのカンマ区切りのリストを使用します。次に例を示します。
["x.y.z.a", "x.y.z.b"]または "x.y.z.a, x.y.z.b" 固定割り当てを使用する場合、つまり、 |
prefix |
文字列 | ネットワーク プリフィックス長。 ネットワーク プリフィックス長は、サブネット マスクに設定されているビット数です。たとえば、サブネット マスクが 255.255.255.0 である場合は、バイナリ バージョンのプリフィックス長は 24 ビットとなるため、ネットワーク プリフィックス長は 24 になります。 IPv4 バージョンの場合、値は、 IPv6 バージョンの場合、値は、 |
gateway |
文字列 | デフォルト ゲートウェイの IP アドレス。 IPv6 バージョンの場合、値を |
ports |
文字列 | (オプション)直接 HTTP 接続で vCenter Server Appliance が使用するポート番号。デフォルトでは、ポート 80 がリクエストを HTTPS ポート 443 にリダイレクトします。vCenter Server の HTTP および HTTPS ポートはカスタマイズできます。カスタムの HTTP および HTTPS ポート番号を指定する場合、vCenter Server が使用中のポートや、HTTP および HTTPS のデフォルトのポートである 80、443 は使用しないでください。 カスタム ポートを指定するオプションは、HTTP ポートの場合は、 次の例では、HTTP ポートおよび HTTPS ポートにポート 81 およびポート 444 を指定します。 ports: {"rhttpproxy.ext.port1":"81", "rhttpproxy.ext.port2":"444"} vCenter Server で使用されるポートの詳細については、vCenter Server および Platform Services Controller に必要なポートを参照してください。
注:
ports パラメータは、vSphere 6.5 Update 2 以降でサポートされます。
|
system.name |
文字列 | プライマリ ネットワーク ID。 IP アドレスまたは FQDN。FQDN が望ましい。 デプロイ後に、このパラメータの値を変更することはできません。 FQDN およびドット付き 10 進数は、RFC 1123 ガイドラインに準拠する必要があります。 |
名前 | タイプ | 説明 |
---|---|---|
password |
文字列 | アプライアンスのオペレーティング システムの root ユーザーのパスワード。 パスワードは 8~20 文字で入力し、1 つ以上の大文字、1 つ以上の小文字、1 つ以上の数字、および 1 つ以上の特殊文字(ドル記号 ($)、ハッシュ キー (#)、アット記号 (@)、ピリオド (.)、感嘆符 (!) など)が含まれている必要があります。すべての文字は、スペース以外の下位 ASCII 文字にする必要があります。 |
ntp.servers |
文字列値または配列値 | オプション。時刻同期に使用する 1 つ以上の NTP サーバのホスト名または IP アドレス。
複数の NTP サーバを設定するには、文字列のカンマ区切りのリストか単一の文字列としてのカンマ区切りのリストを使用します。次に例を示します。
["x.y.z.a", "x.y.z.b"]または "x.y.z.a, x.y.z.b" |
ssh.enable |
Boolean | アプライアンスへの SSH 管理者ログインを有効にするには、true に設定します。
注:
vCenter Server Applianceの高可用性には、アプライアンスへのリモート SSH アクセスが必要です。
|
time.tools-sync |
Boolean | オプション。 時刻同期に NTP サーバを設定した場合、つまり |
名前 | タイプ | 説明 |
---|---|---|
password |
文字列 | vCenter Single Sign-On 管理者ユーザーのパスワード、administrator@your_domain_name。
|
domain-name |
文字列 | vCenter Single Sign-On ドメイン名(vsphere.local など)。
|
first-instance |
Boolean | Platform Services Controllerアプライアンスをデプロイする場合のみ必要です。 デフォルト値は 既存の vCenter Single Sign-On ドメインに Platform Services Controllerアプライアンスを参加させる場合は、 参加しているPlatform Services Controllerインスタンスによって、インフラストラクチャ データがレプリケートされ、拡張リンク モードが有効になります。Platform Services Controllerサービスの管理方法については、Platform Services Controller の管理を参照してください。 |
platform.services.controller |
文字列 | 外部の Platform Services Controllerのシステム名。 外部の Platform Services Controllerを使用する vCenter Server Appliance をデプロイする場合のみ必要です。 |
replication-partner-hostname |
文字列 | パートナー Platform Services Controllerのシステム名。 既存の vCenter Single Sign-On ドメインにレプリケーション パートナーとして Platform Services Controllerアプライアンスをデプロイする場合のみ必要です。 |
sso.port |
整数 | パートナー Platform Services Controllerの HTTPS リバース プロキシ ポート。 デフォルトのポートは 443 です。パートナー Platform Services Controllerがカスタム HTTPS リバース プロキシ ポートを使用する場合のみ使用します。 |
site-name |
文字列 | vCenter Single Sign-On サイト名。 Platform Services Controllerが組み込まれた vCenter Server Appliance または Platform Services Controller アプライアンスをデプロイする場合のみ必要です。
注: 組み込みのリンク モードを設定する場合は、最初のインスタンスのサイト名として
Default-First-Site を使用します。
|
ceip
セクションの構成パラメータ
名前 | タイプ | 説明 |
---|---|---|
ceip.enabled |
Boolean | このアプライアンスの CEIP に参加するには、true に設定します。 |