Check the Compatibility Between an On-premises VMware Cloud Director Installation and VMware Cloud Director service

To migrate your on-premises VMware Cloud Director installation to VMware Cloud Director service, you need to verify that they are compatible.

Before migrating your on-premises VMware Cloud Director environment to VMware Cloud Director service

Prerequisites

Obtain the VMware Cloud Director hostname, the administrator user name for it, and the password.
Verify that you installed curl, jq, zip, ssh, scp, sshpass and md5sum support packages in your on-premises environment.
Retrieve the database schema version of your on-premises VMware Cloud Director instance.
1. Log in or SSH as root to the OS of the VMware Cloud Director cell.
2. Run the command to retrieve the database schema version.
```
/opt/vmware/vcloud-director/bin/cell-management-tool manage-config -n database.schema.version -l 
```
Exchange the API token that you generated for an access bearer token. Use the bearer token in the Authorization header for the API call. See How Do I Generate an API Token.
Obtain the environment ID (URN). See How Do I Retrieve the List of Environments in My Organization.

Procedure

Prepare a JSON template with the required information for the compatibility check. In the body of the request, include the on-premises VMware Cloud Director host name, administrator user name and password, the VMware Cloud Director service upgrade track and the database schema version.
```
{
  "sourceParams": {
     "vcdHostname": "on-prem-vcd-host-URL",
     "vcdPrincipal": "on-prem-sys-admin-user-name",
     "vcdAuthentication": "on-prem-sys-admin-password",
     "vcdAuthenticationType": "BASIC_AUTH",
     "databaseSchemaVersion": ["1.0","2.0","3.0",["3.1","3.2"]]
   }
}
```
If you leave the value for the VMware Cloud Director service upgrade track blank, the compatibility check runs against the latest major VMware Cloud Director version that is available in VMware Cloud Director service.
Run a POST request with the contents of the JSON template in the body of the request.
```
POST https://operatorUrl/environment/environmentUrn/migration/check-compatibility
```
Here operatorUrl is the operator URL, for example vcdc-operator-prod-us-west-2.vdp.vmware.com.
The response returns information about the compatibility between the on-premises installation and VMware Cloud Director service.
If the on-premises build and VMware Cloud Director service are compatible, make note of the value of the "cdsBuildCategory" parameter of the API response.

Example: Check the compatibility between VMware Cloud Director and VMware Cloud Director service

Run a POST request to the operator URL to check the compatibility between the on-premises VMware Cloud Director build and VMware Cloud Director service.
For example:
```
curl -X POST https://vcdc-operator-prod-us-west-2.vdp.vmware.com/environment/urn:vcdc:environment:12345678-1234-1234-1234-123456789abc/migration/check-compatibility 
  -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer token' 
  --data-raw '''{
  "sourceParams": {
     "vcdHostname": "on-prem-vcd-host-URL",
     "vcdPrincipal": "administrator",
     "vcdAuthentication": "password",
     "vcdAuthenticationType": "BASIC_AUTH",
     "databaseSchemaVersion": ["1.0","2.0","3.0",["3.1","3.2"]] 
}
}''' | jq
```
If the on-premises build is compatible with VMware Cloud Director service, the request returns a response such as:
```
{
   "build" : {
      "compatible" : "true",
      "onpremBuild": "ob-123456",
      "cdsBuildCategory" : "release-10.3:production",
      "cdsBuild" : "ob-123456",
    }
}
```
If the on-premises build is not compatible with VMware Cloud Director service, the request returns a response such as:
```
{
   "build" : {
      "compatible" : "false",
      "onpremBuild": "ob-654321",
      "cdsBuildCategory" : "release-10.3:production",
      "cdsBuild" : "ob-123456",
    }
}
```
If you have entered an invalid upgrade track value for VMware Cloud Director service, the request returns an error message response such as Error: Invalid track or station.
If the on-prem-sys-admin-password that you entered for your on-premises VMware Cloud Director instance is incorrect, the request results in a 401 Unauthorized error message.

What to do next

If the on-premises build and VMware Cloud Director service are compatible, retrieve the on-premises database dump and responses.properties file. See Retrieve the Database Resources from Your On-premises VMware Cloud Director Installation.
If the on-premises build and the VMware Cloud Director service are incompatible, make note of the VMware Cloud Director build in the "cdsBuild" parameter of the API response. Upgrade your on-premises VMware Cloud Director instance to this build and run the compatibility check again. For more information on VMware Cloud Director upgrade, see VMware Cloud Director Installation, Configuration, and Upgrade Guide.