Vmware – vCenter Server Appliance – 6.0.1 – Command-Line Deployment and Upgrade

Category: Software and Application User Guides and Manuals

Download user manual for Vmware – vCenter Server Appliance – 6.0.1 – Command-Line Deployment and Upgrade 
Preview: Below is a preview of the manual as extracted from the PDF file


Technical Note
VMware, Inc. 1

Command-Line Deployment and
Upgrade of VMware vCenter Server
Appliance 6.0 Update 1
vCenter Server Appliance 6.0 Update 1
This technical note describes the command-line deployment and upgrade processes of the
VMware vCenter Server™ Appliance™.
The vCenter Server Appliance is a preconfigured Linux-based virtual machine that is optimized for running vCenter
Server.
The command-line installer is intended for advanced users who are familiar with vSphere. The main purpose of the
command-line installer is to enable automation and prevent user input errors.
Overview
You can use the vCenter Server Appliance command-line installer, which is integrated with the VMware OVF Tool, to
deploy and upgrade the vCenter Server Appliance.
The command-line deployment process includes downloading the installer ISO file, preparing a deployment template
that is a JSON configuration file, and running the deployment command.
The command-line upgrade process includes downloading the installer ISO file, preparing an upgrade template that is
a JSON configuration file, and running the upgrade command. The upgrade of the vCenter Server Appliance is a
migration of the old version to the latest version, which results in the deployment of a new vCenter Server Appliance.
The installer ISO file contains deployment and upgrade templates of JSON files that contain the minimum configuration
parameters required for the different use cases. You can see the content of the templates in Example 1 to Example 16.
Software Included in the vCenter Server Appliance Package
The vCenter Server Appliance package contains the following software:
 SUSE Linux Enterprise Server 11 Update 3 for VMware, 64-bit edition
 PostgreSQL
 vCenter Server 6.0 Update 1 and vCenter Server 6.0 Update 1 componentsVMware, Inc. 2
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

vCenter Server Appliance Components
The vCenter Server Appliance consists of the following components.
 VMware Platform Services Controller
A group of infrastructure services such as vCenter Single Sign-On, License service, and VMware Certificate
Authority
 vCenter Server
A group of services such as vCenter Server, vSphere Web Client, Inventory Service, vSphere Auto Deploy , vSphere
ESXi Dump Collector, and vSphere Syslog Service for vCenter Server Appliance
vCenter Server Appliance Deployment Models
You can deploy the vCenter Server Appliance in one of the following deployment models.
For more information about vCenter Server deployment models, see the vSphere Installation and Setup documentation at
http://pubs.vmware.com.
vCenter Server Appliance Upgrade Paths
You can upgrade from the vCenter Server Appliance 5.1 Update 3 or 5.5.x to 6.0 Update 1.
For more information about the vCenter Server upgrade paths, see the vSphere Upgrade documentation at
http://pubs.vmware.com.
Table 1. vCenter Server Appliance Deployment Models
vCenter Server Appliance Deployment Model Description
vCenter Server Appliance with an embedded Platform
Services Controller
All services bundled with the Platform Services Controller
are deployed together with vCenter Server in the same
appliance.
IMPORTANT A vCenter Server with an embedded
Platform Services Controller deployment contains a
standalone Platform Services Controller. You cannot use
the embedded Platform Services Controller to replicate
vCenter Single Sign-On data. Setting up replication
partners between multiple vCenter Server instances with
embedded Platform Services Controllers is not supported.
vCenter Server Appliance with an external Platform
Services Controller
All services bundled with the Platform Services Controller
are deployed as one appliance and vCenter Server is
deployed as another appliance.
IMPORTANT You must first deploy the Platform Services
Controller and then deploy the vCenter Server Appliance.VMware, Inc. 3
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Requirements
Supported Operating Systems for the Command-Line Installer
You can run the vCenter Server Appliance command-line installer from any virtual or physical server in the vSphere
network. The vCenter Server Appliance command-line installer is supported on the following operating systems:
 Windows 7
 Windows Server 2008/2012
 Windows 8
 SUSE Linux 11 SP3 (64-bit)
 Mac OS 10.9
