为 CLI 部署准备 JSON 配置文件

运行 CLI 安装程序部署 vCenter Server Appliance 前，必须准备包含部署规范的配置参数及其值的 JSON 文件。

vCenter Server 安装程序包含所有部署选项的 JSON 模板。有关模板的信息，请参见vCenter Server Appliance 的 CLI 部署的 JSON 模板。

通过将值设置为适用于您的规范的 JSON 模板中的配置参数，您可以使用最少配置部署设备。可以编辑预设值、移除配置参数，并为自定义配置添加配置参数。

有关配置参数及其描述的完整列表，请导航到操作系统的安装程序子目录并运行 vcsa-deploy install --template-help 命令，或者参见部署配置参数。

前提条件

您必须熟悉 JSON 语法。
下载并挂载 vCenter Server 安装程序。

过程

在 vCenter Server 安装程序中，导航到 vcsa-cli-installer 目录，然后打开 templates 子文件夹。
将 install 子文件夹中的部署模板复制到工作区。

重要说明：指向 JSON 配置文件的路径必须仅包含 ASCII 字符。扩展 ASCII 字符和非 ASCII 字符不受支持。
在文本编辑器中打开适用于您的规范的模板文件。
为确保 JSON 配置文件的语法正确无误，请使用 JSON 编辑器。
为必需的配置参数填充值，也可以输入其他参数及其值。
例如，如果要对设备的网络使用 IPv4 DHCP 分配，请在模板的 network 子部分中将 mode 参数的值更改为 dhcp，并移除用于静态分配的默认配置参数。
```
        "network": {
            "ip_family": "ipv4",
            "mode": "dhcp"
        },
```
重要说明：
String 值（包括密码）必须仅包含 ASCII 字符。扩展 ASCII 字符和非 ASCII 字符不受支持。

