Starting with version 9.7, the VMware Cloud Director appliance includes an embedded PostgreSQL database with a high availability function. You can upgrade the VMware Cloud Director appliance to a later version. You can also migrate your existing earlier version of VMware Cloud Director with an external PostgreSQL database to a VMware Cloud Director environment that consists of VMware Cloud Director appliance deployments version 10.0 or later.

Upgrading the VMware Cloud Director Appliance

For the upgrade of VMware Cloud Director appliance version 9.7 to version 10.1, see Upgrade the VMware Cloud Director Appliance by Using an Update Package.

Starting with VMware Cloud Director 10.0, Microsoft SQL Server databases are unsupported.

When you are upgrading VMware Cloud Director, the new version must be compatible with the following components of your existing installation:
  • The database software you are currently using for the VMware Cloud Director database. For more information, see the Upgrade and Migration Paths table.
  • The VMware vSphere ® release you are currently using.
  • The VMware NSX® release that you are currently using.
  • Any third-party components that directly interact with VMware Cloud Director.

For information about the compatibility of VMware Cloud Director with other VMware products and with third-party databases, refer to the VMware Product Interoperability Matrices at http://partnerweb.vmware.com/comp_guide/sim/interop_matrix.php. If you plan to upgrade your vSphere or NSX components as part of the VMware Cloud Director upgrade, you must upgrade them after the upgrade of VMware Cloud Director. See After You Upgrade VMware Cloud Director.

After you upgrade at least one VMware Cloud Director server, you can upgrade the VMware Cloud Director database. The database stores information about the runtime state of the server, including the state of all VMware Cloud Director tasks it is running. To ensure that no invalid task information remains in the database after an upgrade, you must verify that no tasks are active on any server before you begin the upgrade.

The upgrade also preserves the following artifacts, which are not stored in the VMware Cloud Director database:

  • Local and global properties files are copied to the new installation.
  • Microsoft Sysprep files used for the guest customization support are copied to the new installation.

The upgrade requires sufficient VMware Cloud Director downtime to upgrade all servers in the server group and the database. If you are using a load balancer, you can configure it to a return a message, for example, The system is offline for upgrade.

Starting with version 10.1, service providers and tenants can use the VMware Cloud Director API to test connections to remote servers, and to verify the server identity as part of an SSL handshake. To protect VMware Cloud Director network connections, configure a denylist of internal hosts that are unreachable to tenants who are using the VMware Cloud Director API for connection testing. Configure the denylist after the VMware Cloud Director installation or upgrade and before granting tenants access to VMware Cloud Director. See Configure a Test Connection Denylist.

Important: After upgrading to version 10.1, VMware Cloud Director will always verify certificates for any infrastructure endpoints connected to it. This is due to a change in the way VMware Cloud Director manages SSL certificates. If you do not import your certificates into VMware Cloud Director before the upgrade, the vCenter Server and NSX NSX connections might show failed connection errors due to SSL verification issues. In this case, after upgrading, you have two options:
  1. Run the cell management tool trust-infra-certs command to import automatically all certificates into the centralized certificate store. See Import Endpoints Certificates from vSphere Resources.
  2. In the Service Provider Admin Portal UI, select each vCenter Server and NSX instance, and reenter the credentials while accepting the certificate.

Migrating the VMware Cloud Director Appliance

If your existing VMware Cloud Director server group consists of VMware Cloud Director 9.5 appliance deployments, you can only migrate your environment to a more recent version of the VMware Cloud Director appliance. Use the VMware Cloud Director installer for Linux to upgrade the existing environment only as part of the migration workflow. See Migrating to vCloud Director Appliance.

If your VMware Cloud Director environment uses an external Oracle database or an external Microsoft SQL database, you must migrate to a PostgreSQL database before upgrading to VMware Cloud Director 10.1. For upgrade paths, see Upgrading VMware Cloud Director on Linux.

Upgrade and Migration Paths and Workflows

Source environment Target environment
VMware Cloud Director appliance 10.1 with an embedded PostgreSQL database
VMware Cloud Director 9.0 and 9.1 with an external Oracle database
  1. For VMware Cloud Director 9.0 on Linux, upgrade VMware Cloud Director to version 9.1. See Upgrading vCloud Director.
  2. Migrate the Oracle database to a PostgreSQL database. See Migrate to a PostgreSQL Database.
  3. Upgrade your environment to VMware Cloud Director 10.1 on Linux. See Perform an Orchestrated Upgrade of a VMware Cloud Director Installation or Manually Upgrade a VMware Cloud Director Installation.
  4. Migrate to VMware Cloud Director appliance 10.1. See Migrating VMware Cloud Director with an External PostgreSQL Database to VMware Cloud Director Appliance.
VMware Cloud Director appliance 9.5 with an external PostgreSQL database
  1. Upgrade your environment to VMware Cloud Director 10.1 on Linux. See Perform an Orchestrated Upgrade of a VMware Cloud Director Installation or Manually Upgrade a VMware Cloud Director Installation.
  2. Migrate to VMware Cloud Director appliance 10.1. See Migrating VMware Cloud Director with an External PostgreSQL Database to VMware Cloud Director Appliance.
VMware Cloud Director 9.0, 9.1, and 9.5 on Linux with an external PostgreSQL database
  1. Upgrade your environment to VMware Cloud Director 10.1 on Linux. See Perform an Orchestrated Upgrade of a VMware Cloud Director Installation or Manually Upgrade a VMware Cloud Director Installation.
  2. Migrate to VMware Cloud Director appliance 10.1. See Migrating VMware Cloud Director with an External PostgreSQL Database to VMware Cloud Director Appliance.
VMware Cloud Director 9.0, 9.1, and 9.5 on Linux with an external Microsoft SQL Server database
  1. Upgrade your environment to VMware Cloud Director 9.7 on Linux. See Upgrading vCloud Director.
  2. Migrate to VMware Cloud Director appliance 9.7. See Migrating vCloud Director with an External Microsoft SQL Database to vCloud Director Appliance.
  3. Upgrade your environment to VMware Cloud Director appliance 10.1. See Upgrade the VMware Cloud Director Appliance by Using an Update Package.
VMware Cloud Director 9.7 on Linux with an external Microsoft SQL Server database
  1. Migrate to VMware Cloud Director appliance 9.7. See Migrating vCloud Director with an External Microsoft SQL Database to vCloud Director Appliance.
  2. Upgrade your environment to VMware Cloud Director appliance 10.1. See Upgrade the VMware Cloud Director Appliance by Using an Update Package.
VMware Cloud Director 9.7 on Linux with an external PostgreSQL database
  1. Migrate to VMware Cloud Director appliance 9.7. See Migrating vCloud Director with an External PostgreSQL Database to vCloud Director Appliance.
  2. Upgrade your environment to VMware Cloud Director appliance 10.1. See Upgrade the VMware Cloud Director Appliance by Using an Update Package.
VMware Cloud Director 10.0 on Linux with an external PostgreSQL database
  1. Migrate to VMware Cloud Director appliance 10.0. See Migrating vCloud Director with an External PostgreSQL Database to vCloud Director Appliance.
  2. Upgrade your environment to VMware Cloud Director appliance 10.1. See Upgrade the VMware Cloud Director Appliance by Using an Update Package.
VMware Cloud Director appliance 9.7 and 10.0 with an embedded PostgreSQL database Upgrade your environment to VMware Cloud Director appliance 10.1. See Upgrade the VMware Cloud Director Appliance by Using an Update Package.