Hardware Requirements
When you deploy or upgrade the vCenter Server Appliance, select to deploy an appliance that is suitable for the size of
your vSphere environment.
The hardware requirements, such as the number of CPUs and memory, depend on the size of your vSphere inventory.
Table 2. Hardware Requirements
Resources Number of CPUs Memory
Platform Services Controller 2 2 GB RAM
Tiny environment
up to 10 hosts, 100 virtual machines
28 GB RAM
Small environment
up to 100 hosts, 1,000 virtual machines
4 16 GB RAM
Medium environment
up to 400 hosts, 4,000 virtual machines
8 24 GB RAM
Large environment
up to 1,000 hosts, 10,000 virtual machines
16 32 GB RAM
NOTE For instances of vCenter Server Appliance with an embedded Platform Services Controller, the
required memory size and number of CPUs are the sum of the values for the Platform Services Controller and
the values for the environment you want to deploy. VMware, Inc. 4
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Storage Requirements
The host on which the vCenter Server Appliance is to be deployed or upgraded must meet minimum storage
requirements, depending on the selected deployment model.
Database Requirements
Each vCenter Server Appliance must have its own database to store and organize server data.
You can use the embedded PostgreSQL database that is included in the vCenter Server Appliance. The PostgreSQL
database supports up to 1,000 hosts and 10,000 virtual machines.
The vCenter Server Appliance supports only an Oracle database as an external database. The supported Oracle
database versions are the same as the as the supported Oracle database versions that are shown in the VMware Product
Interoperability Matrix for vCenter Server 6.0 Update 1. See the VMware Product Interoperability Matrix at
http://www.vmware.com/resources/compatibility/sim/interop_matrix.php.
Host Requirements
You can deploy or upgrade the vCenter Server Appliance on an ESXi host 5.0 or later. You can also deploy or upgrade
the vCenter Server Appliance on an ESXi host or DRS cluster that resides in the inventory of a vCenter Server instance
5.0 or later.
Table 3. Storage Requirements
vCenter Server
Appliance with an
Embedded Platform
Services Controller
vCenter Server
Appliance with an
External Platform
Services Controller
External Platform
Services Controller
Appliance
Tiny environment
up to 10 hosts, 100 virtual machines
101 GB 86 GB 25.5 GB
Small environment
up to 100 hosts, 1,000 virtual
machines
146 GB 108 GB 25.5 GB
Medium environment
up to 400 hosts, 4,000 virtual
machines
270 GB 220 GB 25.5 GB
Large environment
up to 1,000 hosts, 10,000 virtual
machines
445 GB 280 GB 25.5 GBVMware, Inc. 5
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Command-Line Deployment and Upgrade Steps
You can run the command-line deployment or upgrade of the vCenter Server Appliance from a virtual or physical
machine that is running on a Windows, Linux, or Mac operating system and that meets the operating system
requirements. See section “Supported Operating Systems for the Command-Line Installer” on page 3.
General Deployment and Upgrade Process
You can deploy or upgrade the vCenter Server Appliance from a machine that is in your vSphere network and that is
running on Microsoft Windows, Linux, or Mac.
IMPORTANT As a precaution in case of failure during the upgrade process, create a snapshot of the vCenter Server
Appliance that you want to upgrade.
To deploy or upgrade the vCenter Server Appliance:
1 Download the installer ISO file from the VMware Web site.
The installer ISO file name is VMware-VCSA-all-6.0.0-yyyyyy.iso, where yyyyyy is the build number.
2 Prepare the JSON configuration file for your deployment or upgrade specification by using the templates that are
available in the installer ISO file. See “Prepare Deployment and Upgrade Templates” on page 26.
3 Navigate to the installer execution directory for your operating system (OS).
 If you are deploying or upgrading the vCenter Server Appliance from a machine with Windows OS, at the
command prompt, navigate to the vcsa-cli-installerwin32 directory.
 If you are deploying or upgrading the vCenter Server Appliance from a machine with Linux OS, at the
command prompt, navigate to the vcsa-cli-installer/lin64 directory.
 If you are deploying or upgrading the vCenter Server Appliance from a machine with Mac OS, at the
command prompt, navigate to the vcsa-cli-installer/mac directory.
4 (Optional) Run a predeployment or preupgrade check without deploying the appliance.
 Verify that you prepared the deployment template correctly.
vcsa-deploy –verify-only path_to_the_json_file
 Verify that you prepared the upgrade template correctly.
vcsa-deploy upgrade –verify-only path_to_json_file
NOTE When verifying an upgrade template, the preupgrade check installs an RPM file on the vCenter Server
Appliance that you want to upgrade.
5 Run the deployment or upgrade command.
 Deploy the appliance.
vcsa-deploy –accept-eula optional_arguments path_to_the_json_file
 Upgrade the appliance.
