The vCloud Director configuration utility configures the cell's network and database connections. You can run it in an interactive mode in which the utility prompts you for required information. Or you can run the utility in an unattended mode that requires you to supply all required information at the command line.

If you want to configure vCloud Director without using an interactive procedure, you can run the configuration utility or the installation file itself as a single command line, specifying unattended operation. When you run either executable this way, you must supply all the information that the system requires as arguments to command-line options.

Important:

Before you run configure, verify that the value of the environment variable VCLOUD_HOME is set to the full pathname of the directory in which vCloud Director is installed. This value is typically /opt/vmware/vcloud-director.

Table 1. Configuration Utility Options and Arguments

Option

Argument

Description

--help (-h)

None

Displays a summary of configuration options and arguments

--config-file (-c)

Path to the global.properties file

Information that you supply when you run the configuration utility is saved in this file. If you omit this option, the default location,/opt/vmware/vcloud-director/etc/global.properties, is used.

--console-proxy-ip (-cons)

IPv4 address, with optional port number

The system uses this address for the vCloud Director console proxy service. For example, 10.17.118.159.

--console-proxy-port-https

Integer in the range 0 - 65535

Port number to use for the vCloud Director console proxy service

--database-certificate-file

Path to a PEM file containing the PostgreSQL database certificate.

If you are using a PostgreSQL database and have set --database-enable-ssl to true, you must provide a pathname to the database server's certificate.

--database-host (-dbhost)

IP address or fully qualified domain name of the vCloud Director database host

See Installing and Configuring a vCloud Director Database.

--database-domain (-dbdomain)

SQL Server database user domain

Optional if database type is sqlserver

--database-instance (-dbinstance)

SQL Server database instance

Optional if database type is sqlserver

--database-name (-dbname)

The database service name

See Installing and Configuring a vCloud Director Database.

--database-password (-dbpassword)

Password for the database user. It can be null.

See Installing and Configuring a vCloud Director Database.

--database-port (-dbport)

Port number used by the database service on the database host

See Installing and Configuring a vCloud Director Database.

--database-enable-ssl

true or false

Configure a PostgreSQLdatabase to require an SSL connection from vCloud Director. Ignored if --database-type is not PostgreSQL.

--database-type (-dbtype)

The database type. Choose one:

  • oracle

  • sqlserver

  • postgres

See Installing and Configuring a vCloud Director Database.

--database-user (-dbuser)

User name of the database user.

See Installing and Configuring a vCloud Director Database.

--enable-ceip

Choose one:

  • true

  • false

This product participates in VMware’s Customer Experience Improvement Program (“CEIP”). Details regarding the data collected through CEIP and the purposes for which it is used by VMware are set forth in the Trust & Assurance Center at http://www.vmware.com/trustvmware/ceip.html. You can use the cell management tool to join or leave VMware's CEIP for this product at any time. See the "Cell Management Tool Reference" in the vCloud Director Administrator's Guide.

--uuid (-g)

None

Generates a new unique identifier for the cell

--primary-ip (-ip)

IPv4 address, with optional port number

The system uses this address for the vCloud Director Web interface service. For example, 10.17.118.159.

--primary-port-http

Integer in the range 0 to 65535

Port number to use for HTTP (insecure) connections to the vCloud Director Web interface service

--primary-port-https

Integer in the range 0 - 65535

Port number to use for HTTPS (secure) connections to the vCloud Director Web interface service

--keystore (-k)

Path to the Java keystore containing your SSL certificates and private keys

Must be a full path name. For example, /opt/keystore/certificates.ks .

--syslog-host (-loghost)

IP address or fully qualified domain name of the syslog server host

Services in each vCloud Director cell log audit messages to the vCloud Director database, where they are preserved for 90 days. To preserve audit messages longer, you can configure vCloud Director services to send audit messages to the syslog utility in addition to the vCloud Director database.

--syslog-port (-logport)

Integer in the range 0 - 65535

The port on which the syslog process monitors the specified server. Defaults to 514 if not specified.

--response-file (-r)

Path to the response file

Must be a full path name. Defaults to /opt/vmware/vcloud-director/etc/responses.properties if not specified. All the information that you supply when running configure is preserved in this file.

Important:

This file contains sensitive information that you must reuse when you add servers to a server group. Preserve the file in a secure location, and make it available only when needed. See Protecting and Reusing the Response File.

--unattended-installation (-unattended)

None

Specifies unattended installation

--keystore-password (-w)

SSL certificate keystore password

SSL certificate keystore password.

Unattended Configuration

The following command line runs an unattended configuration that specifies the same values that are used in the interactive procedure in Configure Network and Database Connections.

[root@cell1 /opt/vmware/vcloud-director/bin]# ./configure -ip 10.17.118.159 -cons 10.17.118.158 \
-dbtype oracle -dbhost 10.150.10.78 -dbname orcl.example.com -dbuser vcloud --enable-ceip true \
-dbpassword P@55word -k /opt/keystore/certificates.ks -w $3Cret -loghost 10.150.10.10 -unattended

For more examples and reference information about the command-line options for configure, see Configuration Utility Reference.

Unattended Installation Specifying a Single IP Address

Important:

If you configure your installation to use a single IP address, as shown in this example, you cannot use the vCloud Director Web Console Public Addresses page to customize the console proxy address.

The following command line runs an unattended configuration that specifies the same configuration values that are used in Configure Network and Database Connections. This example does not use separate IP addresses for the Web interface service and the console proxy services. Instead, the example specifies a single IP address for both services and uses the --primary-port-https and --console-proxy-port-https options to designate a different port for each service.

[root@cell1 /opt/vmware/vcloud-director/bin]# ./configure -ip 10.17.118.159 --primary-port-https 9000 -cons 10.17.118.159 \
--console-proxy-port-https 9010 -dbtype oracle -dbhost 10.150.10.78 -dbname orcl.example.com \
-dbuser vcloud -dbpassword P@55word -k /opt/keystore/certificates.ks -w $3Cret \
-loghost 10.150.10.10 --enable-ceip true -unattended