vCenter Server Appliance 的 CLI 升级的升级配置参数

为 CLI 升级准备 JSON 配置文件时，您必须设置参数和值，提供升级 vCenter Server Appliance 所需的输入数据。

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

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

表 1. JSON 升级文件中的配置参数的部分和子部分

部分	子部分	描述
new_vcsa- 描述要部署的新设备。	esxi	仅当要直接在 ESXi 主机上部署新设备时才应使用。 包含描述目标 ESXi 主机的配置参数。请参见 new_vcsa 部分的 esxi 子部分中的配置参数。 注： 您必须填充此子部分或 vc 子部分。
	vc	仅当要在 vCenter Server 实例清单上部署新设备时才应使用。 包含描述目标 ESXi 主机或 vCenter Server 清单的 DRS 集群的配置参数。请参见new_vcsa 部分的 vc 子部分中的配置参数。 注： 您必须填充此子部分或 esxi 子部分。 目标 vCenter Server 实例不能是要升级的 vCenter Server Appliance。在这种情况下，请使用 esxi 子部分。
	appliance	包含描述新设备的配置参数。请参见new_vcsa 部分的 appliance 子部分中的配置参数
	os	仅包含 ssh_enable 配置参数，用来在新设备上设置 SSH 管理员登录。
	ovftool_arguments	可选。使用此子部分可以将任意参数及其值添加到安装程序所生成的 OVF Tool 命令。 重要说明： vCenter Server Appliance 安装程序不验证 ovftool_arguments 子部分中的配置参数。如果设置了 OVF Tool 无法识别的参数，部署可能会失败。
	temporary_network	包含描述新设备的临时网络设置的配置参数。请参见new_vcsa 部分的 temporary_network 子部分中的配置参数
	user_options	仅包含 vcdb_migrateSet 配置参数，用来设置要从旧设备传输到新设备的数据类型。请参见new_vcsa 部分的 user_options 子部分中的配置参数
source_vc- 描述要升级的现有设备。	managing_esxi_or_vc	包含配置参数，用于描述要升级的设备驻留在的源 ESXi 主机或 vCenter Server Appliance 实例。请参见 source_vc 部分的 managing_esxi_or_vc 子部分中的配置参数。
	vc_vcsa	包含描述要升级的源设备的配置参数。请参见 source_vc 部分的 vc_vcsa 子部分中的配置参数。
source_vum- 描述源 VMware Update Manager 实例。 要在 VMware Update Manager 实例上自动运行 Migration Assistant 时应使用。	run_migration_assistant	如果要升级的源 vCenter Server Appliance 已连接到在 Windows 虚拟机上运行的 VMware Update Manager 实例，则是可选的。仅当要在源 VMware Update Manager 实例上自动运行 Migration Assistant 时才应使用此子部分。 包含描述将迁移到新的已升级 vCenter Server Appliance 的源 VMware Update Manager 实例的配置参数。请参见source_vum 部分的 run_migration_assistant 子部分中的配置参数。 注： 默认情况下， Migration Assistant 使用端口 9123。如果端口 9123 已由 Update Manager 计算机上的其他服务使用， Migration Assistant 将自动查找其他可用端口。无法为 Migration Assistant 设置自定义端口。
ceip- 描述是否加入 VMware 客户体验提升计划 (CEIP)。	settings	仅包含 ceip_enabled 配置参数，用来设置是否加入 VMware 客户体验提升计划 (CEIP)。请参见ceip 部分的 settings 子部分中的配置参数。 仅当要升级具有嵌入式 Platform Services Controller 部署或 Platform Services Controller 设备的 vCenter Server Appliance 时才需要。 注： 如果 ceip_enabled 配置参数设置为 true，则必须使用 --acknowledge-ceip 参数运行 CLI 部署命令。 有关 CEIP 的信息，请参见《vCenter Server 和主机管理》中的“配置客户体验提升计划”一节。

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

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 主机或 vCenter Server Appliance 实例（如 managing_esxi_or_vc 配置参数所标识）网络配置的一部分。 注： 必须可从要升级的设备所在的源 ESXi 主机或 vCenter Server Appliance 实例（如 managing_esxi_or_vc 配置参数所标识）访问该网络。该网络必须还可以从执行升级的客户机访问。 如果目标 ESXi 主机仅具有一个网络，则忽略此参数。
datastore	string	要将新设备的虚拟机配置文件和虚拟磁盘存储到的数据存储的名称。 该数据存储必须对目标 ESXi 主机可用。 注： 该数据存储必须具有至少 25 GB 的可用空间。
port	integer	目标 ESXi 主机的 HTTPS 反向代理端口。 默认端口为 443。仅当目标 ESXi 主机使用自定义 HTTPS 反向代理端口时才应使用。
ssl_certificate_verification	string	CLI 将验证服务器的安全证书是否由证书颁发机构 (Certificate Authority, CA) 签名，并建立安全连接。如果证书是自签名证书，则 CLI 会停止升级，除非您指定以下 SSL 证书配置选项之一： 指定安全哈希算法 1 (Secure Hash Algorithm 1, SHA-1) 证书指纹。证书指纹是一个十六进制字符串，用于唯一地标识证书。指纹使用指纹算法根据证书的内容计算而得。 "thumbprint": "certificate SHA-1 thumbprint" 将 verification_mode 设置为 NONE。 "verification_mode": "NONE" 如果您使用自签名证书连接到服务器，并且未指定 SHA-1 证书指纹或者未将验证模式设置为 NONE，则 CLI 会显示服务器的自签名证书指纹并提示您接受或拒绝该证书指纹。 您还可以使用 vcsa-deploy upgrade 命令参数 --no-ssl-certificate-validation 指定让 CLI 忽略自签名证书。请参见CLI 升级命令的语法。