vcsa-deploy upgrade –accept-eula optional_arguments path_to_json_file
You can use a space-separated list of optional arguments to set additional configurations. For example, you can set
the location of the log and other output files that the installer generates.
vcsa-deploy –accept-eula –log-dir=path_to_the_location path_to_the_json_fileVMware, Inc. 6
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Optional Arguments of the Command-Line Installer
Table 4. Optional Arguments of the Command-Line Installer
Optional Argument Description
-h, –help Displays the help message for the command.
–template-help Displays the help message for the configuration parameters in the JSON
file.
-v, –verbose Adds debug information to the console output.
-t, –terse Hides the console output. Displays only warning and error messages.
–log-dir, LOG_DIR Sets the location of the log and other output files that the installer
generates.
–verify-only Performs basic verification of the configuration parameters in the JSON
file and verification of the OVF Tool parameters. Does not deploy the
appliance.
–skip-ovftool-verification Performs basic verification of the configuration parameters in the JSON
file and deploys the appliance. Does not perform verification of the OVF
Tool parameters.
–no-esx-ssl-verify Skips the SSL verification for ESXi connections.
Avoid using this option because it might cause problems during
deployment or after deployment because of invalidated values passed to
the appliance.
–sso-ssl-thumbprint, SSL-SHA1-THUMBPRINT Validates server certificate against the supplied SHA1 thumbprint.
–accept-eula Accepts the end-user license agreementVMware, Inc. 7
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Using the Deployment and Upgrade Templates
This section provides details about the vCenter Server Appliance deployment and upgrade templates and how to use
the templates to prepare the JSON configuration files for your deployment or upgrade specification.
Templates for New Deployments
For deployment of the vCenter Server Appliance, the installer ISO file contains eight JSON templates that are located
in the vcsa-cli-installer/template/install directory:
Table 5. Templates of JSON Files for Deployment of the vCenter Server Appliance
Template JSON File Description
embedded_vCSA_on_ESXi.json Contains the minimum configuration parameters required for deployment of a
vCenter Server Appliance with an embedded Platform Services Controller on
an ESXi host. See the template in Example 1.
embedded_vCSA_on_VC.json Contains the minimum configuration parameters required for deployment of a
vCenter Server Appliance with an embedded Platform Services Controller on
an ESXi host or DRS cluster that resides in the inventory of a vCenter Server
instance. See the template in Example 2.
PSC_on_ESXi.json Contains the minimum configuration parameters required for deployment of a
Platform Services Controller appliance on an ESXi host. See the template in
Example 3.
PSC_on_VC.json Contains the minimum configuration parameters required for deployment of a
Platform Services Controller appliance on an ESXi host or DRS cluster that
resides in the inventory of a vCenter Server instance. See the template in
Example 4.
PSC_replication_on_ESXi.json Contains the minimum configuration parameters required for deployment of a
replicating Platform Services Controller appliance on an ESXi host. See the
template in Example 5.
PSC_replication_on_VC.json Contains the minimum configuration parameters required for deployment of a
replicating Platform Services Controller appliance on an ESXi host or DRS
cluster that resides in the inventory of a vCenter Server instance. See the
template in Example 6.
VC_on_ESXi.json Contains the minimum configuration parameters required for deployment of a
vCenter Server Appliance with an external Platform Services Controller on an
ESXi host. See the template in Example 7.
VC_on_VC.json Contains the minimum configuration parameters required for deployment of a
vCenter Server Appliance with an external Platform Services Controller on an
ESXi host or DRS cluster that resides in the inventory of a vCenter Server
instance. See the template in Example 8VMware, Inc. 8
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 1. Content of the embedded_vCSA_on_ESXi.json Deployment Template
{
“__version”: “1.1”,
“__comments”: “Sample template to deploy a vCenter Server with an embedded Platform Services
Controller to an ESXi host.”,
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “small”,
“name”: “vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“esx”: {
“hostname”: ““,
“username”: “root”,
“password”: ““,
“datastore”: “
},
“network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
},
“os”: {
“password”: ““,
“ssh.enable”: true
},
“sso”: {
“password”: ““,
“domain-name”: “vsphere.local”,
“site-name”: “
}
}
}VMware, Inc. 9
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 2. Content of the embedded_vCSA_on_VC.json Deployment Template
{
“__version”: “1.1”,
“__comments”: “Sample template to deploy a vCenter Server with an embedded Platform Services
Controller to a vCenter Server.”,
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “small”,
“name”: “vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
},
“os”: {
“password”: ““,
“ssh.enable”: true
},
“sso”: {
“password”: ““,
“domain-name”: “vsphere.local”,
“site-name”: “
},
“vc”: {
“hostname”: ““,
“username”: “Administrator@vsphere.local”,
“password”: ““,
“datacenter”: [
“folderA”,
“folderB”,
“Datacenter”
],
“datastore”: ““,
“target”: [
“folder1”,
“folder2”,

]
}
}
}VMware, Inc. 10
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 3. Content of the PSC_on_ESXi.json Deployment Template
{
“__version”: “1.1”,
“__comments”: “Sample template to deploy a Platform Services Controller to an ESXi host.”,
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “infrastructure”,
“name”: “vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“esx”: {
“hostname”: ““,
“username”: “root”,
“password”: ““,
“datastore”: “
},
“network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
},
“os”: {
“password”: ““,
“ssh.enable”: true
},
“sso”: {
“password”: ““,
“domain-name”: “vsphere.local”,
“site-name”: “
}
}
}VMware, Inc. 11
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 4. Content of the PSC_on_VC.json Deployment Template
{
“__version”: “1.1”,
“__comments”: “Sample template to deploy a Platform Services Controller to a vCenter Server.”,
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “infrastructure”,
“name”: “vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
},
“os”: {
“password”: ““,
“ssh.enable”: true
},
“sso”: {
“password”: ““,
“domain-name”: “vsphere.local”,
“site-name”: “
},
“vc”: {
“hostname”: ““,
“username”: “Administrator@vsphere.local”,
“password”: ““,
“datacenter”: [
“folderA”,
“folderB”,
“Datacenter”
],
“datastore”: ““,
“target”: [
“folder1”,
“folder2”,

]
}
}
}VMware, Inc. 12
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 5. Content of the PSC_replication_on_ESXi.json Deployment Template
{
“__version”: “1.1”,
“__comments”: “Sample template to deploy a Platform Services Controller to an ESXi host, joining an
existing vCenter Single Sign-On domain.”,
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “infrastructure”,
“name”: “vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“esx”: {
“hostname”: ““,
“username”: “root”,
“password”: ““,
“datastore”: “
},
“network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
},
“os”: {
“password”: ““,
“ssh.enable”: true
},
“sso”: {
“password”: ““,
“domain-name”: “vsphere.local”,
“first-instance”: false,
“replication-partner-hostname”: ““,
“site-name”: “
}
}
}VMware, Inc. 13
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 6. Content of the PSC_replication_on_VC.json Deployment Template
{
“__version”: “1.1”,
“__comments”: “Sample template to deploy a Platform Services Controller to an ESXi host, joining an
existing vCenter Single Sign-On domain.”,
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “infrastructure”,
“name”: “vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“esx”: {
“hostname”: ““,
“username”: “root”,
“password”: ““,
“datastore”: “
},
“network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
},
“os”: {
“password”: ““,
“ssh.enable”: true
},
“sso”: {
“password”: ““,
“domain-name”: “vsphere.local”,
“first-instance”: false,
“replication-partner-hostname”: ““,
“site-name”: “
}
}
}VMware, Inc. 14
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 7. Content of the VC_on_ESXi.json Deployment Template
{
“__version”: “1.1”,
“__comments”: “Sample template to deploy a vCenter Server to an ESXi host.”,
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “management-small”,
“name”: “vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“esx”: {
“hostname”: ““,
“username”: “root”,
“password”: ““,
“datastore”: “
},
“network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
},
“os”: {
“password”: ““,
“platform.service.controller”: ““,
“ssh.enable”: true
},
“sso”: {
“password”: ““,
“domain-name”: “vsphere.local”,
“site-name”: “
}
}
}VMware, Inc. 15
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 8. Content of the VC_on_VC.json Deployment Template
{
“__version”: “1.1”,
“__comments”: “Sample template to deploy a vCenter Server to a vCenter Server.”,
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “management-small”,
“name”: “vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
},
“os”: {
“password”: ““,
“platform.service.controller”: ““,
“ssh.enable”: true
},
“sso”: {
“password”: ““,
“domain-name”: “vsphere.local”,
“site-name”: “
},
“vc”: {
“hostname”: ““,
“username”: “Administrator@vsphere.local”,
“password”: ““,
“datacenter”: [
“folderA”,
“folderB”,
“Datacenter”
],
“datastore”: ““,
“target”: [
“folder1”,
“folder2”,

]
}
}
}VMware, Inc. 16
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Templates for Upgrading a vCenter Server Appliance 5.1 Update 3
For upgrade of the vCenter Server Appliance from 5.1 Update 3 to 6.0 Update 1, the installer ISO file contains two JSON
templates that are located in the vcsa-cli-installer/template/upgrade/5.1 directory.:
Table 6. Templates of JSON Files for Upgrade of the vCenter Server Appliance 5.1 Update 3
Template JSON File Description
embedded_vCSA_on_ESXi.json Contains the minimum configuration parameters required for upgrade of a
vCenter Server Appliance 5.1 Update 3 to a vCenter Server Appliance 6.0
Update 1 with an embedded Platform Services Controller on an ESXi host. See
the content of the template in Example 10.
embedded_vCSA_on_VC.json Contains the minimum configuration parameters required for upgrade of a
vCenter Server Appliance 5.1 Update 3 to a vCenter Server Appliance 6.0
Update 1 with an embedded Platform Services Controller on an ESXi host or
DRS cluster that resides in the inventory of a vCenter Server instance. See the
content of the template in Example 10.VMware, Inc. 17
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 9. Content of the embedded_vCSA_on_ESXi.json Template for Upgrade From Version 5.1 Update 3
{
“__version”: “1.1”,
“__comments”: “Sample template to upgrade a vCenter Server from 5.1 Update 3 to 6.0.”,
“source.vc”: {
“esx”: {
“hostname”: ““,
“username”: “root”,
“password”: “
},
“vc.vcsa”: {
“hostname”: ““,
“username”: “root”,
“password”: ““,
“root.password”: “
}
},
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “small”,
“name”: “Upgraded-vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“os”: {
“ssh.enable”: true
},
“sso”: {
“password”: ““,
“domain-name”: “vsphere.local”,
“site-name”: “
},
“temporary.network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
}
}
}VMware, Inc. 18
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 10. Content of the embedded_vCSA_on_VC.json Template for Upgrade From Version 5.1 Update 3
{
“__version”: “1.1”,
“__comments”: “Sample template to upgrade a vCenter Server from 5.1 Update 3 to 6.0.”,
“source.vc”: {
“esx”: {
“hostname”: ““,
“username”: “root”,
“password”: “
},
“vc.vcsa”: {
“hostname”: ““,
“username”: “root”,
“password”: ““,
“root.password”: “
}
},
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “small”,
“name”: “Upgraded-vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“os”: {
“ssh.enable”: true
},
“sso”: {
“password”: ““,
“domain-name”: “vsphere.local”,
“site-name”: “
},
“temporary.network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
},
“vc”: {
“hostname”: ““,
“username”: “Administrator@vsphere.local”,
“password”: ““,
“datacenter”: [
“folderA”,
“folderB”,
“Datacenter”
],
“datastore”: ““,
“target”: [
“folder1”,
“folder2”,

]
}
}
}VMware, Inc. 19
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Templates for Upgrading a vCenter Server Appliance 5.5.x
For upgrade of the vCenter Server Appliance from 5.5.x to 6.0 Update 1, the installer ISO file contains six JSON
templates that are located in the vcsa-cli-installer/template/upgrade/5.5 directory.
Table 7. Templates of JSON Files for Upgrade of the vCenter Server Appliance 5.5.x
Template JSON File Description
embedded_vCSA_on_ESXi.json Contains the minimum configuration parameters required for upgrade of a
vCenter Server Appliance 5.5.x with an embedded vCenter Single Sign-On
server to a vCenter Server Appliance 6.0 Update 1 with an embedded Platform
Services Controller on an ESXi host. See the content of the template in
Example 11.
embedded_vCSA_on_VC.json Contains the minimum configuration parameters required for upgrade of a
vCenter Server Appliance 5.5.x with an embedded vCenter Single Sign-On
server to a vCenter Server Appliance 6.0 Update 1 with an embedded Platform
Services Controller on an ESXi host or DRS cluster that resides in the inventory
of a vCenter Server instance. See the content of the template in Example 12.
PSC_on_ESXi.json Contains the minimum configuration parameters for required upgrade of a
vCenter Single Sign-On appliance 5.5.x to a Platform Services Controller
appliance 6.0 Update 1 on an ESXi host. See the content of the template in
Example 13.
PSC_on_VC.json Contains the minimum configuration parameters required for upgrade of a
vCenter Single Sign-On appliance 5.5.x to a Platform Services Controller
appliance 6.0 Update 1 on an ESXi host or DRS cluster that resides in the
inventory of a vCenter Server instance. See the content of the template in
Example 14.
VC_on_ESXi.json Contains the minimum configuration parameters required for upgrade of a
vCenter Server Appliance 5.5.x with an external vCenter Single Sign-On server
to a vCenter Server Appliance 6.0 Update 1 with an external Platform Services
Controller on an ESXi host. See the content of the template in Example 15.
IMPORTANT Before you upgrade the vCenter Server Appliance 5.5.x with an
external vCenter Single Sign-On server, you must upgrade the external vCenter
Single Sign-On server and its replicating partners, if any exist in the domain, to
Platform Services Controller instances.
VC_on_VC.json Contains the minimum configuration parameters required for upgrade of a
vCenter Server Appliance 5.5.x with an external vCenter Single Sign-On server
to a vCenter Server Appliance 6.0 Update 1 with an external Platform Services
Controller on an ESXi host or DRS cluster that resides in the inventory of a
vCenter Server instance. See the content of the template in Example 16.
IMPORTANT Before you upgrade the vCenter Server Appliance 5.5.x with an
external vCenter Single Sign-On server, you must upgrade the external vCenter
Single Sign-On server and its replicating partners, if any exist in the domain, to
Platform Services Controller instances.VMware, Inc. 20
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 11. Content of the embedded_vCSA_on_ESXi.json Template for Upgrade From Version 5.5.x
{
“__version”: “1.1”,
“__comments”: “Sample template to upgrade a vCenter Server with an embedded Platform Services
Controller from 5.5 to 6.0.”,
“source.vc”: {
“esx”: {
“hostname”: ““,
“username”: “root”,
“password”: “
},
“vc.vcsa”: {
“hostname”: ““,
“username”: “Administrator@vsphere.local”,
“password”: ““,
“root.password”: “
}
},
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “small”,
“name”: “Upgraded-vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“os”: {
“ssh.enable”: true
},
“sso”: {
“site-name”: “
},
“temporary.network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
}
}
}VMware, Inc. 21
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 12. Content of the embedded_vCSA_on_VC.json Template for Upgrade From Version 5.5.x
{
“__version”: “1.1”,
“__comments”: “Sample template to upgrade a vCenter Server with an embedded Platform Services
Controller from 5.5 to 6.0.”,
“source.vc”: {
“esx”: {
“hostname”: ““,
“username”: “root”,
“password”: “
},
“vc.vcsa”: {
“hostname”: ““,
“username”: “Administrator@vsphere.local”,
“password”: ““,
“root.password”: “
}
},
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “small”,
“name”: “Upgraded-vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“os”: {
“ssh.enable”: true
},
“sso”: {
“site-name”: “
},
“temporary.network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
},
“vc”: {
“hostname”: ““,
“username”: “Administrator@vsphere.local”,
“password”: ““,
“datacenter”: [
“folderA”,
“folderB”,
“Datacenter”
],
“datastore”: ““,
“target”: [
“folder1”,
“folder2”,

]
}
}
}VMware, Inc. 22
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 13. Content of the PSC_on_ESXi.json Template for Upgrade From Version 5.5.x
{
“__version”: “1.1”,
“__comments”: “Sample template to upgrade a Platform Services Controller from 5.5 to 6.0.”,
“source.vc”: {
“esx”: {
“hostname”: ““,
“username”: “root”,
“password”: “
},
“vc.vcsa”: {
“hostname”: ““,
“username”: “Administrator@vsphere.local”,
“password”: ““,
“root.password”: “
}
},
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “infrastructure”,
“name”: “Upgraded-vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“os”: {
“ssh.enable”: true
},
“sso”: {
“site-name”: “
},
“temporary.network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
}
}
}VMware, Inc. 23
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 14. Content of the PSC_on_VC.json Template for Upgrade From Version 5.5.x
{
“__version”: “1.1”,
“__comments”: “Sample template to upgrade a Platform Services Controller vCenter Server from 5.5 to
6.0.”,
“source.vc”: {
“esx”: {
“hostname”: ““,
“username”: “root”,
“password”: “
},
“vc.vcsa”: {
“hostname”: ““,
“username”: “Administrator@vsphere.local”,
“password”: ““,
“root.password”: “
}
},
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “infrastructure”,
“name”: “Upgraded-vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“os”: {
“ssh.enable”: true
},
“sso”: {
“site-name”: “
},
“temporary.network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
},
“vc”: {
“hostname”: ““,
“username”: “Administrator@vsphere.local”,
“password”: ““,
“datacenter”: [
“folderA”,
“folderB”,
“Datacenter”
],
“datastore”: ““,
“target”: [
“folder1”,
“folder2”,

]
}
}
}VMware, Inc. 24
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 15. Content of the VC_on_ESXi.json Template for Upgrade From Version 5.5.x
{
“__version”: “1.1”,
“__comments”: “Sample template to upgrade a vCenter Server from 5.5 to 6.0.”,
“source.vc”: {
“esx”: {
“hostname”: ““,
“username”: “root”,
“password”: “
},
“vc.vcsa”: {
“hostname”: ““,
“username”: “Administrator@vsphere.local”,
“password”: ““,
“root.password”: “
}
},
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “management-small”,
“name”: “Upgraded-vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“os”: {
“ssh.enable”: true
},
“sso”: {
“site-name”: “
},
“temporary.network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
}
}
}VMware, Inc. 25
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Example 16. Content of the VC_on_VC.json Template for Upgrade From Version 5.5.x
{
“__version”: “1.1”,
“__comments”: “Sample template to upgrade a vCenter Server from 5.5 to 6.0.”,
“source.vc”: {
“esx”: {
“hostname”: ““,
“username”: “root”,
“password”: “
},
“vc.vcsa”: {
“hostname”: ““,
“username”: “Administrator@vsphere.local”,
“password”: ““,
“root.password”: “
}
},
“target.vcsa”: {
“appliance”: {
“deployment.network”: “VM Network”,
“deployment.option”: “management-small”,
“name”: “Upgraded-vCenter-Server-Appliance”,
“thin.disk.mode”: true
},
“os”: {
“ssh.enable”: true
},
“sso”: {
“site-name”: “
},
“temporary.network”: {
“hostname”: ““,
“dns.servers”: [
“,

],
“gateway”: ““,
“ip”: ““,
“ip.family”: “ipv4”,
“mode”: “static”,
“prefix”: “
},
“vc”: {
“hostname”: ““,
“username”: “Administrator@vsphere.local”,
“password”: ““,
“datacenter”: [
“folderA”,
“folderB”,
“Datacenter”
],
“datastore”: ““,
“target”: [
“folder1”,
“folder2”,

]
}
}
}VMware, Inc. 26
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Prepare Deployment and Upgrade Templates
You can deploy and upgrade the vCenter Server Appliance with minimum configurations by setting values to the
configuration parameters in the templates that are available in the installer ISO file. The configuration parameters that
are not included in the templates are set to their default values. You can add configuration parameters in the templates
to set their values for your deployment or upgrade specification.
To prepare the deployment or upgrade templates:
1Open the templates subfolder that is located in the vsca-cli-installer directory.
2 Copy the template files to your workspace.
3 Open a template file in a text editor.
4 Fill in the required fields and, optionally, add new parameters to the template.
5 Save in UTF-8 format and close the file.
You can create and save as many templates as are needed for your specific environment.VMware, Inc. 27
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

