Upgrading HCX Manager via API -

While working on an HCX-related request from one of the hyperscalers, I came across an interesting ask: the hyperscaler wants to automate HCX upgrades via API.

After checking HCX’s official API guide and Swagger documentation, I did not find any API to upgrade the HCX Manager appliance. The only available APIs are for upgrading HCX Interconnect appliances.

After searching through internal documentation, I did not find any concrete info, and I decided to explore the Network Inspect option in a browser, which exposes APIs for any operation you trigger from the UI.

In this post, I am demonstrating which API calls are needed for a successful HCX Manager upgrade.

Disclaimer: HCX Manager upgrade APIs are not yet officially supported and will be shipped with the upcoming release of HCX.

Step 1: Check HCX Appliance Current Upgrade Status

Although this step is optional, I would recommend verifying the current upgrade status to ensure you do not accidentally attempt to upgrade an appliance that is already on the target version.

Method: POST 

URL: https://<hcx-manager-fqdn>:9443/api/1.0/appliance-management/jsonrpc/upgrade

Content-Type: application/json

Request Body: 

{
   "method":"getUpgradeStatus",
   "id":"getUpgradeStatus-NSX",
   "params":["NSX"]
}

Method: POST

URL: https://<hcx-manager-fqdn>:9443/api/1.0/appliance-management/jsonrpc/upgrade

Content-Type: application/json

Request Body:

{

"method":"getUpgradeStatus",

"id":"getUpgradeStatus-NSX",

"params":["NSX"]

}

Response Output: From the response output, we can see the status of the upgrade is “NOT_STARTED”

{
   "jsonrpc":"2.0",
   "id":"getUpgradeStatus-NSX",
   "result":{
      "stepsStatus":[
         {
            "upgradeStep":{
               "stepId":"Upgrade",
               "stepLabel":"Upgrade in Progress",
               "description":""
            },
            "status":""
         }
      ],
      "status":"NOT_STARTED",
      "upgradeTime":null,
      "existingBundleFileName":null
   }
}

