为 CLI 部署准备 JSON 配置文件时，您必须设置参数和值，提供部署 vCenter Server Appliance 或 Platform Services Controller 设备所需的输入数据。

JSON 部署文件中的配置参数的部分和子部分

用于 CLI 升级的 JSON 配置文件中的配置参数按部分和子部分进行组织。

表 1. JSON 部署文件中的配置参数的部分和子部分
部分 子部分 描述
new.vcsa - 描述要部署的设备 esxi

仅当要直接在 ESXi 主机上部署设备时才应使用。

包含描述目标 ESXi主机的配置参数。请参见 new.vcsa部分的 esxi 子部分中的配置参数。
注： 您必须填充 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 Tool 命令的可选子部分。
重要事项： vCenter Server Appliance 安装程序不会验证 ovftool.arguments 子部分中的配置参数。如果设置了 OVF Tool 无法识别的参数，部署可能会失败。
ceip- 描述是否加入 VMware 客户体验改善计划 (Customer Experience Improvement Program, CEIP) settings

仅包含 ceip.enabled 配置参数，用来设置是否加入 VMware 客户体验改善计划 (CEIP)。请参见 ceip部分的 settings 子部分中的配置参数。

仅当要部署具有嵌入式 Platform Services Controller部署的 vCenter Server Appliance 或 Platform Services Controller 设备时才需要。

注： 如果设置为 true，则必须使用 --acknowledge-ceip 参数运行 CLI 部署命令。

有关 CEIP 的信息，请参见vCenter Server 和主机管理中的“配置客户体验改善计划”一节。

重要事项：

String 值（包括密码）必须仅包含 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。

Boolean 值必须仅包含小写字符。可以是 true或false。例如，"ssh.enable":false。

new.vcsa 部分中的配置参数

表 2. new.vcsa部分的 esxi 子部分中的配置参数
名称 类型 描述
hostname string 要在上面部署设备的目标 ESXi主机的 IP 地址或 FQDN。
username string 对目标 ESXi主机具有管理特权的用户名，例如 root。
password string 对目标 ESXi主机具有管理特权的用户的密码。
deployment.network string

要将设备连接到的网络的名称。

注： 该网络必须可从目标 ESXi主机进行访问。

如果目标 ESXi主机仅具有一个网络，则忽略此参数。

datastore string

要将设备的所有虚拟机配置文件和虚拟磁盘存储到的数据存储的名称。

注：

该数据存储必须可从 ESXi 主机进行访问。

而且，必须具有足够的可用空间。

port integer

目标 ESXi 主机的 HTTPS 反向代理端口。

默认端口为 443。仅当目标 ESXi主机使用自定义 HTTPS 反向代理端口时才应使用。

表 3. new.vcsa部分的 vc 子部分中的配置参数
名称 类型 描述
hostname string 要在上面部署设备的目标 vCenter Server实例的 IP 地址或 FQDN。
username string 目标 vCenter Server实例上的 vCenter Single Sign-On 管理员用户名，例如 [email protected]。
password string 目标 vCenter Server实例上的 vCenter Single Sign-On 管理员用户的密码。
deployment.network string

要将设备连接到的网络的名称。

注： 必须可从要在其中部署设备的目标 ESXi主机或 DRS 群集访问该网络。

如果目标 ESXi主机或 DRS 群集只有一个网络，则忽略此参数。

datacenter string 或 array

包含要在其中部署设备的目标 ESXi 主机或 DRS 群集的 vCenter Server 数据中心。

如果数据中心位于文件夹或文件夹结构中，则值必须是逗号分隔的字符串列表或作为单个字符串的逗号分隔列表。例如， 
["parent_folder", "child_folder", "datacenter_name"]
或 
"parent_folder, child_folder, datacenter_name"
注： 值区分大小写。
datastore string

要将设备的所有虚拟机配置文件和虚拟磁盘存储到的数据存储的名称。

注：

该数据存储必须可从目标 ESXi 主机或 DRS 群集进行访问。

该数据存储必须具有至少 15 GB 的可用空间。

port integer

目标 vCenter Server 实例的 HTTPS 反向代理端口。

默认端口为 443。仅当目标 vCenter Server实例使用自定义 HTTPS 反向代理端口时才应使用。

target string 或 array