Configuration Parameters for New and Upgrade Deployments
Table 8 lists the configuration parameters in the target.vcsa section that you use to provide input data for the new
vCenter Server Appliance in the deployment and upgrade templates.
You must provide the parameters with values for your deployment or upgrade specification. For example, if you want
to deploy the appliance with an external database, you must provide the database parameter subsection.
Table 8. List of the Configuration Parameters in the target.vcsa Section
Parameter Default Description
appliance subsection
deployment.network – The network of the ESXi host on which you want to deploy the
vCenter Server Appliance.
Required only if the ESXi host, on which you want to deploy the
vCenter Server Appliance, has more than one network.
deployment.option tiny The size of the vCenter Server Appliance depending on the size of
your vSphere environment. The value can be:
 tiny
vCenter Server Appliance with an embedded Platform
Services Controller for up to 10 hosts and 100 virtual machines
 small
vCenter Server Appliance with an embedded Platform
Services Controller for up to 100 hosts and 1,000 virtual
machines
 medium
vCenter Server Appliance with an embedded Platform
Services Controller for up to 400 hosts and 4,000 virtual
machines
 large
vCenter Server Appliance with an embedded Platform
Services Controller for up to 1,000 hosts and 10,000 virtual
machines
 management-tiny
vCenter Server Appliance with an external Platform Services
Controller for up to 10 hosts and 100 virtual machines
 management-small