{

"jsonrpc":"2.0",

"id":"getUpgradeStatus-NSX",

"result":{

"stepsStatus":[

{

"upgradeStep":{

"stepId":"Upgrade",

"stepLabel":"Upgrade in Progress",

"description":""

"status":""

}

"status":"NOT_STARTED",

"upgradeTime":null,

"existingBundleFileName":null

}

Step 2: Upload Upgrade Bundle to HCX Manager Appliance

Method: POST

URL: https://<hcx-manager-fqdn>:9443/api/1.0/appliance-management/ui/upgrade/uploadbundle/NSX

Body: form-data, Key:file, value: 'Upgrade Bundle File Name'

Method: POST

URL: https://<hcx-manager-fqdn>:9443/api/1.0/appliance-management/ui/upgrade/uploadbundle/NSX

Body: form-data, Key:file, value: 'Upgrade Bundle File Name'

The screenshot below shows how to do it via Postman.

And the equivalent curl command for the same

curl --location --request POST 'https://<hcx-manager-fqdn>:9443/api/1.0/appliance-management/ui/upgrade/uploadbundle/NSX' --header 'Content-Type: application/json' --form 'file=@"/C:/Users/Administrator/Downloads/ova/VMware-HCX-Connector-upgrade-bundle-3.5.3-17250318.tar.gz"'

1	curl --location --request POST 'https://<hcx-manager-fqdn>:9443/api/1.0/appliance-management/ui/upgrade/uploadbundle/NSX' --header 'Content-Type: application/json' --form 'file=@"/C:/Users/Administrator/Downloads/ova/VMware-HCX-Connector-upgrade-bundle-3.5.3-17250318.tar.gz"'

Step 3: Verify Upgrade Bundle Info

Method: POST

URL: https://<hcx-manager-fqdn>:9443/api/1.0/appliance-management/jsonrpc/upgrade

Headers: Content-Type: application/json

Request Body: 

{
   "method":"getUpgradeBundleInformation",
   "id":"getUpgradeBundleInformation-NSX",
   "params":["NSX"]
}

Method: POST

URL: https://<hcx-manager-fqdn>:9443/api/1.0/appliance-management/jsonrpc/upgrade

Headers: Content-Type: application/json

Request Body:

{

"method":"getUpgradeBundleInformation",

"id":"getUpgradeBundleInformation-NSX",

"params":["NSX"]

}

Response Output

{
   "jsonrpc":"2.0",
   "id":"getUpgradeBundleInformation-NSX",
   "result":{
      "fromVersion":"3.5.3 Build 17114089",
      "toVersion":"3.5.3 Build 17250319",
      "upgradeBundleDescription":"Upgrade to 3.5.3",
      "preUpgradeQuestionsAnswers":null,
      "upgradeStepsDto":{
         "upgradeSteps":[
            {
               "stepId":"UpgradeStep",
               "stepLabel":"Upgrade Hybridity and Networking manager",
               "description":"Upgrade process for Hybridity and Networking Manager will begin."
            }
         ]
      }
   }
}

{

"jsonrpc":"2.0",

"id":"getUpgradeBundleInformation-NSX",

"result":{

"fromVersion":"3.5.3 Build 17114089",

"toVersion":"3.5.3 Build 17250319",

"upgradeBundleDescription":"Upgrade to 3.5.3",

"preUpgradeQuestionsAnswers":null,

"upgradeStepsDto":{

"upgradeSteps":[

{

"stepId":"UpgradeStep",

"stepLabel":"Upgrade Hybridity and Networking manager",

"description":"Upgrade process for Hybridity and Networking Manager will begin."

}

]

}

Step 4: Trigger Upgrade

Method: POST

URL: https://<hcx-manager-fqdn>:9443/api/1.0/appliance-management/jsonrpc/upgrade

Headers: Content-Type: application/json

Request Body: 

{
   "method":"startUpgradeProcess",
   "id":"startUpgradeProcess-NSX",
   "params":[ "NSX", null ]
}

Method: POST

URL: https://<hcx-manager-fqdn>:9443/api/1.0/appliance-management/jsonrpc/upgrade

Headers: Content-Type: application/json

Request Body:

{

"method":"startUpgradeProcess",

"id":"startUpgradeProcess-NSX",

"params":[ "NSX", null ]

}

Step 5: Verify Upgrade Status

Method: POST 

URL: https://<hcx-manager-fqdn>:9443/api/1.0/appliance-management/jsonrpc/upgrade

Request Body: 

{
   "method":"getUpgradeStatus",
   "id":"getUpgradeStatus-NSX",
   "params":["NSX"]
}

Method: POST

URL: https://<hcx-manager-fqdn>:9443/api/1.0/appliance-management/jsonrpc/upgrade

Request Body:

{

"method":"getUpgradeStatus",

"id":"getUpgradeStatus-NSX",

"params":["NSX"]

}

Response Output: When the upgrade is underway

{
   "jsonrpc":"2.0",
   "id":"getUpgradeStatus-NSX",
   "result":{
      "stepsStatus":[
         {
            "upgradeStep":{
               "stepId":"Upgrade",
               "stepLabel":"Upgrade in Progress",
               "description":"Setting up the slot..."
            },
            "status":"RUNNING"
         }
      ],
      "status":"RUNNING",
      "upgradeTime":null,
      "existingBundleFileName":"VMware-HCX-Cloud-image-3.5.3-17250319"
   }
}

{

"jsonrpc":"2.0",

"id":"getUpgradeStatus-NSX",

"result":{

"stepsStatus":[

{

"upgradeStep":{

"stepId":"Upgrade",

"stepLabel":"Upgrade in Progress",

"description":"Setting up the slot..."

"status":"RUNNING"

}

"status":"RUNNING",

"upgradeTime":null,

"existingBundleFileName":"VMware-HCX-Cloud-image-3.5.3-17250319"

}

Response Output: When the upgrade is completed

{
   "jsonrpc":"2.0",
   "id":"getUpgradeStatus-NSX",
   "result":{
      "stepsStatus":[
         {
            "upgradeStep":{
               "stepId":"Upgrade",
               "stepLabel":"Upgrade in Progress",
               "description":"Upgrade Successful"
            },
            "status":"Upgrade successful"
         }
      ],
      "status":"COMPLETE",
      "upgradeTime":"Wed Dec 23 07:07:43 GMT 2020",
      "existingBundleFileName":"VMware-HCX-Cloud-image-3.5.3-17250319"
   }
}

{

"jsonrpc":"2.0",

"id":"getUpgradeStatus-NSX",

"result":{

"stepsStatus":[

{

"upgradeStep":{

"stepId":"Upgrade",

"stepLabel":"Upgrade in Progress",

"description":"Upgrade Successful"

"status":"Upgrade successful"

}

"status":"COMPLETE",

"upgradeTime":"Wed Dec 23 07:07:43 GMT 2020",

"existingBundleFileName":"VMware-HCX-Cloud-image-3.5.3-17250319"

}

I hope you enjoyed reading this post. Feel free to share this on social media if it is worth sharing 🙂

Upgrading HCX Manager via API

Like this:

Related

Spread the Love

Like this:

Related