要在其中部署设备的目标 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 string 可选。要将设备添加到的虚拟机文件夹的名称。
表 4. new.vcsa部分的 appliance 子部分中的配置参数
名称 类型 描述
thin.disk.mode Boolean 设置为 true可部署具有精简虚拟磁盘的设备。
deployment.option string 设备的大小。
  • 如果要为最多 10 个主机和 100 个虚拟机（具有默认存储大小）部署具有嵌入式 Platform Services Controller的 vCenter Server Appliance，请设置为 tiny。

    部署具有 2 个 CPU、10 GB 内存和 250 GB 存储的设备。

  • 如果要为最多 10 个主机和 100 个虚拟机（具有大型存储大小）部署具有嵌入式 Platform Services Controller的 vCenter Server Appliance，请设置为 tiny-lstorage。

    部署具有 2 个 CPU、10 GB 内存和 775 GB 存储的设备。

  • 如果要为最多 10 个主机和 100 个虚拟机（具有超大型存储大小）部署具有嵌入式 Platform Services Controller的 vCenter Server Appliance，请设置为 tiny-xlstorage。

    部署具有 2 个 CPU、10 GB 内存和 1650 GB 存储的设备。

  • 如果要为最多 100 个主机和 1,000 个虚拟机（具有默认存储大小）部署具有嵌入式 Platform Services Controller的 vCenter Server Appliance，请设置为 small。

    部署具有 4 个 CPU、16 GB 内存和 290 GB 存储的设备。

  • 如果要为最多 100 个主机和 1,000 个虚拟机（具有大型存储大小）部署具有嵌入式 Platform Services Controller的 vCenter Server Appliance，请设置为 small-lstorage。

    部署具有 4 个 CPU、16 GB 内存和 820 GB 存储的设备。

  • 如果要为最多 100 个主机和 1,000 个虚拟机（具有超大型存储大小）部署具有嵌入式 Platform Services Controller的 vCenter Server Appliance，请设置为 small-xlstorage。

    部署具有 4 个 CPU、16 GB 内存和 1700 GB 存储的设备。

  • 如果要为最多 400 个主机和 4,000 个虚拟机（具有默认存储大小）部署具有嵌入式 Platform Services Controller的 vCenter Server Appliance，请设置为 medium。

    部署具有 8 个 CPU、24 GB 内存和 425 GB 存储的设备。

  • 如果要为最多 400 个主机和 4,000 个虚拟机（具有大型存储大小）部署具有嵌入式 Platform Services Controller的 vCenter Server Appliance，请设置为 medium-lstorage。

    部署具有 8 个 CPU、24 GB 内存和 925 GB 存储的设备。

  • 如果要为最多 400 个主机和 4,000 个虚拟机（具有超大型存储大小）部署具有嵌入式 Platform Services Controller的 vCenter Server Appliance，请设置为 medium-xlstorage。

    部署具有 8 个 CPU、24 GB 内存和 1805 GB 存储的设备。

  • 如果要为最多 1,000 个主机和 10,000 个虚拟机（具有默认存储大小）部署具有嵌入式 Platform Services Controller的 vCenter Server Appliance，请设置为 large。

    部署具有 16 个 CPU、32 GB 内存和 640 GB 存储的设备。

  • 如果要为最多 1,000 个主机和 10,000 个虚拟机（具有大型存储大小）部署具有嵌入式 Platform Services Controller的 vCenter Server Appliance，请设置为 large-lstorage。

    部署具有 16 个 CPU、32 GB 内存和 990 GB 存储的设备。

  • 如果要为最多 1,000 个主机和 10,000 个虚拟机（具有超大型存储大小）部署具有嵌入式 Platform Services Controller的 vCenter Server Appliance，请设置为 large-xlstorage。

    部署具有 16 个 CPU、32 GB 内存和 1870 GB 存储的设备。

  • 如果要为最多 2,000 个主机和 35,000 个虚拟机（具有默认存储大小）部署具有嵌入式 Platform Services Controller的 vCenter Server Appliance，请设置为 xlarge。

    部署具有 24 个 CPU、48 GB 内存和 980 GB 存储的设备。

  • 如果要为最多 2,000 个主机和 35,000 个虚拟机（具有大型存储大小）部署具有嵌入式 Platform Services Controller的 vCenter Server Appliance，请设置为 xlarge-lstorage。

    部署具有 24 个 CPU、48 GB 内存和 1030 GB 存储的设备。

  • 如果要为最多 2,000 个主机和 35,000 个虚拟机（具有超大型存储大小）部署具有嵌入式 Platform Services Controller的 vCenter Server Appliance，请设置为 xlarge-xlstorage。

    部署具有 24 个 CPU、48 GB 内存和 1910 GB 存储的设备。

  • 如果要为最多 10 个主机和 100 个虚拟机（具有默认存储大小）部署具有外部 Platform Services Controller部署的 vCenter Server Appliance，请设置为 management-tiny。

    部署具有 2 个 CPU、10 GB 内存和 250 GB 存储的设备。

  • 如果要为最多 10 个主机和 100 个虚拟机（具有大型存储大小）部署具有外部 Platform Services Controller部署的 vCenter Server Appliance，请设置为 management-tiny-lstorage。

    部署具有 2 个 CPU、10 GB 内存和 775 GB 存储的设备。

  • 如果要为最多 10 个主机和 100 个虚拟机（具有超大型存储大小）部署具有外部 Platform Services Controller部署的 vCenter Server Appliance，请设置为 management-tiny-xlstorage。

    部署具有 2 个 CPU、10 GB 内存和 1650 GB 存储的设备。

  • 如果要为最多 100 个主机和 1,000 个虚拟机（具有默认存储大小）部署具有外部 Platform Services Controller部署的 vCenter Server Appliance，请设置为 management-small。

    部署具有 4 个 CPU、16 GB 内存和 290 GB 存储的设备。

  • 如果要为最多 100 个主机和 1,000 个虚拟机（具有大型存储大小）部署具有外部 Platform Services Controller部署的 vCenter Server Appliance，请设置为 management-small-lstorage。

    部署具有 4 个 CPU、16 GB 内存和 820 GB 存储的设备。

  • 如果要为最多 100 个主机和 1,000 个虚拟机（具有超大型存储大小）部署具有外部 Platform Services Controller部署的 vCenter Server Appliance，请设置为 management-small-xlstorage。

    部署具有 4 个 CPU、16 GB 内存和 1700 GB 存储的设备。

  • 如果要为最多 400 个主机和 4,000 个虚拟机（具有默认存储大小）部署具有外部 Platform Services Controller部署的 vCenter Server Appliance，请设置为 management-medium。

    部署具有 8 个 CPU、24 GB 内存和 425 GB 存储的设备。

  • 如果要为最多 400 个主机和 4,000 个虚拟机（具有大型存储大小）部署具有外部 Platform Services Controller部署的 vCenter Server Appliance，请设置为 management-medium-lstorage。

    部署具有 8 个 CPU、24 GB 内存和 925 GB 存储的设备。

  • 如果要为最多 400 个主机和 4,000 个虚拟机（具有超大型存储大小）部署具有外部 Platform Services Controller部署的 vCenter Server Appliance，请设置为 management-medium-xlstorage。

    部署具有 8 个 CPU、24 GB 内存和 1805 GB 存储的设备。

  • 如果要为最多 1,000 个主机和 10,000 个虚拟机（具有默认存储大小）部署具有外部 Platform Services Controller部署的 vCenter Server Appliance，请设置为 management-large。

    部署具有 16 个 CPU、32 GB 内存和 640 GB 存储的设备。

  • 如果要为最多 1,000 个主机和 10,000 个虚拟机（具有大型存储大小）部署具有外部 Platform Services Controller部署的 vCenter Server Appliance，请设置为 management-large-lstorage。

    部署具有 16 个 CPU、32 GB 内存和 990 GB 存储的设备。

  • 如果要为最多 1,000 个主机和 10,000 个虚拟机（具有超大型存储大小）部署具有外部 Platform Services Controller部署的 vCenter Server Appliance，请设置为 management-large-xlstorage。

    部署具有 16 个 CPU、32 GB 内存和 1870 GB 存储的设备。

  • 如果要为最多 2,000 个主机和 35,000 个虚拟机（具有默认存储大小）部署具有外部 Platform Services Controller部署的 vCenter Server Appliance，请设置为 management-xlarge。

    部署具有 24 个 CPU、48 GB 内存和 980 GB 存储的设备。

  • 如果要为最多 2,000 个主机和 35,000 个虚拟机（具有大型存储大小）部署具有外部 Platform Services Controller部署的 vCenter Server Appliance，请设置为 management-xlarge-lstorage。

    部署具有 24 个 CPU、48 GB 内存和 1030 GB 存储的设备。

  • 如果要为最多 2,000 个主机和 35,000 个虚拟机（具有超大型存储大小）部署具有外部 Platform Services Controller部署的 vCenter Server Appliance，请设置为 management-xlarge-xlstorage。

    部署具有 24 个 CPU、48 GB 内存和 1910 GB 存储的设备。

  • 如果要部署 Platform Services Controller设备，请设置为 infrastructure。

    部署具有 2 个 CPU、4 GB 内存和 60 GB 存储的设备。