vCenter Server Appliance with an external Platform Services
Controller for up to 100 hosts and 1,000 virtual machines
 management-medium
vCenter Server Appliance with an external Platform Services
Controller for up to 400 hosts and 4,000 virtual machines
 management-large
vCenter Server Appliance with an external Platform Services
Controller for up to 1,000 hosts and 10,000 virtual machines
 infrastructure
Platform Services Controller appliance
image Package included in
the installer ISO file
The filepath to the vCenter Server Appliance installation package.
name – The name of the vCenter Server Appliance.
thin.disk.mode true A Boolean value.
If true, the vCenter Server Appliance is deployed with a thin
mode virtual disk.VMware, Inc. 28
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

database subsection
NOTE Use the database subsection only in the deployment templates to configure the database of the vCenter Server
Appliance. The database configurations for the upgraded vCenter Server Appliance are migrated from the old
vCenter Server Appliance.
For information about or assistance with the external Oracle database configuration, see the Oracle documentation.
type embedded The vCenter Server Appliance database type. The value can be:
 embedded
The vCenter Server Appliance uses the embedded
PostgreSQL database. This database is suitable for small scale
deployments.
 external
The vCenter Server Appliance uses an existing external Oracle
database.
user – The vCenter Server Appliance database user.
Required only if the value of the type parameter is external.
password – The password of the vCenter Server Appliance database user.
Required only if the value of the type parameter is external.
provider – The vCenter Server Appliance database provider. The value can be
only oracle.
Required only if the value of the type parameter is external.
instance – The Oracle database instance name.
Required only if the value of the type parameter is external.
servername – The vCenter Server Appliance database server hostname.
Required only if the value of the type parameter is external.
serverport – Oracle database port number.
Required only if the value of the type parameter is external.
esx subsection
NOTE Required only if you are deploying the vCenter Server Appliance on an ESXi host or if you are upgrading a
vCenter Server Appliance on an ESXi host that is different from the ESXi host on which the old vCenter Server
Appliance is running.
hostname – The IP address or FQDN of the ESXi host on which you want to
deploy the vCenter Server Appliance.
username – A user name with administrative privileges for the ESXi host on
which you want to deploy the vCenter Server Appliance.
password – The password of the ESXi host user with administrative
privileges.
datastore – The name of the datastore on which you want to deploy the
vCenter Server Appliance. The datastore must have at least 15 GB
of free space and must be accessible from the ESXi host on which
you are deploying the vCenter Server Appliance.
vc subsection
NOTE Required only if you are deploying or upgrading the vCenter Server Appliance on a vCenter Server instance.
hostname – The IP address or FQDN of the vCenter Server instance on which
you want to deploy the vCenter Server Appliance.
username – A vCenter Single Sign-On user name with administrative
privileges for the vCenter Server instance on which you want to
deploy the vCenter Server Appliance.
password – The password of the vCenter Single Sign-On user with
administrative privileges for the vCenter Server instance.
Table 8. List of the Configuration Parameters in the target.vcsa Section
Parameter Default DescriptionVMware, Inc. 29
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

