CLI デプロイ用の JSON 構成ファイルを準備する場合、vCenter Server Appliance のデプロイのための入力データを提供するために、パラメータと値を設定する必要があります。

JSON デプロイ ファイルの構成パラメータのセクションとサブセクション

CLI アップグレード用の JSON 構成ファイルの構成パラメータは、セクションとサブセクションで構成されます。

表 1. JSON デプロイ ファイルの構成パラメータのセクションとサブセクション
セクション サブセクション 説明
new_vcsa - デプロイするアプライアンスについて記述します esxi

ESXi ホストにアプライアンスを直接デプロイする場合のみ使用します。

ターゲット ESXi ホストに関する構成パラメータが含まれます。

デプロイ時に vSAN または vLCM 対象管理クラスタのいずれを構成するかに基づき、構成パラメータに関する詳細について関連セクションを参照してください。
注: esxi サブセクションまたは vc サブセクションのいずれかに記述する必要があります。
vc

vCenter Server インスタンスのインベントリにアプライアンスをデプロイする場合のみ使用します。

ターゲット ESXi ホストまたは vCenter Server インベントリの DRS クラスタに関する構成パラメータを含みます。new_vcsa セクション、vc サブセクションの構成パラメータを参照してください。

注: 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 インストーラは、 ovftool_arguments サブセクションの構成パラメータを検証しません。OVF ツールが認識しない引数を設定した場合、デプロイが失敗する可能性があります。
ceip- VMware カスタマ エクスペリエンス改善プログラム (CEIP) への参加について記述します。 settings

VMware カスタマ エクスペリエンス改善プログラム (CEIP) に参加するかどうかを設定する ceip_enabled 構成パラメータのみが含まれます。ceip セクション、settings サブセクションの構成パラメータを参照してください。

注: true に設定されている場合は、CLI のデプロイ コマンドに --acknowledge-ceip 引数を付けて実行する必要があります。

CEIP の詳細については、『vCenter Server およびホストの管理』の「カスタマ エクスペリエンス改善プログラムの構成」セクションを参照してください。

重要:

パスワードなどの文字列値には、ASCII 文字のみを含めることができます。拡張 ASCII および非 ASCII 文字はサポートされません。