image string

可选。指向 vCenter Server Appliance 安装包的本地文件路径或 URL。

默认情况下，安装程序使用包含于 ISO 文件中的安装包，该文件位于 vcsa 文件夹中。

name string

设备的虚拟机名称。

必须仅包含除百分号 (%)、反斜杠 (\) 或正斜杠 (/) 以外的 ASCII 字符，并且长度不能超过 80 个字符。

ovftool.path string

可选。指向 OVF Tool 可执行文件的本地文件路径。

默认情况下，安装程序使用包含于 ISO 文件中的 OVF Tool 实例，该文件位于 vcsa/ovftool 文件夹中。

表 5. new.vcsa部分的 network 子部分中的配置参数
名称 类型 描述
ip.family string

设备的网络 IP 版本。

请设置为 ipv4或 ipv6。

mode string 设备的网络 IP 分配。

请设置为 static或 dhcp。

ip string

设备的 IP 地址。

仅当使用静态分配（也就是将 mode参数设置为 static）时才需要。

必须设置与网络 IP 版本对应的 IPv4 或 IPv6 地址，也就是设置为 ip.family参数的值。

IPv4 地址必须符合 RFC 790 准则。

IPv6 地址必须符合 RFC 2373 准则。

dns.servers string 或 array

一个或多个 DNS 服务器的 IP 地址。