datacenter – The name of the vCenter Server datacenter that contains the ESXi
host or DRS cluster on which you want to deploy the vCenter
Server Appliance.
If the datacenter is located in a folder, you must set the path to the
datacenter as a comma-separated list, for example, [“folder1”,
“datacenter”].
vm.folder – A VM folder in the vCenter Server datacenter on which you want
to deploy the vCenter Server Appliance.
datastore – The name of the datastore on which you want to deploy the
vCenter Server Appliance. The datastore must have at least 15 GB
of free space and must be accessible from the vCenter Server
instance on which you are deploying the vCenter Server
Appliance.
target – The ESXi host or DRS cluster on which you want to deploy the
vCenter Server Appliance.
If the ESXi host or DRS cluster is located in a folder, you must set
the path to the ESXi host or DRS cluster as a comma-separated list,
for example, [“folder2”, “esxi-host.badger.com”].
network and temporary.network subsections
NOTE Use the network subsection only in the deployment templates to configure the network of the vCenter Server
Appliance. Use the temporary.network subsection only in the upgrade templates to configure a temporary network
for migrating the data from the old vCenter Server Appliance to the new vCenter Server Appliance. The network
configurations for the upgraded vCenter Server Appliance are migrated from the old vCenter Server Appliance.
hostname – Primary network identity. The value can be an FQDN or IP
address, preferably an 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.
ip.family – Network IP address family. The value can be:
 ipv4
 ipv6
