In the current release, CSM can only be upgraded using NSX CLI.


This is the third step in upgrading NSX Cloud components. You must have already completed the upgrade of NSX agents and PCGs.

You need root privileges on CSM for this task.


  1. Log in to CSM as root and copy the VMware-NSX-unified-appliance-<version>.nub file into this location: /var/vmware/nsx/file-store/.

    $ssh root@<NSX CSM IP Address>
    root@nsxcsm:~# cp /repository/<version>/CloudServiceManager/nub/VMware-NSX-unified-appliance-<version>.nub /var/vmware/nsx/file-store/


    When you upload the NSX Cloud master upgrade bundle (.mub) file into CSM as described in Upgrade NSX Agents and PCG, the file VMware-NSX-unified-appliance-<version>.nub is extracted into this location: /repository/<version>/CloudServiceManager/nub/.

    You need to copy this file into the location: /var/vmware/nsx/file-store/ to proceed with upgrading CSM.

  2. Log in to the NSX CLI.
    root@nsxcsm:~# nsxcli
  3. Extract and verify the file VMware-NSX-unified-appliance-<version>.nub:
    nsxcsm> verify upgrade-bundle VMware-NSX-unified-appliance-<version>

    Example output:

    Checking upgrade bundle /var/vmware/nsx/file-store/VMware-NSX-unified-appliance-<version>.nub contents
    Verifying bundle VMware-NSX-unified-appliance-<version>.bundle with signature VMware-NSX-unified-appliance-<version>.bundle.sig
    Moving bundle to /image/VMware-NSX-unified-appliance-<version>.bundle
    Extracting bundle payload
    Successfully verified upgrade bundle
    Bundle manifest:
        appliance_type: 'nsx-unified-appliance'
        version: '<upgrade version>'
        os_image_path: 'files/nsx-root.fsa'
        os_image_md5_path: 'files/nsx-root.fsa.md5'
    Current upgrade info:
      "info": "",
      "body": {
        "meta": {
          "from_version": "<current version>",
          "old_config_dev": "/dev/mapper/nsx-config",
          "to_version": "<post-upgrade version>",
          "new_config_dev": "/dev/mapper/nsx-config__bak",
          "old_os_dev": "/dev/xvda2",
          "bundle_path": "/image/VMware-NSX-unified-appliance-<version>",
          "new_os_dev": "/dev/xvda3"
        "history": []
      "state": 1,
      "state_text": "CMD_SUCCESS"
  4. Start the upgrade:
    nsxcsm> start upgrade-bundle VMware-NSX-unified-appliance-<version> playbook VMware-NSX-cloud-service-manager-<version>-playbook

    Example output:

    Validating playbook /var/vmware/nsx/file-store/VMware-NSX-cloud-service-manager-<version>-playbook.yml
    Running "shutdown_csm_svc" (step 1 of 6)
    Running "install_os" (step 2 of 6)
    Running "migrate_csm_config" (step 3 of 6)
    System will now reboot (step 4 of 6)
    After the system reboots, use "resume" to start the next step, "start_csm_svc".
      "info": "",
      "body": null,
      "state": 1,
      "state_text": "CMD_SUCCESS"
    Broadcast message from root@Autoimport-nsx-cloud-service-manager-thin (Fri 2017-08-25 21:11:36 UTC):
    The system is going down for reboot at Fri 2017-08-25 21:12:36 UTC!
  5. Wait for the upgrade to complete. CSM reboots during upgrade, and the upgrade is finalized when the CSM UI restarts after rebooting.
  6. Verify the version of CSM to confirm that it has upgraded:
    nsxcsm> get version
  7. If using a Microsoft Azure account in CSM, you must generate the MSI role names that are new in this release:
    • Follow the steps in the topic Enable CSM to access your Microsoft Azure inventory in the NSX-T Data Center Administration Guide . You must do this when upgrading in order to generate MSI roles for CSM and PCG, and the NSX Cloud Service Principal.

    • Log in to CSM and go to Clouds > Accounts > Azure > Actions > Edit Account and add the Gateway Role Name. The default name is nsx-pcg-role.

What to do next

Follow the steps here for Upgrading NSX-T Data Center.