表 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 主机访问该网络。该网络必须还可以从执行升级的客户机访问。 如果目标 ESXi 主机或 DRS 集群只有一个网络，则忽略此参数。
datacenter	array	包含要在其上部署新设备的目标 ESXi 主机或 DRS 集群的 vCenter Server 数据中心。 如果数据中心位于文件夹或文件夹结构中，请将值指定为逗号分隔的字符串列表。例如， ["parent_folder", "child_folder", "datacenter_name"] 如果数据中心上没有任何文件夹路径，则仅使用数据中心名称。例如， ["datacenter_name"] 或 "datacenter_name" 注： 值区分大小写。
datastore	string	要将新设备的所有虚拟机配置文件和虚拟磁盘存储到的数据存储的名称。 注： 该数据存储必须对目标 ESXi 主机或 DRS 集群可用。 该数据存储必须具有至少 25 GB 的可用空间。
port	integer	目标 vCenter Server 实例的 HTTPS 反向代理端口。 默认端口为 443。仅当目标 vCenter Server 实例使用自定义 HTTPS 反向代理端口时才应使用。
target	array	要在其中部署新设备的目标集群、ESXi 主机或资源池。这是您使用 datacenter 参数指定的目标。该路径必须以集群名称、ESXi 主机名或资源池名称结尾。 重要说明： 必须提供 vCenter Server 清单中显示的名称。例如，如果目标 ESXi 主机的名称是 vCenter Server 清单中的一个 IP 地址，则不能提供 FQDN。 注： 所有值均区分大小写。 如果要在数据中心层次结构中的不同位置列出已部署的设备，请使用本部分稍后描述的 vm_folder 参数。 如果目标集群、 ESXi 主机或资源池位于文件夹或文件夹结构中，请将值指定为逗号分隔的字符串列表。例如， ["parent_folder", "child_folder", "esxi-host.domain.com"] 如果目标 ESXi 主机是集群的一部分，请将路径指定为逗号分隔的字符串列表。例如， ["cluster_name","esxi-host.domain.com"] 如果要部署到资源池，请在资源池名称前面添加 Resources。例如： ["cluster_name", "Resources", "resource_pool_name"] 注： 预检查只会验证资源池的内存。
vm_folder	string	可选。要将新设备添加到的虚拟机 (VM) 文件夹的名称。

表 4. new_vcsa 部分的 appliance 子部分中的配置参数

