VMware introduced the supply of the migration software emigrate an on-prem VMware Cloud Director deployment to VMware Cloud Director service in November 2022.
This weblog will reveal find out how to carry out a migration of an on-prem VMware Cloud Director deployment to VMware Cloud Director service utilizing the migration software supplied by VMware, as defined within the documentation How Do I Migrate from On-premises VMware Cloud Director to VMware Cloud Director service by Utilizing the Migration Instrument.
An outline of the steps required is:
- Setup the necessities to run the migration software if this can be carried out from a Home windows machine
- Create a migration.properties file to learn into the migration software
- Run the migration software (obtain the newest model from https://github.com/vmware-samples/cloud-director-service-migration and extract to the host you’ll carry out the migration from
Conditions:
Earlier than operating the migration software, you have to to put in the required packages for Linux or on Home windows, use a shell equivalent to cygwin to run the software. The beneath directions reveal the migration software on Home windows utilizing cygwin. For a full checklist of the migration software necessities, see Migration Instrument Conditions.
For cygwin set up curl, jq, zip, ssh, scp, sshpass, and md5sum.
Create a Migration Properties File
You don’t have to create the migration.properties file to do a migration, however it makes it simpler to see the info in a file, and if you must rerun the script for any motive, you don’t need to hold retyping the identical data in.
For cygwin, within the default location when opening it, CD to /tmp and create the file referred to as migration.properties. File within the following keys and their corresponding values:
- SITE_NAME – that is the VMware Cloud Director web site title that can be migrated, equivalent to vcd-site1
- SITE_ADMIN_USERNAME – this is able to typically be the administrator account
- IS_APPLIANCE – tells the software whether or not the VMware Cloud Director is an equipment deployment
- CSP_ORG_ID – that is the lengthy org ID of your group within the VMware portal. For extra data on find out how to discover this data, see
- CSP_ORG_REFRESH_TOKEN – that is the token generated within the VMware portal to make use of for operating duties equivalent to associations, migrations, and different features. For extra data, see How Do I Generate an API Token.
- CELL_USERNAME – this is able to typically be root
- DBHOST_USERNAME – this is able to typically be root
Right here is an instance of a migration.properties file crammed out.
|
SITE_NAME=vcd–01a.corp.native SITE_ADMIN_USERNAME=administrator IS_APPLIANCE=true CSP_ORG_ID=abcdef–ghjk–1234–5678–abcdef CSP_ORG_REFRESH_TOKEN=12345678910 CELL_USERNAME=root DBHOST_USERNAME=root |
Be aware that in case your VMware Cloud Director occasion isn’t publicly obtainable, equivalent to a lab occasion for dev/take a look at/UAT, you have to so as to add one extra line to the migration.properties file. The migration software connects to VCD to confirm the model earlier than trying a migration and does so by connecting to the general public DNS title listed within the migration.properties file, so if it isn’t publicly obtainable, add the road beneath with the potential values within the hyperlink. You will want to switch model with the most important model quantity being migrated, equivalent to 10.3, 10.4, and so forth.
UPGRADE_CATEGORY=release-model:manufacturing
Under is an instance of my crammed out migration.properties file with UPGRADE_CATEGORY added because the VCD occasion isn’t publicly obtainable.

In case you run the migration script and it fails for any motive previous the purpose the place it begins studying within the migration.properties file, you have to to open the properties file and re-add the road for UPGRADE_CATEGORY as it will likely be eliminated.
As soon as the migration.properties file has been accomplished, reserve it and open your cygwin bash or which ever bash you’re utilizing. Navigate to the folder that the migration software was extracted to and run the script by operating ./migrate.sh.
The script will immediate you line by line to simply accept the values that had been entered within the migration.properties file, or if the file doesn’t exist, you have to to manually enter the data when prompted.
- Migration properties file discovered, want to reuse. Enter y to learn within the entries from the properties file.
- On-prem VCD web site FQDN title (discovered: name_from_file). Enter y to make use of the worth from the properties file.
- On-prem VCD admin consumer title (discovered: admin_user). Enter y to make use of the worth from the properties file.
- Enter admin password for for on-prem VCD web site name_from_file. Enter the password for the admin account specified to connect with VCD.
- Is VCD name_from_file equipment based mostly? Enter y to specify it’s an equipment based mostly VCD.
- Username for cell name_from_file discovered. Enter y to make use of the consumer specified within the file.
- Enter password for cell name_from_file. Enter the password the account specified to connect with the VCD equipment.
- CSP ORG ID discovered csp_org_from_file. Enter y to make use of the org id specified within the file.
- CSP ORG refresh token discovered token_from_file. Enter y to make use of the CSP org token specified within the file.
- Enter CDI Identify emigrate: This would be the title of the CDS occasion within the VMware portal. Enter the title you would like the CDS to be referred to as. Be aware that this would be the web site title inside VCD as effectively.
Within the display shot beneath, you possibly can see that you’ll want to reply every questions per line.

The migration software will acquire the database data from the VCD database cell, add it to an S3 bucket, create the CDS occasion and import the database dump to the brand new occasion. You may see within the display shot above on the final line within the backside pink field that it’s dumping the database from vcd-01a.corp.native to arrange to add it to an S3 bucket.
As soon as the database dump has accomplished, the script will add the recordsdata to an S3 bucket to be imported to create the CDS occasion. Within the display shot beneath, the highest pink field reveals that the recordsdata had been collected, then efficiently uploaded. The underside pink field reveals that VMware Cloud Director on prem equipment that’s being migrated is put into upkeep mode to keep away from adjustments within the configuration between the migration and the CDS occasion coming on-line.


You need to now see the CDS occasion that was migrated with the title supplied throughout the migration.
