Upgrading SovLabs plugin from 2017.1.x or earlier


This KB is a very specific walkthrough for upgrading from SovLabs version 2017.1.x or earlier to 2018.3.4. 

For customers using a version of the SovLabs plugin 2017.1.x or earlier, there are some manual steps involved in upgrading to 2018.3.4.  If the manual steps are not done, the Configuration workflow will fail when attempting to recreate the DNS and IPAM profiles.

For customers using vRA 7.2 or earlier

You will need to upgrade the SovLabs Plugin before upgrading vRA. It is recommended to upgrade to SovLabs version 2018.3.4 and then you can upgrade vRA up to vRA 7.5.

Affected Versions

  • SovLabs Plugin versions 2017.1.x and earlier


Please read this document thoroughly before starting

Do ALL the items in the Prerequisites section


vRA versionSovLabs Plugin versionNotes
7.2all up to 2018.3.4vRA 7.2 is no longer in General Support for VMware
7.3all up to 2018.3.4

2019.x has been tested against vRA 7.3 but it it recommended to upgrade to vRA 7.4 or 7.5 before moving to SovLabs

2019.x or later.

7.42018.1.4+2018.1.4 was the first version verfied with vRA 7.4

2018.2.6 was the first version verified with vRA 7.5.  It's recommended to check with VMware support

to get the latest hotfix for vRA 7.5 before upgrading.

Upgrade Path

1. Upgrade SovLabs plugin from 2016.4.2 to 2018.3.4

  • requires a 2018 license key obtained from SovLabs
  • requires 2018.3.4 plugin download link
  • Estimated time, 2-4 hours including an additional hour budgeted for rollback in case of issues.  We recommend a guided install with SovLabs support

2. Upgrade vRA (engage VMware support for assistance with this step)
3. Upgrade SovLabs plugin 2018.3.4 to 2019.x

  • requires a 2019 license key obtained from SovLabs
  • requires 2019.x plugin download link
  • Estimated time, 1-2 hours including an additional hour budgeted for rollback in case of issues

Things you'll need from SovLabs support:

  • Plugin download and license key for 2018.x
  • Plugin download and license key for 2019.x  (if 2019.x is the desired final version)


All of these items must be done before beginning the SovLabs Plugin upgrade for 2017.1.x or earlier to 2018.3.4

1-2 weeks prior

  1. Obtain license keys and plugin download links for 2018.x and 2019.x (if upgrading to 2019.x as final version)
  2. Download the SovLabs Plugin (do this in advance). You will receive a link to download the plugin.  Be sure you have done this ahead of time.  The download links expire 72 hours after generation
  3. Make sure to create test cases that exercise all your integrations, and test them before the upgrade to make sure things are working pre-upgrade.
  4. Be sure to have the administrative username and password for any SovLabs Microsoft Endpoints if applicable. The conversion may not bring this in, so you may need to enter it after the upgrade.

The day of the upgrade

  1. IMPORTANT: Be sure to do all backup steps to create backup snapshots and Custom Resources documented here: http://docs.sovlabs.com/latest/vRA/7.3/getting-started/sovlabs-plugin/upgrade/ .  The only way to revert this upgrade is by reverting back to snapshots, so if you don’t complete this step and something goes wrong, SovLabs will not be able to help you undo the upgrade.
    1. Take a snapshot of vRA (all appliances if clustered)
    2. Take a snapshot of vRO (if using external vRO)
    3. Export all SovLabs vRO Custom Resources created by customer in a vRO package
    4. Please refer to our Backup and Restore from vRO Package PDF

  2. Manual update steps:  Update the names of these Custom Resources in vRA as follows:
    1. Change the Name field in the SovLabs DNS Custom Resource from SovLabs DNS to  SovLabs DNS configuration
      1. in vRA, Go to Design -> Xaas -> Custom Resources
      2. Change the Name field of the SovLabs DNS resource to SovLabs DNS configuration

        The 'c' in 'configuration' is lowercase. This is case-sensitive
        See the screenshot below:

    2. Change the Name field of the SovLabs IPAM Custom Resource from SovLabs IPAM to SovLabs IPAM Profile
      1. in vRA, Go to Design -> Xaas -> Custom Resources
      2. Change the Name field of the SovLabs IPAM resource to SovLabs IPAM Profile

        The 'P' in 'Profile' is uppercaseThis is case-sensitive
        See the screenshot below:

  3. Update the heap size for vRO Configurator

    SSH into all your vRO servers as root and update the heap size in the configurator to 768m  (control center will complain about Out of Memory if this is not done)

    When performing the upgrade to 2019.5 or later, this is not necessary.


    1. vi /var/lib/vco/configuration/bin/setenv.sh
    2. Change -Xmx under MEM_OPTS from 512m to 768m
    3. Save the file
    4. Restart the configurator service

      service vco-configurator restart 

      (takes 2 or 3 minutes to come back)

  4. Validate the vRO cluster nodes are all in "Running" status
    1. Log into vRO Control Center (root login)
    2. go to Orchestrator Cluster Manager
    3. your vRO nodes should all say "Running". If they are not, perform restarts of the vco-server service on any that have a status other than Running.
    4. If any of the nodes still say anything other than "Running" 15 minutes after restarting, DO NOT start this upgrade before contacting SovLabs Support.

