Overriding version of NSX Manager while converging or importing an existing vCenter instance with new NSX Manager deployment

Products

• VMware SDDC Manager / VCF Installer
• VMware Cloud Foundation

Issue/Introduction

When converging or importing an existing vCenter instance that is not connected to NSX, SDDC Manager will automatically deploy a new NSX Manager. The system selects the latest compatible NSX version based on vCenter version. If the install bundle of the required NSX version is not downloaded from the SDDC Manager depot, the pre-check will fail with an error message indicating which NSX version's install image is required and needs to be downloaded. In some cases, users might have a requirement to deploy a different version of NSX Manager than the one determined automatically by the convergence or import workflow.

Environment

VMware Cloud Foundation 5.2.1.2 and above
VMware Cloud Foundation 9.x

Resolution

This workaround allows you to specify custom NSX Manager version to be deployed during converging or importing an
existing vCenter instance. Please check the interoperability matrix here for the compatible VMware NSX Versions for VMware vCenter versions. 

Please check the upgrade compatibility matrix here for VMware NSX if upgrade is planned after the Brownfield import.

Workaround:

1. Go to the SDDC Manger UI or the VCF Ops UI to collect the required NSX build information from the Install Bundle information.
   
   
   
   
   
2. Collect the required vCenter build information from the vCenter VAMI page. Go to vCenter VAMI page https://<vCenter FQDN>:5480. Note the Version and Build in vCenter details section.

   
   

   Format 1:
   Format-1 has to be given in format: Major Version + Build Number
   Example : 8.0.3-24853646 

   Format 2:
   Format-2 has to be given in format: Full Version + Build Number
   Example : 8.0.3.00600-24853646
   
   

3. SSH to the SDDC Manager appliance with the vcf user.

4. Add the following property to both the Domain Manager and Operations Manager properties files:
   
   Property File Locations:
   Domain Manager:  /etc/vmware/vcf/domainmanager/application.properties
Operations Manager: /etc/vmware/vcf/operationsmanager/application.properties

Property Name:
   vcf.nsx.vcenter.compatible.versions=

Property Value Format:
   <NSX_Version_1>:<vCenter_Format-1>,<vCenter_Format-2>...
   
   Example#1:
   If NSX 4.2.3.1 to be deployed for vCenter 8.0.3, then add the below property to the Domainmanager and Operationsmanager property files
   vcf.nsx.vcenter.compatible.versions=4.2.3.1.0-24954727:8.0.3-24853646,8.0.3.00600-24853646
   
   Example#2: 
   
   NOTE: The workaround in VCF 9 does not require the character (-) in the vCenter or NSX version.
   
   If NSX 9.0.1 to be deployed for vCenter 9.0.0 or 9.0.1, then add the below property to the Domainmanager and Operationsmanager property files
   vcf.nsx.vcenter.compatible.versions=9.0.1.0.24952111:9.0.1.0.24957454,9.0.0.0.24755230

   
   
   

5. Restart operationsmanager and domainmanager services on the SDDC Manager.
   
   systemctl restart domainmanager
systemctl restart operationsmanager

Wait for both services to show ACTIVE before proceeding.
   
   curl localhost/domainmanager/about
curl localhost/operationsmanager/about

6. Once both services are running, retry the failed convergence or import operation.

7. Once converging or import is successful, remove the compatible versions property added in Step#1 for both Domainmanager and Operationsmanager
   
   
8.  After removing the property, restart the operationsmanager and domainmanager services.
   
   systemctl restart domainmanager
systemctl restart operationsmanager