名称	类型	描述
thin_disk_mode	Boolean	设置为 true 可部署具有精简虚拟磁盘的新设备。
deployment_option	string	新设备的大小。 注： 必须考虑要升级的设备的数据库大小。有关外部数据库，请参见 确定新设备的 Oracle 数据库大小和存储大小。 如果要为具有默认存储大小的最多 10 个主机和 100 个虚拟机部署 vCenter Server Appliance，请设置为 tiny。 部署具有 2 个 CPU、10 GB 内存和 300 GB 存储的设备。 如果要为具有大型存储大小的最多 10 个主机和 100 个虚拟机部署 vCenter Server Appliance，请设置为 tiny-lstorage。 部署具有 2 个 CPU、10 GB 内存和 825 GB 存储的设备。 如果要为具有超大型存储大小的最多 10 个主机和 100 个虚拟机部署 vCenter Server Appliance，请设置为 tiny-xlstorage。 部署具有 2 个 CPU、10 GB 内存和 1700 GB 存储的设备。 如果要为具有默认存储大小的最多 100 个主机和 1,000 个虚拟机部署 vCenter Server Appliance，请设置为 small。 部署具有 4 个 CPU、16 GB 内存和 340 GB 存储的设备。 如果要为具有大型存储大小的最多 100 个主机和 1,000 个虚拟机部署 vCenter Server Appliance，请设置为 small-lstorage。 部署具有 4 个 CPU、16 GB 内存和 870 GB 存储的设备。 如果要为具有超大型存储大小的最多 100 个主机和 1,000 个虚拟机部署 vCenter Server Appliance，请设置为 small-xlstorage。 部署具有 4 个 CPU、16 GB 内存和 1750 GB 存储的设备。 如果要为具有默认存储大小的最多 400 个主机和 4,000 个虚拟机部署 vCenter Server Appliance，请设置为 medium。 部署具有 8 个 CPU、24 GB 内存和 525 GB 存储的设备。 如果要为具有大型存储大小的最多 400 个主机和 4,000 个虚拟机部署 vCenter Server Appliance，请设置为 medium-lstorage。 部署具有 8 个 CPU、24 GB 内存和 1025 GB 存储的设备。 如果要为具有超大型存储大小的最多 400 个主机和 4,000 个虚拟机部署 vCenter Server Appliance，请设置为 medium-xlstorage。 部署具有 8 个 CPU、24 GB 内存和 1905 GB 存储的设备。 如果要为具有默认存储大小的最多 1,000 个主机和 10,000 个虚拟机部署 vCenter Server Appliance，请设置为 large。 部署具有 16 个 CPU、32 GB 内存和 740 GB 存储的设备。 如果要为最多 1,000 个主机和 10,000 个虚拟机（具有大型存储大小）部署 vCenter Server，则设置为 large-lstorage。 部署具有 16 个 CPU、32 GB 内存和 1090 GB 存储的设备。 如果要为具有超大型存储大小的最多 1,000 个主机和 10,000 个虚拟机部署 vCenter Server Appliance，请设置为 large-xlstorage。 部署具有 16 个 CPU、32 GB 内存和 1970 GB 存储的设备。 如果要为具有默认存储大小的最多 2,000 个主机和 35,000 个虚拟机部署 vCenter Server Appliance，请设置为 xlarge。 部署具有 24 个 CPU、48 GB 内存和 1180 GB 存储的设备。 如果要为具有大型存储大小的最多 2,000 个主机和 35,000 个虚拟机部署 vCenter Server Appliance，请设置为 xlarge-lstorage。 部署具有 24 个 CPU、48 GB 内存和 1230 GB 存储的设备。 如果要为具有超大型存储大小的最多 2,000 个主机和 35,000 个虚拟机部署 vCenter Server Appliance，请设置为 xlarge-xlstorage。 部署具有 24 个 CPU、48 GB 内存和 2110 GB 存储的设备。 如果要为最多 10 个主机和 100 个虚拟机（具有默认存储大小）部署具有外部 Platform Services Controller 部署的 vCenter Server Appliance，请设置为 management-tiny。 部署具有 2 个 CPU、10 GB 内存和 300 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 部分的 temporary_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" 仅当使用静态网络模式进行临时 IP 地址分配（也就是将 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。

表 6. new_vcsa 部分的 user_options 子部分中的配置参数