要设置多个 DNS 服务器，请使用逗号分隔的字符串列表或作为单个字符串的逗号分隔列表来提供路径。例如， 
["x.y.z.a", "x.y.z.b"]
或 
"x.y.z.a, x.y.z.b"

仅当使用静态分配（也就是将 mode参数设置为 static）时才需要。

prefix string

网络前缀长度。

仅当 mode参数设置为static 时才应使用。当 mode参数设置为 dhcp 时移除。

网络前缀长度是在子网掩码中设置的位数。例如，如果子网掩码为 255.255.255.0，则二进制版本的前缀长度中有 24 位，因此网络前缀长度为 24。

对于 IPv4 版本，值必须介于 0到 32 之间。

对于 IPv6 版本，值必须介于 0到 128 之间。

gateway string

默认网关的 IP 地址。

对于 IPv6 版本，值可以是 default。

ports string

（可选）vCenter Server Appliance 用于直接 HTTP 连接的端口号。默认情况下，端口 80 会将请求重定向到 HTTPS 端口 443。您可以自定义 vCenter Server HTTP 端口和 HTTPS 端口。如果要指定自定义 HTTP 端口号和 HTTPS 端口号，请确保不使用已由 vCenter Server 使用的端口，或默认 HTTP 端口 (80) 和 HTTPS 端口 (443)。

用于指定自定义端口的选项为："rhttpproxy.ext.port1":"port_number"（用于 HTTP 端口）和 "rhttpproxy.ext.port2:"port_number"（用于 HTTPS 端口）。

以下示例将端口 81 和 444 分别指定为 HTTP 端口和 HTTPS 端口： 

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

有关 vCenter Server 使用的端口的详细信息，请参见 vCenter Server 和 Platform Services Controller 所需的端口。

注： 从 vSphere 6.5 Update 2 开始支持 ports 参数。
system.name string

主网络标识。

可以是 IP 地址或 FQDN，首选是 FQDN。

部署后将无法更改此参数的值。

FQDN 和用点分隔的十进制数字必须符合 RFC 1123 准则。

表 6. new.vcsa部分的 os 子部分中的配置参数
名称 类型 描述
password string

设备操作系统的 root 用户的密码。

