When you prepare your JSON configuration files for CLI deployment, you must set parameters and values to provide input data for the deployment of a vCenter Server Appliance or Platform Services Controller appliance.
Sections and Subsections of Configuration Parameters in the JSON Deployment Files
The configuration parameters in the JSON configuration files for CLI upgrade are organized in sections and subsections.
Section | Subsection | Description |
---|---|---|
new_vcsa - describes the appliance that you want to deploy |
esxi |
Use only if you want to deploy the appliance directly on an ESXi host.
Contains the configuration parameters that describe the target
ESXi host. See
Configuration Parameters in the new_vcsa Section, esxi Subsection.
Note: You must fill in either the
esxi or the
vc subsection.
|
vc |
Use only if you want to deploy the appliance on the inventory of a vCenter Server instance. Contains the configuration parameters that describe the target ESXi host or DRS cluster from the vCenter Server inventory. See Configuration Parameters in the
Note: You must fill in either the
vc or the
esxi subsection.
|
|
appliance |
Contains the configuration parameters that describe the appliance. See Configuration Parameters in the new_vcsa Section, appliance Subsection. |
|
network |
Contains the configuration parameters that describe the network settings for the appliance. See Configuration Parameters in the new_vcsa Section, network Subsection. |
|
os |
Contains the configuration parameters that describe the operating system settings for the appliance. See Configuration Parameters in the new_vcsa Section, os Subsection. |
|
sso |
Contains the configuration parameters that describe the vCenter Single Sign-On settings for the appliance. See Configuration Parameters in the new_vcsa Section, sso Subsection. |
|
ovftool_arguments |
Optional subsection for adding arbitrary arguments and their values to the OVF Tool command that the installer generates.
Important: The
vCenter Server Appliance installer does not validate the configuration parameters in the
ovftool_arguments subsection. If you set arguments that the OVF Tool does not recognize, the deployment might fail.
|
|
ceip - describes joining the VMware Customer Experience Improvement Program (CEIP) |
settings |
Contains only the Required only if you are deploying a vCenter Server Appliance with an embedded Platform Services Controller or a Platform Services Controller appliance.
Note: If set to
true , you must run the CLI deployment command with the
--acknowledge-ceip argument.
For information about the CEIP, see the Configuring Customer Experience Improvement Program section in vCenter Server and Host Management. |
The string values, including the passwords, must contain only ASCII characters. Extended ASCII and non-ASCII characters are unsupported.
To set a value that contains a backslash (\) or quotation mark (") character, you must precede the character with the backslash (\) character. For example, "password":"my\"password"
sets the password my"password, "image":"G:\\vcsa\\VMware-vCenter-Server-Appliance-6.7.0.XXXX-YYYYYYY_OVF10.ova"
sets the path G:\vcsa\VMware-vCenter-Server-Appliance-6.7.0.XXXX-YYYYYYY_OVF10.ova.
The Boolean values must contain only lowercase characters. Can be either true
or false
. For example, "ssh_enable":false
.
Configuration Parameters in the new_vcsa
Section
Name | Type | Description |
---|---|---|
hostname |
string | The IP address or FQDN of the target ESXi host on which you want to deploy the appliance. |
username |
string | A user name with administrative privileges on the target ESXi host, for example, root. |
password |
string | The password of the user with administrative privileges on the target ESXi host. |
deployment_network |
string | The name of the network to which to connect the appliance.
Note: The network must be accessible from the target
ESXi host.
Ignored if the target ESXi host has only one network. |
datastore |
string | The name of the datastore that you want to store all virtual machine configuration files and virtual disks of the appliance.
Note:
The datastore must be accessible from the ESXi host. The datastore must have enough free space. |
port |
integer | The HTTPS reverse proxy port of the target ESXi host. The default port is 443. Use only if the target ESXi host uses a custom HTTPS reverse proxy port. |
Name | Type | Description |
---|---|---|
hostname |
string | The IP address or FQDN of the target vCenter Server instance on which you want to deploy the appliance. |
username |
string | vCenter Single Sign-On administrator user name on the target vCenter Server instance, for example, [email protected]. |
password |
string | The password of the vCenter Single Sign-On administrator user on the target vCenter Server instance. |
deployment_network |
string | The name of the network to which to connect the appliance.
Note: The network must be accessible from the target
ESXi host or DRS cluster on which you want to deploy the appliance.
Ignored if the target ESXi host or DRS cluster has only one network. |
datacenter |
string or array | The vCenter Server datacenter that contains the target ESXi host or DRS cluster on which you want to deploy the appliance.
If the datacenter is located in a folder or a structure of folders, the value must be either a comma-separated list of strings or a comma-separated list as a single string. For example,
["parent_folder", "child_folder", "datacenter_name"]or "parent_folder, child_folder, datacenter_name"
Note: The value is case-sensitive.
|
datastore |
string | The name of the datastore that you want to store all virtual machine configuration files and virtual disks of the appliance.
Note:
The datastore must be accessible from the target ESXi host or DRS cluster. The datastore must have at least 15 GB of free space. |
port |
integer | The HTTPS reverse proxy port of the target vCenter Server instance. The default port is 443. Use only if the target vCenter Server instance uses a custom HTTPS reverse proxy port. |
target |
string or array | The target ESXi host or DRS cluster on which you want to deploy the appliance.
Important: You must provide the name that is displayed in the
vCenter Server inventory. For example, if the name of the target
ESXi host is an IP address in the
vCenter Server inventory, you cannot provide an FQDN.
If the target
ESXi host or DRS cluster is located in a folder or a structure of folders, the value must be a comma-separated list of strings or a comma-separated list as a single string. For example,
["parent_folder", "child_folder", "esxi-host.domain.com"]or "parent_folder, child_folder, esxi-host.domain.com"
If the target
ESXi host is part of a cluster, use a comma-separated list of strings or a comma-separated list as a single string to provide the path. For example,
["cluster_name", "esxi-host.domain.com"]or "cluster_name, esxi-host.domain.com"
Note: The value is case-sensitive.
|
vm_folder |
string | Optional. The name of the VM folder to which to add the appliance. |
Name | Type | Description |
---|---|---|
thin_disk_mode |
Boolean | Set to true to deploy the appliance with thin virtual disks. |
deployment_option |
string | The size of the appliance.
|
image |
string | Optional. A local file path or URL to the vCenter Server Appliance installation package. By default the installer uses the installation package that is included in the ISO file, in the vcsa folder. |
name |
string | The VM name for the appliance. Must contain only ASCII characters except a percent sign (%), backslash (\), or forward slash (/) and must be no more than 80 characters in length. |
ovftool_path |
string | Optional. A local file path to the OVF Tool executable file. By default the installer uses the OVF Tool instance that is included in the ISO file, in the vcsa/ovftool folder. |
Name | Type | Description |
---|---|---|
ip_family |
string | IP version for the network of the appliance. Set to |
mode |
string | IP assignment for the network of the appliance. Set to |
ip |
string | IP address for the appliance. Required only if you use static assignment, that is, if you set the You must set an IPv4 or IPv6 address that corresponds to the network IP version, that is, to the value of the An IPv4 address must comply with the RFC 790 guidelines. An IPv6 address must comply with the RFC 2373 guidelines. |
dns_servers |
string or array | IP addresses of one or more DNS servers.
To set more than one DNS server, use a comma-separated list of strings or a comma-separated list as a single string to provide the path. For example,
["x.y.z.a", "x.y.z.b"]or "x.y.z.a, x.y.z.b" Required only if you use static assignment, that is, if you set the |
prefix |
string | Network prefix length. Use only if the The network prefix length is the number of bits that are set in the subnet mask. For example, if the subnet mask is 255.255.255.0, there are 24 bits in the binary version of the prefix length, so the network prefix length is 24. For IPv4 version, the value must be between For IPv6 version, the value must be between |
gateway |
string | IP address of the default gateway. For IPv6 version, the value can be |
ports |
string | (Optional) Port numbers that the vCenter Server Appliance uses for direct HTTP connections. By default, port 80 redirects requests to HTTPS port 443. You can customize the vCenter Server HTTP and HTTPS ports. If specifying a custom HTTP and HTTPS port number, ensure that you do not use a port already in use by vCenter Server, or the default HTTP and HTTPS ports of 80 and 443. The options to specify a custom port are: The following example specifies ports 81 and 444 for the HTTP and HTTPS ports: ports: {"rhttpproxy.ext.port1":"81", "rhttpproxy.ext.port2":"444"} For more information on ports in use by vCenter Server, see Required Ports for vCenter Server and Platform Services Controller . |
system_name |
string | Primary network identity. Can be an IP address or FQDN, preferably FQDN. You cannot change the value of this parameter after the deployment. The FQDN and dotted-decimal numbers must comply with the RFC 1123 guidelines. |
Name | Type | Description |
---|---|---|
password |
string | The password for the root user of the appliance operating system. The password must contain between 8 and 20 characters, at least one uppercase letter, at least one lowercase letter, at least one number, and at least one special character, for example, a dollar sign ($), hash key (#), at sign (@), period (.), or exclamation mark (!). All characters must be lower ASCII characters without spaces. |
ntp_servers |
string or array | Optional. Host names or IP addresses of one or more NTP servers for time synchronization.
To set more than one NTP server, use a comma-separated list of strings or a comma-separated list as a single string to provide the path. For example,
["x.y.z.a", "x.y.z.b"]or "x.y.z.a, x.y.z.b" |
ssh_enable |
Boolean | Set to true to enable SSH administrator login to the appliance.
Note:
vCenter Server Appliance high availability requires remote SSH access to the appliance.
|
time_tools_sync |
Boolean | Optional. Set to Ignored if you set NTP servers for time synchronization, that is, if you set the |
Name | Type | Description |
---|---|---|
password |
string | Password of the vCenter Single Sign-On administrator user, administrator@your_domain_name.
|
domain_name |
string | vCenter Single Sign-On domain name, for example, vsphere.local.
|
first_instance |
Boolean | Required only if you are deploying a Platform Services Controller appliance. The default value is Set to Joined Platform Services Controller instances replicate their infrastructure data and enable Enhanced Linked Mode. For information about managing the Platform Services Controller services, see Platform Services Controller Administration. |
platform_services_controller |
string | The system name of the external Platform Services Controller. Required only if you are deploying a vCenter Server Appliance with an external Platform Services Controller. |
replication_partner_hostname |
string | The system name of the partner Platform Services Controller. Required only if you are deploying a Platform Services Controller appliance as a replication partner in an existing vCenter Single Sign-On domain. |
sso_port |
integer | The HTTPS reverse proxy port of the partner Platform Services Controller. The default port is 443. Use only if you the partner Platform Services Controller uses a custom HTTPS reverse proxy port. |
site_name |
string | vCenter Single Sign-On name. Required only if you are deploying an embedded Platform Services Controller appliance.
Note: When setting up enhanced linked mode support for
vCenter Server Appliance deployments with an embedded
Platform Services Controller, use
Default-First-Site as the site name for the first instance.
|
Configuration Parameters in the ceip
Section
Name | Type | Description |
---|---|---|
ceip_enabled |
Boolean | Set to true to join the CEIP for this appliance. |