NOTE Do not use the ipv6 option for the temporary.network
subsection in the upgrade templates. You can use the ipv6 value
only for the network subsection in the deployment templates.
mode – Network mode. Use this parameter to choose how to allocate the
IP address of the vCenter Server Appliance. The value can be:
 static
You must set the static IP address and network settings.
 dhcp
A DHCP server is used to allocate the IP address. Use this
option only if the DHCP server is available in your
environment.
ip -Network IP address.
Required only if the value of the mode parameter is static.
Depending on the value of the ip.family parameter, you must
set an IPv4 or IPv6 address.
An IPv4 address must comply with the RFC 790 guidelines.
An IPv6 address must comply with the RFC 2373 guidelines.
dns.servers – A comma-separated list of IP addresses of network DNS servers.
Could be a JSON array, for example, [“1.2.3.4”,
“127.0.0.1”], or a serialized string, for example,
“1.2.3.4,127.0.0.1”.
Table 8. List of the Configuration Parameters in the target.vcsa Section
Parameter Default DescriptionVMware, Inc. 30
Command-Line Deployment and Upgrade of VMware vCenter Server Appliance 6.0 Update 1

prefix – Network prefix length.
Required only if the value of the mode parameter is static.
For IPv4, the value can be between 0 and 32.
For IPv6, the value can be between 0 and 128.
gateway – IP address of the default gateway.
For IPv6, the value can be default.
ports – Port numbers on which the vCenter Server Appliance
communicates with other vSphere components.
os subsection
password – Password for the root user of the Linux operating system of the
vCenter Server Appliance.
NOTE Use only in the deployment templates. When you upgrade
a vCenter Server Appliance, the new vCenter Server Appliance
uses the root password of the old vCenter Server Appliance.
ssh.enable false A Boolean value.
If true, the vCenter Server Appliance is deployed with the SSH
administrator login option enabled.
You can change this setting after the deployment.
ntp.servers – Optional. A comma-separated list of host names or IP addresses of
NTP servers for time synchronization. Could be a JSON array, for
example, [“ntp1.com”. “ntp2.com”], or a serialized string, for
example, “ntp1.com,ntp2.com”.
NOTE Use only in the deployment templates. When you upgrade
a vCenter Server Appliance, the new vCenter Server Appliance
uses the time synchronization settings of the old vCenter Server
Appliance.
time.tool-sync false Optional. A boolean value.
If true, the vCenter Server Appliance is deployed with the
VMware Tools time synchronization option enabled. VMware
Tools synchronizes the time of the appliance with the time of the
ESXi host.
Ignored if you set the ntp.servers parameter.
NOTE Use only in the deployment templates. When you upgrade
a vCenter Server Appliance, the new vCenter Server Appliance
uses the time synchronization settings of the old vCenter Server
Appliance.
platform.service.controller – System name of the Platform Services Controller with which you
want to register the vCenter Server Appliance.
You cannot use an FQDN if the system name of the Platform
Services Controller is an IP address, and the reverse.
Required only if you are deploying a vCenter Server Appliance
with an external Platform Services Controller.
NOTE Use only in deployment templates. When upgrading a

Leave a Comment