STOP!  Did you do all the Prerequisites?

After all the above Prerequisites are finished, you’re ready to install the plugin update.

Upgrade from 2017.1.x or earlier to 2018.2.6

  1. In vRO Control Center, install the vmoapp file (you downloaded in an earlier step)

  2. Restart the vco-server service on all vROs. Wait 5 minutes for service to fully start (tail /var/log/vco/app-server/server.log to make sure)

    service vco-server restart

    Wait until the vRO service is reported as "Running" in /var/log/vco/app-server/server.log <or>  wait until the Node in the vRO Cluster Manager in vRO Control Center shows as "Running"

  3. Log out of your vRO client and log back in

  4. Obtain/validate the Business Group and Tenant you used in your last Configuration run:

    Re-run the token from the last run and note the values for Business Group and Tenant. Just Cancel instead of Submitting.

  5. Run the Configuration Workflow

    Make sure you run the Configuration workflow from the workflow and not from an old token!

    For more information/details about steps 1-4, see our docs site: http://docs.sovlabs.com/latest/vRA/7.5/getting-started/sovlabs-plugin/upgrade/
  6. Delete all the old Licenses from vRA
    1. Go to Items tab in vRA
    2. Click on SovLabs vRA Extensibility Modules -> SovLabs License
    3. For each of the old licenses, highlight it and click Actions, select Delete License.

      In SovLabs versions before 2017.2, there were multiple license keys, one for each integration.  Delete all of these before installing the new "single" license.
  7. Install the 2018.x license provided
    1. in vRA, go to Catalog and request the "Add License - SovLabs Modules" item
    2. paste the contents of the provided license key into the License field and click "Submit"

The vRO workflow for the License is under SovLabs -> License -> vRA ASD -> Add License

Watch the log for the workflow as it runs and make sure it completes successfuly.

Post Upgrade

After the upgrade, you will need to update the credential created for your Microsoft Endpoint.  Conversion of the internal credentials sometimes does not happen for this endpoint. 


Go to Catalog in vRA, Request the Manage Credential Configuration item.

  • Select Update in the Action field
  • Select Microsoft Endpoint in the Filter by Type field
  • Choose the credential from the list.
  • Enter the Username and Password for your Microsoft Endpoint that you recorded in the prerequisites.
  • Click Submit


Once you have completed this, you are ready to re-test your pre-upgrade test cases.

Important Notes

Right after you run configuration workflow, all your SovLabs Catalog items disappear from the Catalog except SovLabs Add License.  Profile and endpoint items will be blank with no information.  Don’t worry. When you install the new license all the items are restored.

Workflow tokens have moved

Starting  with 2017.4, the workflows for the SovLabs modules were no longer under the single vRA Master Integrations token. This is deprecated in favor of Event Broker Subscriptions.

You will find your workflow tokens in vRO under the SovLabs folder:

Naming -> Custom Naming machineRequested

Naming -> Custom Naming machineBuilding

IPAM -> IPAM machineBuilding

IPAM  -> IPAM machineDisposing_POST

DNS -> DNS machineBuilding

DNS -> DNS machineProvisioned

Puppet -> Puppet OSF machineProvisioned

Puppet -> Puppet OSF machineDisposing

ActiveDirectory -> AD machineBuilding

ActiveDirectory -> AD machineProvisioned

ActiveDirectory -> AD machineDisposing


Credentials for Microsoft Endpoints, Puppet profiles, IPAM endpoints, etc. are managed under a new Credential manager.  All existing credentials from the old profiles have been automatically converted to the new format, and these are managed from the Manage Credential Configurations vRA catalog item.

Additional information

Have more questions? Submit a request


Please sign in to leave a comment.