VxRail Lifecycle Management via APIs

In this blog post we are exploring the use of APIs for VxRail Lifecycle Management (LCM) operations. This is particular important when managing multiple clusters or automating upgrades.

I’m using the REST client “Insomnia” in this example, a lightweight client I personally like but any REST client can obviously be used.


The actual upgrade of VxRail using API can be divided in three main sections:


1. Preparation

2. Upgrade

  • Perform VxRail Upgrade

3. Compliance Check

  • Optional post upgrade compliance check


Part 1: Preparation


Initially we will use GET https://vxrailmanager/rest/vxm/v1/system to retrieve the current software version. You need to use basic authentication using your vCenter SSO credentials. As you can see from the output below, the system is running at 7.0.320.



To execute the pre-check, we need to POST the upgrade bundle location and credentials to https://vxrailmanager/rest/vxm/v1/lcm/precheck - see below for details.



The request id returned from the previous command can be used to review the status of the pre-check by executing GET https://vxrailmanager/rest/vxm/v1/requests/idxxx.







Part 2: Run the Upgrade


Once the pre-check is completed successfully, we can proceed to the actual upgrade. In the same fashion as during the pre-check, we need to POST the upgrade bundle location and credentials to https://vxrailmanager/rest/vxm/v3/lcm/upgrade - see below for details.

The process will upgrade VxRail Manager first followed by vCenter Server and ESXi hosts.



The request id returned from the previous command can be used once again to review the status of the pre-check by executing GET https://vxrailmanager/rest/vxm/v1/requests/idxxx.






Once the upgrade is completed successfully, we can use GET https://vxrailmanager/rest/vxm/v1/system to retrieve the current software version. The system is now reflecting version 7.0.372.




Part 3: Compliance Check (Optional)


Optionally, after the upgrade you can create a compliance report for a more in depth report on versioning of all sub-components. We use POST https://vxrailmanager/rest/vxm/v1/cvs/compliance-report followed by retrieving the request id using GET https://vxrailmanager/rest/vxm/v1/requests/idxxx – see below for further details.





So there you have it folks, As you can see leveraging the VxRail API is very straightforward and very powerful for executing activities at any scale. I hope you enjoyed this post. Stay tuned for more VxRail content inbound ! Also comments are open, so as always we appreciate candid feedback.


Ben


#IWORK4DELL


Opinions expressed in this article are entirely my own and may not be representative of the views of Dell Technologies.

1,160 views0 comments