要设置包含反斜杠 (\) 或引号 (") 字符的值，必须在该字符之前附加反斜杠 (\) 字符。例如，"password":"my\"password" 可设置密码 my"password，"image":"G:\\vcsa\\VMware-vCenter-Server-Appliance-8.0.0.XXXX-YYYYYYY_OVF10.ova" 可设置路径 G:\vcsa\VMware-vCenter-Server-Appliance-8.0.0.XXXX-YYYYYYY_OVF10.ova。

Boolean 值必须仅包含小写字符，也就是说，值可以是 true 或 false。例如，"ssh_enable":false。
（可选） 使用所选 JSON 编辑器验证 JSON 文件。
以 UTF-8 格式保存并关闭文件。

下一步做什么

您可以根据部署规范的需要创建并保存其他模板。

vCenter Server Appliance 的 CLI 部署的 JSON 模板

vCenter Server 安装程序包含 JSON 模板，这些模板具有所有部署选项的最低配置参数。这些模板位于 vcsa-cli-installer/templates/install 目录中。

每个部署选项都有一个模板用于在 ESXi 主机上部署设备，还有一个模板用于在 vCenter Server 实例上部署设备。

表 1. vCenter Server 安装程序中包含的部署 JSON 模板
模板	描述
embedded_vCSA_on_ESXi.json	包含在 ESXi 主机上部署 vCenter Server Appliance 所需的最低配置参数。
vCSA_with_cluster_on_ESXi.json	包含在 ESXi 主机上部署 vCenter Server Appliance 以及单节点 vSAN 和 vLCM 管理的集群所需的最低配置参数。
embedded_vCSA_on_VC.json	包含在 vCenter Server 实例上部署 vCenter Server Appliance 所需的最低配置参数。
embedded_vCSA_replication_on_ESXi.json	包含在 ESXi 主机上部署作为另一个嵌入式 vCenter Server 的复制合作伙伴的 vCenter Server Appliance 所需的最低配置参数。
embedded_vCSA_replication_on_VC.json	包含在 vCenter Server 实例上部署另一个 vCenter Server Appliance 的 vCenter Server Appliance 复制合作伙伴所需的最低配置参数。

部署配置参数

为 CLI 部署准备 JSON 配置文件时，必须设置参数和值，以便为 vCenter Server Appliance 部署提供输入数据。

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

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

表 2. JSON 部署文件中的配置参数的部分和子部分
部分	子部分	描述
`new_vcsa` - 描述要部署的设备	`esxi`	仅当要直接在 ESXi 主机上部署设备时才应使用。包含描述目标 ESXi 主机的配置参数。根据是否希望在部署过程中配置 vSAN 或 vLCM 管理的集群，请参见相关部分，了解有关配置参数的详细信息。带有 vSAN 和 vLCM 管理的集群的部署的 `new_vcsa` 部分的 `esxi` 子部分中的配置参数不带 vSAN 或 vLCM 管理的集群的部署的 `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 安装程序不会验证 `ovftool_arguments` 子部分中的配置参数。如果设置了 OVF Tool 无法识别的参数，部署可能会失败。
`ceip`- 描述是否加入 VMware 客户体验提升计划 (Customer Experience Improvement Program, CEIP)	`settings`	仅包含 `ceip_enabled` 配置参数，用来设置是否加入 VMware 客户体验提升计划 (CEIP)。请参见`ceip` 部分的 `settings` 子部分中的配置参数。注：如果设置为 `true`，则必须使用 --acknowledge-ceip 参数运行 CLI 部署命令。有关 CEIP 的信息，请参见《vCenter Server 和主机管理》中的“配置客户体验提升计划”一节。

重要说明：

String 值（包括密码）必须仅包含 ASCII 字符。扩展 ASCII 字符和非 ASCII 字符不受支持。

要设置包含反斜杠 (\) 或引号 (") 字符的值，必须在该字符之前附加反斜杠 (\) 字符。例如，"password":"my\"password" 可设置密码 my"password。同样，"image":"G:\\vcsa\\VMware-vCenter-Server-Appliance-8.0.0.XXXX-YYYYYYY_OVF10.ova" 可设置路径 G:\vcsa\VMware-vCenter-Server-Appliance-8.0.0.XXXX-YYYYYYY_OVF10.ova。

Boolean 值必须仅包含小写字符。其必须为 true 或 false。例如，"ssh_enable":false。

`new_vcsa` 部分中的配置参数

表 3. 带有 vSAN 和 vLCM 管理的集群的部署的 `new_vcsa` 部分的 `esxi` 子部分中的配置参数
名称	类型	描述
`hostname`	string	要在上面部署设备的目标 ESXi 主机的 IP 地址或 FQDN。
`username`	string	对目标 ESXi 主机具有管理特权的用户名，例如 root。
`password`	string	对目标 ESXi 主机具有管理特权的用户的密码。
`deployment_network`	string	要将设备连接到的网络的名称。注：该网络必须可从目标 ESXi 主机进行访问。如果目标 ESXi 主机仅具有一个网络，则忽略此参数。
`datacenter`	string	要创建的特定数据中心。
`cluster`	string	vSAN 或 vLCM 管理的集群的名称。
`compression_only`	布尔	将此值设置为 `true` 可在 vSAN 集群上启用压缩。如果此参数设置为 `true`，则 `deduplication_and_compression` 参数必须设置为 `false`。
`deduplication_and_compression`	布尔	将此值设置为 `true` 可在 vSAN 集群上启用压缩和去重。如果此参数设置为 `true`，则 `compression_only` 参数必须设置为 `false`。
`cache_disk`		要用于缓存的磁盘的 UUID 或规范名称的列表。仅指定 SSD。
`capacity_disk`		要用于存储的磁盘的 UUID 或规范名称的列表。指定 SSD 或 HDD。
`enable_vlcm`	布尔	设置为 `true` 可创建 vLCM 管理的集群。
`enable_vsan_esa`	布尔	设置为 `true` 以创建启用了 vSAN ESA 的 vSAN 集群。vSAN Express Storage Architecture 是下一代架构，旨在充分利用高性能存储设备，从而提高性能和效率。
`single_tier`	数组	要添加到 vSAN 存储池的磁盘的 UUID 或规范名称列表。仅当将 `enable_vsan_esa` 设置为 `true` 时才需要。
`vsan_hcl_database_path`	String	本地 vSAN HCL 数据库路径。如果位于此位置的 vSAN HCL 数据库过期，安装程序将下载最新版本并用其替换旧版本。仅当将 `enable_vsan_esa` 设置为 `true` 时才需要。
`datastore`	string	要在其中存储设备的配置文件和虚拟磁盘的数据存储的名称。注：该数据存储必须可从 ESXi 主机进行访问。如果使用的是精简磁盘模式，则数据存储大小至少应为 25 GB。
`port`	integer	目标 ESXi 主机的 HTTPS 反向代理端口。默认端口为 443。仅当目标 ESXi 主机使用自定义 HTTPS 反向代理端口时才应使用。

表 4. 不带 vSAN 或 vLCM 管理的集群的部署的 `new_vcsa` 部分的 `esxi` 子部分中的配置参数
名称	类型	描述
`hostname`	string	要在上面部署设备的目标 ESXi 主机的 IP 地址或 FQDN。
`username`	string	对目标 ESXi 主机具有管理特权的用户名，例如 root。
`password`	string	对目标 ESXi 主机具有管理特权的用户的密码。
`deployment_network`	string	要将设备连接到的网络的名称。注：该网络必须可从目标 ESXi 主机进行访问。如果目标 ESXi 主机仅具有一个网络，则忽略此参数。
`datastore`	string	要在其中存储设备的配置文件和虚拟磁盘的数据存储的名称。注：该数据存储必须可从 ESXi 主机进行访问。如果使用的是精简磁盘模式，则数据存储大小至少应为 25 GB。
`port`	integer	目标 ESXi 主机的 HTTPS 反向代理端口。默认端口为 443。仅当目标 ESXi 主机使用自定义 HTTPS 反向代理端口时才应使用。

表 5. `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`	array	包含要在其中部署设备的目标 ESXi 主机或 DRS 集群的 vCenter Server 数据中心。如果数据中心位于文件夹或文件夹结构中，则将值指定为逗号分隔的字符串列表。例如， ["parent_folder", "child_folder", "datacenter_name"] 注：值区分大小写。
`datastore`	string	要在其中存储设备的配置文件和虚拟磁盘的数据存储的名称。注：该数据存储必须可从目标 ESXi 主机或 DRS 集群进行访问。该数据存储必须具有至少 25 GB 的可用空间。
`port`	integer	目标 vCenter Server 实例的 HTTPS 反向代理端口。默认端口为 443。仅当目标 vCenter Server 实例使用自定义 HTTPS 反向代理端口时才应使用。
`target`	array	要在其中部署设备的目标 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`	string	可选。部署设备的虚拟机文件夹的名称。

表 6. `new_vcsa` 部分的 `appliance` 子部分中的配置参数
名称	类型	描述
`thin_disk_mode`	Boolean	设置为 `true` 可部署具有精简虚拟磁盘的设备。
`deployment_option`	string	设备的大小。如果要为具有默认存储大小的最多 10 个主机和 100 个虚拟机部署 vCenter Server Appliance，请设置为 `tiny`。部署具有 2 个 CPU、12 GB 内存和 315 GB 存储的设备。如果要为具有大型存储大小的最多 10 个主机和 100 个虚拟机部署 vCenter Server Appliance，请设置为 `tiny-lstorage`。部署具有 2 个 CPU、12 GB 内存和 1390 GB 存储的设备。如果要为具有超大型存储大小的最多 10 个主机和 100 个虚拟机部署 vCenter Server Appliance，请设置为 `tiny-xlstorage`。部署具有 2 个 CPU、12 GB 内存和 3145 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 内存和 1435 GB 存储的设备。如果要为具有超大型存储大小的最多 100 个主机和 1,000 个虚拟机部署 vCenter Server Appliance，请设置为 `small-xlstorage`。部署具有 4 个 CPU、19 GB 内存和 3195 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 内存和 1600 GB 存储的设备。如果要为具有超大型存储大小的最多 400 个主机和 4,000 个虚拟机部署 vCenter Server Appliance，请设置为 `medium-xlstorage`。部署具有 8 个 CPU、28 GB 内存和 3360 GB 存储的设备。如果要为具有默认存储大小的最多 1,000 个主机和 10,000 个虚拟机部署 vCenter Server Appliance，请设置为 `large`。部署具有 16 个 CPU、37 GB 内存和 965 GB 存储的设备。如果要为最多 1,000 个主机和 10,000 个虚拟机（具有大型存储大小）部署 vCenter Server，则设置为 `large-lstorage`。部署具有 16 个 CPU、37 GB 内存和 1665 GB 存储的设备。如果要为具有超大型存储大小的最多 1,000 个主机和 10,000 个虚拟机部署 vCenter Server Appliance，请设置为 `large-xlstorage`。部署具有 16 个 CPU、37 GB 内存和 3425 GB 存储的设备。如果要为具有默认存储大小的最多 2,000 个主机和 35,000 个虚拟机部署 vCenter Server Appliance，请设置为 `xlarge`。部署具有 24 个 CPU、56 GB 内存和 1705 GB 存储的设备。如果要为具有大型存储大小的最多 2,000 个主机和 35,000 个虚拟机部署 vCenter Server Appliance，请设置为 `xlarge-lstorage`。部署具有 24 个 CPU、56 GB 内存和 1805 GB 存储的设备。如果要为具有超大型存储大小的最多 2,000 个主机和 35,000 个虚拟机部署 vCenter Server Appliance，请设置为 `xlarge-xlstorage`。部署具有 24 个 CPU、56 GB 内存和 3565 GB 存储的设备。
`image`	string	可选。vCenter Server Appliance 安装软件包的本地文件路径或 URL。默认情况下，安装程序使用包含于 ISO 文件中的安装包，该文件位于 vcsa 文件夹中。
`name`	string	设备的虚拟机名称。必须仅包含除百分号 (%)、反斜杠 (\) 或正斜杠 (/) 以外的 ASCII 字符，并且长度不能超过 80 个字符。
`ovftool_path`	string	可选。指向 OVF Tool 可执行文件的本地文件路径。默认情况下，安装程序使用包含于 ISO 文件中的 OVF Tool 实例，该文件位于 vcsa/ovftool 文件夹中。

表 7. `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` 时为可选。当 mode 设置为 `DHCP` 时不受支持。
`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 的所需端口。
`system_name`	string	主网络标识。可以是 IP 地址或 FQDN，首选是 FQDN。部署后将无法更改此参数的值。 FQDN 和用点分隔的十进制数字必须符合 RFC 1123 准则。

表 8. `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` 参数，则忽略此参数。

表 9. `new_vcsa` 部分的 `sso` 子部分中的配置参数
名称	类型	描述
`password`	string	vCenter Single Sign-On 管理员用户 administrator@`your_domain_name` 的密码。如果要将 vCenter Server Appliance 部署为新 vCenter Single Sign-On 域中的第一个实例，则必须为 vCenter Single Sign-On 管理员用户设置密码。该密码必须包含 8 到 20 个字符，至少一个大写字母、一个小写字母、一个数字和一个特殊字符，例如美元符号 ($)、井号 (#)、@ 符号 (@)、句点 (.) 或感叹号 (!)。所有字符必须是 ASCII 字符。
`domain_name`	string	vCenter Single Sign-On 域名，例如 vsphere.local。如果要将 vCenter Server Appliance 部署为新 vCenter Single Sign-On 域中的第一个实例，则必须为新 vCenter Single Sign-On 域设置名称。
`replication_partner_hostname`	string	合作伙伴 vCenter Server 的系统名称。仅当在现有的 vCenter Single Sign-On 域中部署复制合作伙伴时才需要。
`sso_port`	integer	合作伙伴 vCenter Server 的 HTTPS 反向代理端口。默认端口为 443。仅当合作伙伴使用自定义 HTTPS 反向代理端口时才使用。

`ceip` 部分中的配置参数

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