为 CLI 升级准备 JSON 配置文件时,您必须设置参数和值,提供升级 vCenter Server Appliance 或 Platform Services Controller 设备所需的输入数据。
JSON 升级文件中的配置参数的部分和子部分
用于 CLI 升级的 JSON 配置文件中的配置参数按部分和子部分进行组织。
部分 | 子部分 | 描述 |
---|---|---|
new.vcsa - 描述要部署的新设备 |
esxi |
仅当要直接在 ESXi 主机上部署新设备时才应使用。 |
vc |
仅当要在 vCenter Server 实例清单上部署新设备时才应使用。 包含描述目标 ESXi 主机或 vCenter Server 清单的 DRS 群集的配置参数。请参见
注: 您必须填充此子部分或
esxi 子部分。
目标 vCenter Server 实例不能是要升级的 vCenter Server Appliance。在这种情况下,请使用 |
|
appliance |
包含描述新设备的配置参数。请参见 new.vcsa 部分的 appliance 子部分中的配置参数 |
|
os |
仅包含 ssh.enable 配置参数,用来在新设备上设置 SSH 管理员登录。请参见 new.vcsa 部分的 os 子部分中的配置参数 |
|
ovftool.arguments |
可选。使用此子部分可以将任意参数及其值添加到安装程序所生成的 OVF Tool 命令。
重要事项:
vCenter Server Appliance 安装程序不会验证
ovftool.arguments 子部分中的配置参数。如果设置了 OVF Tool 无法识别的参数,部署可能会失败。
|
|
sso |
仅包含 仅当要升级具有嵌入式 Platform Services Controller 部署的 vCenter Server Appliance 5.5 时才需要。 |
|
temporary.network |
包含描述新设备的临时网络设置的配置参数。请参见 new.vcsa 部分的 temporary.network 子部分中的配置参数 |
|
user-options |
仅包含 vcdb.migrateSet 配置参数,用来设置要从旧设备传输到新设备的数据类型。请参见 new.vcsa 部分的 user-options 子部分中的配置参数 |
|
source.vc - 描述要升级的现有设备 |
esxi |
包含描述要升级的设备所在的源 ESXi 主机的配置参数。请参见 source.vc 部分的 esxi 子部分中的配置参数。 |
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 实例的配置参数。请参见
注: 默认情况下,
Migration Assistant 使用端口 9123。如果端口 9123 已由
Update Manager 计算机上的其他服务使用,
Migration Assistant 将自动查找其他可用端口。无法为
Migration Assistant 设置自定义端口。
|
ceip - 描述是否加入 VMware 客户体验改善计划 (Customer Experience Improvement Program, CEIP) |
settings |
仅包含 仅当升级具有嵌入式 Platform Services Controller 的 vCenter Server Appliance、具有嵌入式 vCenter Single Sign-On 的 vCenter Server Appliance 5.5 或 Platform Services Controller 设备时才需要。
注: 如果
ceip.enabled 配置参数设置为
true ,则必须使用
--acknowledge-ceip 参数运行 CLI 部署命令。
有关 CEIP 的信息,请参见vCenter Server 和主机管理中的“配置客户体验改善计划”一节。 |
要设置包含反斜杠 (\) 或引号 (") 字符的值,必须在该字符之前附加反斜杠 (\) 字符。例如,"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
部分中的配置参数
名称 | 类型 | 描述 |
---|---|---|
hostname |
string | 要在上面部署新设备的目标 ESXi 主机的 IP 地址或 FQDN。 |
username |
string | 对目标 ESXi 主机具有管理特权的用户名,例如 root。 |
password |
string | 对目标 ESXi 主机具有管理特权的用户的密码。 |
deployment.network |
string | 要将新设备连接到的网络的名称。 该网络必须是目标 ESXi 主机网络配置的一部分。
注: 必须可从要升级的设备所在的源
ESXi 主机访问该网络。该网络必须还可以从执行升级的客户机访问。
如果目标 ESXi 主机仅具有一个网络,则忽略此参数。 |
datastore |
string | 要将新设备的虚拟机配置文件和虚拟磁盘存储到的数据存储的名称。 该数据存储必须对目标 ESXi 主机可用。
注: 该数据存储必须具有至少 25 GB 的可用空间。
|
port |
integer | 目标 ESXi 主机的 HTTPS 反向代理端口。 默认端口为 443。仅当目标 ESXi 主机使用自定义 HTTPS 反向代理端口时才应使用。 |
名称 | 类型 | 描述 |
---|---|---|
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 |
string 或 array | 包含要在其中部署新设备的目标 ESXi 主机或 DRS 群集的 vCenter Server 数据中心。
如果数据中心位于文件夹或文件夹结构中,则值必须是逗号分隔的字符串列表或作为单个字符串的逗号分隔列表。例如,
["parent_folder", "child_folder", "datacenter_name"]或 "parent_folder, child_folder, datacenter_name"
注: 值区分大小写。
|
datastore |
string | 要将新设备的所有虚拟机配置文件和虚拟磁盘存储到的数据存储的名称。
注: 该数据存储必须对目标
ESXi 主机或 DRS 群集可用。
该数据存储必须具有至少 25 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 | 可选。要将新设备添加到的虚拟机文件夹的名称。 |
名称 | 类型 | 描述 |
---|---|---|
thin.disk.mode |
Boolean | 设置为 true 可部署具有精简虚拟磁盘的新设备。 |
deployment.option |
string | 新设备的大小。
注: 必须考虑要升级的设备的数据库大小。有关外部数据库,请参见
确定新设备的 Oracle 数据库大小和存储大小。
|
image |
string | 可选。指向 vCenter Server Appliance 安装包的本地文件路径或 URL。 默认情况下,安装程序使用包含于 ISO 文件中的安装包,该文件位于 vcsa 文件夹中。 |
name |
string | 新设备的虚拟机名称。 必须仅包含除百分号 (%)、反斜杠 (\) 或正斜杠 (/) 以外的 ASCII 字符,并且长度不能超过 80 个字符。 |
ovftool.path |
string | 可选。指向 OVF Tool 可执行文件的本地文件路径。 默认情况下,安装程序使用包含于 ISO 文件中的 OVF Tool 实例,该文件位于 vcsa/ovftool 文件夹中。 |
名称 | 类型 | 描述 |
---|---|---|
ssh.enable |
Boolean | 设置为 true 可在新设备上启用 SSH 管理员登录。 |
名称 | 类型 | 描述 |
---|---|---|
site-name |
string | 新设备的 vCenter Single Sign-On 站点名称。 仅当升级具有嵌入式 vCenter Single Sign-On 的 vCenter Server Appliance 5.5 时才需要。 |
名称 | 类型 | 描述 |
---|---|---|
ip.family |
string | 新设备的临时网络的 IP 版本。 请设置为 |
mode |
string | 新设备的临时网络的 IP 分配。 请设置为 |
ip |
string | 新设备的临时 IP 地址。 仅当使用静态分配(也就是将 必须设置与临时网络 IP 版本对应的 IPv4 或 IPv6 地址,也就是设置为 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 地址分配(也就是将 |
prefix |
string | 新设备的临时网络的网络前缀长度。 仅当 网络前缀长度是在子网掩码中设置的位数。例如,如果子网掩码为 255.255.255.0,则二进制版本的前缀长度中有 24 位,因此网络前缀长度为 24。 对于 IPv4 版本,值必须介于 对于 IPv6 版本,值必须介于 |
gateway |
string | 新设备的临时网络的默认网关 IP 地址。 对于 IPv6 版本,值可以是 |
system.name |
string | 新设备的临时网络的主网络标识。 可以是 IP 地址或 FQDN,首选是 FQDN。 FQDN 和用点分隔的十进制数字必须符合 RFC 1123 准则。 |
名称 | 类型 | 描述 |
---|---|---|
vcdb.migrateSet |
string | 要从旧设备传输到新设备的数据类型。
注: 要使新设备的升级时间降到最低,存储要求最少,请使用
core 值。
|
source.vc
部分中的配置参数
名称 | 类型 | 描述 |
---|---|---|
hostname |
string | 要升级的设备所在的源 ESXi 主机的 IP 地址或 FQDN。 |
username |
string | 对源 ESXi 主机具有管理特权的用户名,例如 root。 |
password |
string | 对源 ESXi 主机具有管理特权的用户的密码。 |
port |
integer | 源 ESXi 主机的 HTTPS 反向代理端口。 默认端口为 443。仅当源 ESXi 主机使用自定义 HTTPS 反向代理端口时才应使用。 |
名称 | 类型 | 描述 |
---|---|---|
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 用户的密码。 |
source.vum
部分中的配置参数
名称 | 类型 | 描述 |
---|---|---|
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
部分中的配置参数
名称 | 类型 | 描述 |
---|---|---|
ceip.enabled |
Boolean | 设置为 true 可加入新的已升级设备的 CEIP。 |