バックスラッシュ (\) または引用符 (") を含む値を設定するには、バックスラッシュ (\) でその文字をエスケープする必要があります。たとえば、"password":"my\"password" はパスワード my"password を設定します。同様に、"image":"G:\\vcsa\\VMware-vCenter-Server-Appliance-7.0.0.XXXX-YYYYYYY_OVF10.ova" はパス G:\vcsa\VMware-vCenter-Server-Appliance-7.0.0.XXXX-YYYYYYY_OVF10.ova を設定します。

ブール値には小文字のみを含めることができます。true または false である必要があります。たとえば、"ssh_enable":false です。

new_vcsa セクションの構成パラメータ

表 2. vSAN および vLCM 管理対象クラスタとともにデプロイする new_vcsa セクション、esxi サブセクションの構成パラメータ
名前 タイプ 説明
hostname 文字列 アプライアンスをデプロイするターゲット ESXi ホストの IP アドレスまたは完全修飾ドメイン名 (FQDN)。
username 文字列 root など、ターゲット ESXi ホストの 管理権限を持つユーザー名。
password 文字列 ターゲット ESXi ホストの管理権限を持つユーザーのパスワード。
deployment_network 文字列

アプライアンスを接続するネットワーク名。

注: ネットワークは、ターゲット ESXi ホストからアクセスできる必要があります。

ターゲット ESXi ホストが 1 つしかネットワークを持たない場合、無視されます。

datacenter 文字列 作成する特定のデータセンター。
cluster 文字列 vSAN または vLCM 管理対象クラスタの名前。
compression_only Boolean vSAN クラスタで圧縮を有効にするには、値を true に設定します。このパラメータが true に設定されている場合、 deduplication_and_compression パラメータを false に設定する必要があります。
deduplication_and_compression Boolean vSAN クラスタで圧縮と重複排除を有効にするには、値を true に設定します。このパラメータが true に設定されている場合、compression_only パラメータを false に設定する必要があります。
cache_disk キャッシュに使用するディスクの UUID または標準名のリスト。SSD のみを指定します。
capacity_disk ストレージに使用するディスクの UUID または標準名のリスト。SSD または HDD を指定します。
enable_vlcm Boolean vLCM 管理対象クラスタを作成するには、true に設定します。
datastore 文字列

アプライアンスの構成ファイルおよび仮想ディスクを格納するデータストアの名前。

注:

データストアは、ESXi ホストからアクセスできる必要があります。

シン ディスク モードを使用する場合、データストア サイズには最低 25 GB のスペースが必要です。

port 整数型

ターゲットの ESXi ホストの HTTPS リバース プロキシ ポート。

デフォルトのポートは 443 です。ターゲットの ESXi ホストがカスタムの HTTPS リバース プロキシ ポートを使用する場合のみ使用します。

表 3. vSAN または vLCM 管理対象クラスタなしでデプロイする new_vcsa セクション、esxi サブセクションの構成パラメータ
名前 タイプ 説明
hostname 文字列 アプライアンスをデプロイするターゲット ESXi ホストの IP アドレスまたは完全修飾ドメイン名 (FQDN)。
username 文字列 root など、ターゲット ESXi ホストの 管理権限を持つユーザー名。
password 文字列 ターゲット ESXi ホストの管理権限を持つユーザーのパスワード。
deployment_network 文字列

アプライアンスを接続するネットワーク名。

注: ネットワークは、ターゲット ESXi ホストからアクセスできる必要があります。

ターゲット ESXi ホストが 1 つしかネットワークを持たない場合、無視されます。

datastore 文字列

アプライアンスの構成ファイルおよび仮想ディスクを格納するデータストアの名前。

注:

データストアは、ESXi ホストからアクセスできる必要があります。

シン ディスク モードを使用する場合、データストア サイズには最低 25 GB のスペースが必要です。

port 整数型

ターゲットの ESXi ホストの HTTPS リバース プロキシ ポート。

デフォルトのポートは 443 です。ターゲットの ESXi ホストがカスタムの HTTPS リバース プロキシ ポートを使用する場合のみ使用します。

表 4. new_vcsa セクション、vc サブセクションの構成パラメータ
名前 タイプ 説明
hostname 文字列 アプライアンスをデプロイするターゲット vCenter Server インスタンスの IP アドレスまたは完全修飾ドメイン名 (FQDN)。
username 文字列 ターゲット vCenter Server インスタンスの vCenter Single Sign-On 管理者ユーザー名。例: administrator@vsphere.local。
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"]
注: 値は大文字と小文字を区別します。
datastore 文字列

アプライアンスの構成ファイルおよび仮想ディスクを格納するデータストアの名前。

注:

データストアは、ターゲットの ESXi ホストまたは DRS クラスタからアクセスできる必要があります。

データストアには、25 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"]
ターゲット ESXi ホストがクラスタの一部である場合、パスを文字列のカンマ区切りのリストとして指定します。次に例を示します。
["cluster_name", "esxi-host.domain.com"] 
				  
注: 値は大文字と小文字を区別します。
vm_folder 文字列 オプション。アプライアンスがデプロイされる仮想マシン フォルダの名前。
表 5. new_vcsa セクション、appliance サブセクションの構成パラメータ
名前 タイプ 説明
thin_disk_mode Boolean シン仮想ディスクを搭載するアプライアンスをデプロイするには、true に設定します。
deployment_option 文字列 アプライアンスのサイズ。
  • デフォルト ストレージ サイズの最大 10 ホストおよび 100 仮想マシンに対して、vCenter Server Appliance をデプロイする場合、tiny に設定します。

    2 個の CPU、12 GB のメモリ、315 GB のストレージが搭載されたアプライアンスをデプロイします。

  • 大ストレージ サイズの最大 10 ホストおよび 100 仮想マシンに対して、vCenter Server Appliance をデプロイする場合、tiny-lstorage に設定します。

    2 個の CPU、12 GB のメモリ、1,390 GB のストレージが搭載されたアプライアンスをデプロイします。

  • 特大ストレージ サイズの最大 10 ホストおよび 100 仮想マシンに対して、vCenter Server Appliance をデプロイする場合、tiny-xlstorage に設定します。

    2 個の CPU、12 GB のメモリ、3,145 GB のストレージが搭載されたアプライアンスをデプロイします。

  • デフォルト ストレージ サイズの最大 100 ホストおよび 1,000 仮想マシンに対して、vCenter Server Appliance をデプロイする場合、small に設定します。

    4 個の CPU、19 GB のメモリ、380 GB のストレージが搭載されたアプライアンスをデプロイします。

  • 大ストレージ サイズの最大 100 ホストおよび 1,000 仮想マシンに対して、vCenter Server Appliance をデプロイする場合、small-lstorage に設定します。

    4 個の CPU、19 GB のメモリ、1,435 GB のストレージが搭載されたアプライアンスをデプロイします。

  • 特大ストレージ サイズの最大 100 ホストおよび 1,000 仮想マシンに対して、vCenter Server Appliance をデプロイする場合、small-xlstorage に設定します。

    4 個の CPU、19 GB のメモリ、3,195 GB のストレージが搭載されたアプライアンスをデプロイします。

  • デフォルト ストレージ サイズの最大 400 ホストおよび 4,000 仮想マシンに対して、vCenter Server Appliance をデプロイする場合、medium に設定します。

    8 個の CPU、28 GB のメモリ、600 GB のストレージが搭載されたアプライアンスをデプロイします。

  • 大ストレージ サイズの最大 400 ホストおよび 4,000 仮想マシンに対して、vCenter Server Appliance をデプロイする場合、medium-lstorage に設定します。

    8 個の CPU、28 GB のメモリ、1,600 GB のストレージが搭載されたアプライアンスをデプロイします。

  • 特大ストレージ サイズの最大 400 ホストおよび 4,000 仮想マシンに対して、vCenter Server Appliance をデプロイする場合、medium-xlstorage に設定します。

    8 個の CPU、28 GB のメモリ、3,360 GB のストレージが搭載されたアプライアンスをデプロイします。

  • デフォルト ストレージ サイズの最大 1,000 ホストおよび 10,000 仮想マシンに対して、vCenter Server Appliance をデプロイする場合、large に設定します。

    16 個の CPU、37 GB のメモリ、965 GB のストレージが搭載されたアプライアンスをデプロイします。

  • 大ストレージ サイズの最大 1,000 ホストおよび 10,000 仮想マシンに対して、vCenter Server Appliance をデプロイする場合、large-lstorage に設定します。

    16 個の CPU、37 GB のメモリ、1,665 GB のストレージが搭載されたアプライアンスをデプロイします。

  • 特大ストレージ サイズの最大 1,000 ホストおよび 10,000 仮想マシンに対して、vCenter Server Appliance をデプロイする場合、large-xlstorage に設定します。

    16 個の CPU、37 GB のメモリ、3,425 GB のストレージが搭載されたアプライアンスをデプロイします。

  • デフォルト ストレージ サイズの最大 2,000 ホストおよび 35,000 仮想マシンに対して、vCenter Server Appliance をデプロイする場合、xlarge に設定します。

    24 個の CPU、56 GB のメモリ、1,705 GB のストレージが搭載されたアプライアンスをデプロイします。

  • 大ストレージ サイズの最大 2,000 ホストおよび 35,000 仮想マシンに対して、vCenter Server Appliance をデプロイする場合、xlarge-lstorage に設定します。

    24 個の CPU、56 GB のメモリ、1,805 GB のストレージが搭載されたアプライアンスをデプロイします。

  • 特大ストレージ サイズの最大 2,000 ホストおよび 35,000 仮想マシンに対して、vCenter Server Appliance をデプロイする場合、xlarge-xlstorage に設定します。

    24 個の CPU、56 GB のメモリ、3,565 GB のストレージが搭載されたアプライアンスをデプロイします。

image 文字列

オプション。vCenter Server Appliance のインストール パッケージへのローカル ファイル パスまたは URL。

デフォルトでは、インストーラは、vcsa フォルダの ISO ファイルに含まれるインストール パッケージを使用します。

name 文字列

アプライアンスの仮想マシン名。

パーセント記号 (%)、バックスラッシュ (\)、スラッシュ (/) 以外の ASCII 文字しか含めることはできません。また、80 文字未満である必要があります。

ovftool_path 文字列

オプション。OVF ツール実行ファイルへのローカル ファイル パス

デフォルトでは、インストーラは、vcsa/ovftool フォルダの ISO ファイルに含まれる OVF ツール インスタンスを使用します。

表 6. new_vcsa セクション、network サブセクションの構成パラメータ
名前 タイプ 説明
ip_family 文字列

アプライアンスのネットワークの IP アドレスのバージョン。

ipv4 または ipv6 に設定します。

mode 文字列 アプライアンスのネットワークの IP アドレスの割り当て。

static または dhcp に設定します。

ip 文字列

アプライアンスの IP アドレス。

固定割り当てを使用する場合、つまり、mode パラメータを static に設定する場合のみ必要となります。

ネットワークの IP アドレスのバージョン、つまり、ip.family パラメータの値に対応する IPv4 または IPv6 アドレスを設定する必要があります。

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"

mode パラメータを static に設定する場合は任意で使用します。mode を DHCP に設定する場合はサポートされません。

prefix 文字列

ネットワーク プリフィックス長。

mode パラメータを static に設定する場合のみ使用します。mode パラメータを dhcp に設定する場合は削除します。

ネットワーク プリフィックス長は、サブネット マスクに設定されているビット数です。たとえば、サブネット マスクが 255.255.255.0 である場合は、バイナリ バージョンのプリフィックス長は 24 ビットとなるため、ネットワーク プリフィックス長は 24 になります。

IPv4 バージョンの場合、値は、0 から 32 の間である必要があります。

IPv6 バージョンの場合、値は、0 から 128 の間である必要があります。

gateway 文字列

デフォルト ゲートウェイの IP アドレス。

IPv6 バージョンの場合、値を default にできます。

ports 文字列

オプション。直接 HTTP 接続で vCenter Server Appliance が使用するポート番号。デフォルトでは、ポート 80 がリクエストを HTTPS ポート 443 にリダイレクトします。vCenter Server の HTTP および HTTPS ポートはカスタマイズできます。カスタムの HTTP および HTTPS ポート番号を指定する場合、vCenter Server が使用中のポートや、HTTP および HTTPS のデフォルトのポートである 80、443 は使用しないでください。

カスタム ポートを指定するオプションは、HTTP ポートの場合は、"rhttpproxy.ext.port1":"port_number"、および HTTPS ポートの場合は、"rhttpproxy.ext.port2:"port_number" です。

次の例では、HTTP ポートおよび HTTPS ポートにポート 81 およびポート 444 を指定します。

ports: {"rhttpproxy.ext.port1":"81", "rhttpproxy.ext.port2":"444"}

vCenter Server で使用されるポートの詳細については、vCenter Server に必要なポートを参照してください。

system_name 文字列

プライマリ ネットワーク ID。

IP アドレスまたは FQDN。FQDN が望ましい。

デプロイ後に、このパラメータの値を変更することはできません。

FQDN およびドット付き 10 進数は、RFC 1123 ガイドラインに準拠する必要があります。

表 7. new_vcsa セクション、os サブセクションの構成パラメータ
名前 タイプ 説明
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

オプション。true に設定すると、VMware Tools 時刻同期を使用するアプライアンスをデプロイします。VMware Tools は、アプライアンスの時刻を ESXi ホストの時刻と同期します。

時刻同期に NTP サーバを設定した場合、つまり ntp.servers パラメータを設定した場合は、無視されます。

表 8. new_vcsa セクション、sso サブセクションの構成パラメータ
名前 タイプ 説明
password 文字列

vCenter Single Sign-On 管理者ユーザーのパスワード、administrator@your_domain_name

新しい vCenter Single Sign-On ドメインに最初のインスタンスとして vCenter Server Appliance をデプロイする場合は、vCenter Single Sign-On 管理者ユーザーのパスワードを設定する必要があります。

パスワードは 8~20 文字で入力し、1 つ以上の大文字、1 つ以上の小文字、1 つ以上の数字、および 1 つ以上の特殊文字(ドル記号 ($)、ハッシュ キー (#)、アット記号 (@)、ピリオド (.)、感嘆符 (!) など)が含まれている必要があります。すべての文字は、ASCII 文字である必要があります。

domain_name 文字列

vCenter Single Sign-On ドメイン名(vsphere.local など)。

新しい vCenter Single Sign-On ドメインに最初のインスタンスとして vCenter Server Appliance をデプロイする場合は、新しい vCenter Single Sign-On ドメインの名前を設定する必要があります。

replication_partner_hostname 文字列

パートナー vCenter Server のシステム名。

既存の vCenter Single Sign-On ドメインにレプリケーション パートナーをデプロイする場合のみ必要です。

sso_port 整数

パートナー vCenter Server の HTTPS リバース プロキシ ポート。

デフォルトのポートは 443 です。パートナーがカスタム HTTPS リバース プロキシ ポートを使用する場合のみ使用します。

ceip セクションの構成パラメータ

表 9. ceip セクション、settings サブセクションの構成パラメータ
名前 タイプ 説明
ceip_enabled Boolean このアプライアンスの CEIP に参加するには、true に設定します。