该密码必须包含 8 到 20 个字符，至少一个大写字母、一个小写字母、一个数字和一个特殊字符，例如美元符号 ($)、井号 (#)、@ 符号 (@)、句点 (.) 或感叹号 (!)。所有字符必须是没有空格的小写 ASCII 字符。

ntp.servers string 或 array

可选。一个或多个要进行时间同步的 NTP 服务器的主机名或 IP 地址。

要设置多个 NTP 服务器，请使用逗号分隔的字符串列表或作为单个字符串的逗号分隔列表来提供路径。例如， 
["x.y.z.a", "x.y.z.b"]
或 
"x.y.z.a, x.y.z.b"
ssh.enable Boolean 设置为 true可在设备上启用 SSH 管理员登录。
注： vCenter Server Appliance 高可用性需要对设备的远程 SSH 访问。
time.tools-sync Boolean

可选。设置为 true 可使用 VMware Tools 时间同步部署设备。VMware Tools 会将设备的时间与 ESxi 主机的时间同步。

如果设置 NTP 服务器进行时间同步，也就是说，如果设置 ntp.servers 参数，则忽略此参数。

表 7. new.vcsa 部分的 sso 子部分中的配置参数
名称 类型 描述
password string vCenter Single Sign-On 管理员用户 administrator@your_domain_name 的密码。
  • 如果要将具有嵌入式 Platform Services Controller 部署的 vCenter Server Appliance 或 Platform Services Controller 设备部署为新 vCenter Single Sign-On 域中的第一个实例，必须设置 vCenter Single Sign-On 管理员用户的密码。

    该密码必须包含 8 到 20 个字符，至少一个大写字母、一个小写字母、一个数字和一个特殊字符，例如美元符号 ($)、井号 (#)、@ 符号 (@)、句点 (.) 或感叹号 (!)。所有字符必须是 ASCII 字符。

  • 如果要将 Platform Services Controller 设备部署为现有 vCenter Single Sign-On 域中的复制合作伙伴，必须提供合作伙伴 Platform Services Controller 的 vCenter Single Sign-On 管理员用户密码。
  • 如果要部署具有外部 Platform Services Controller 的 vCenter Server Appliance，必须提供外部 Platform Services Controller 的 vCenter Single Sign-On 管理员用户密码。
domain-name string vCenter Single Sign-On 域名，例如 vsphere.local。
  • 如果要将具有嵌入式 Platform Services Controller 部署的 vCenter Server Appliance 或 Platform Services Controller 设备部署为新 vCenter Single Sign-On 域中的第一个实例，必须设置新的 vCenter Single Sign-On 域名。
  • 如果要将具有外部 Platform Services Controller 的 vCenter Server Appliance 或 Platform Services Controller 设备部署为现有 vCenter Single Sign-On 域中的复制合作伙伴，必须提供现有的 vCenter Single Sign-On 域名。
first-instance Boolean

仅当部署 Platform Services Controller 设备时才需要。

默认值是 true。

如果要将 Platform Services Controller 设备加入现有的 vCenter Single Sign-On 域，则设置为 false。

加入的 Platform Services Controller 实例将复制其基础架构数据并启用增强型链接模式。有关管理 Platform Services Controller 服务的信息，请参见Platform Services Controller 管理。

platform.services.controller string

外部 Platform Services Controller 的系统名称。

仅当部署具有外部 Platform Services Controller 的 vCenter Server Appliance 时才需要。

replication-partner-hostname string

合作伙伴 Platform Services Controller 的系统名称。

仅当在现有的 vCenter Single Sign-On 域中将 Platform Services Controller 设备部署为复制合作伙伴时才需要。

sso.port integer

合作伙伴 Platform Services Controller 的 HTTPS 反向代理端口。

默认端口为 443。仅当合作伙伴 Platform Services Controller 使用自定义 HTTPS 反向代理端口时才应使用。

site-name string

vCenter Single Sign-On 站点名称。

仅当要部署具有嵌入式 Platform Services Controller 部署的 vCenter Server Appliance 或 Platform Services Controller 设备时才需要。

注： 设置嵌入式链接模式时，使用 Default-First-Site 作为第一个实例的站点名称。

ceip部分中的配置参数

表 8. ceip部分的 settings 子部分中的配置参数
名称 类型 描述
ceip.enabled Boolean 设置为 true可加入此设备的 CEIP。