名称	类型	描述
vcdb_migrateSet	string	选择要从旧设备迁移到新设备的数据类型。数据会从源 vCenter Server 复制到目标服务器。原始数据源保持不变。 如果只想传输配置数据，请设置为 core。此选项可提供速度最快的数据迁移，并同时最大限度缩短系统停机时间。 如果要立即传输配置数据和历史数据（事件和任务），请设置为 core_events_tasks。从源 vCenter Server Appliance 迁移所有数据之前，vCenter Server 不会启动。 如果要立即传输配置数据、历史数据和性能衡量指标数据，请设置为 all。从适用于 Windows 的源 vCenter Server 迁移所有数据之前，vCenter Server 不会启动。此选项可传输的数据量最大，但所需的停机时间比其他数据迁移选项更长。 如果要在升级完成后在后台传输历史数据（事件和任务），请设置为 transfer_events_tasks_after_upgrade。在此期间，vCenter Server 性能可能不是最佳。 如果要在升级完成后在后台传输历史数据和性能衡量指标数据，请设置为 transfer_stats_events_tasks_after_upgrade。在此期间，vCenter Server 性能可能不是最佳。 注： 要最大限度缩短升级时间并将新 vCenter Server Appliance 所需的存储量减至最少，请使用 core 值。 有关可从现有 vCenter Server 传输到升级后的新 vCenter Server 的数据类型的详细信息，请参见从现有 vCenter ServerAppliance 传输数据。

表 7. new_vcsa 部分的 sso 子部分中的配置参数

名称	类型	描述
first_instance	string	如果这是您在 vCenter Server SSO 域中的第一次融合升级操作，或者您不希望为此节点设置复制合作伙伴，请将 first_instance 设置为 true。 如果要为此节点设置复制合作伙伴，请将 first_instance 设置为 false，并将 replication_partner_hostname 的值提供为之前已聚合但当前处于嵌入式 vCenter Server 拓扑中的节点的 FQDN。 有关指定 first_instance 和 replication_partner_hostname 参数的详细信息，请参见关于使用 CLI 升级具有外部 Platform Services Controller部署的 vCenter Server。
replication_partner_hostname	string	复制合作伙伴的主机名。如果它是 first_instance，则移除。

source_vc 部分中的配置参数

表 8. source_vc 部分的 managing_esxi_or_vc 子部分中的配置参数

名称	类型	描述
hostname	string	要升级的设备驻留在的源 ESXi 或 vCenter Server 主机的 IP 地址或 FQDN。
username	string	对源 ESXi 主机具有管理特权的用户名，例如 root。
password	string	对源 ESXi 主机具有管理特权的用户的密码。
port	integer	源 ESXi 主机的 HTTPS 反向代理端口。 默认端口为 443。仅当源 ESXi 主机使用自定义 HTTPS 反向代理端口时才应使用。

表 9. source_vc 部分的 vc_vcsa 子部分中的配置参数

名称	类型	描述
hostname	string	要升级的源设备的 IP 地址或 FQDN。
username	string	源设备上的 vCenter Single Sign-On 管理员用户，例如 [email protected]。 重要说明： 用户必须为 administrator@ your_domain_name。
password	string	源设备上的 vCenter Single Sign-On 管理员用户的密码。
root_password	string	源设备的操作系统 root 用户的密码。
export_dir	string	要将源配置和数据导出到的目录。

source.vum 部分中的配置参数

表 10. source_vum 部分的 run_migration_assistant 子部分中的配置参数

名称	类型	描述
esxi_hostname	string	上面驻留着源 VMware Update Manager 实例的 ESXi 主机的 IP 地址或 FQDN。 如果提供 FQDN，则它必须可从运行升级的客户机进行解析。
esxi_username	string	对 ESXi 主机具有管理特权的用户名，例如 root。
esxi_password	string	对 ESXi 主机具有管理特权的用户的密码。
esxi_port	string	ESXi 主机的 HTTPS 反向代理端口。 默认端口为 443。仅当 ESXi 主机使用自定义 HTTPS 反向代理端口时才应使用。
vum_hostname	string	上面运行着源 VMware Update Manager 实例的 Windows 虚拟机的 IP 地址或 FQDN。 如果提供 FQDN，则它必须可从运行升级的客户机进行解析。
vum_os_username	string	上面运行着源 VMware Update Manager 实例的 Windows 虚拟机的管理员用户名。
vum_os_password	string	上面运行着源 VMware Update Manager 实例的 Windows 虚拟机的管理员密码。 如果未提供，在模板验证期间，系统会提示您在命令控制台输入该密码。
export_dir	string	要将源配置和数据导出到的目录。

ceip 部分中的配置参数

表 11. ceip 部分的 settings 子部分中的配置参数

名称	类型	描述
ceip_enabled	Boolean	设置为 true 可加入新的已升级设备的 CEIP。