Infrastructure Usage
- Using upgrade_ufm_appliance.py package which is part of the UFM software.
- Using UFM REST API infrastructure to control the upgrade.
Upgrade Flow
- Prerequisite:
- The upgrade is performed only on UFM APL.
- The system's initial version is HA master/slave.
- UFM runs on the master system.
- Via REST API, download the UFM appliance image.
- Via REST API, start upgrade using upgrade_ufm_appliance.py tool. The tool performs the following steps:
- Validates cluster.
- Retrieves HA status.
- Verifies installed version.
- Uploads the image to both systems.
- Installs the image on both systems.
- Changes boot location on slave.
- Reloads slave.
- Changes boot location on master.
- Via REST API reload master.
REST API
Upload New UFM APL Image
- Description – allows users to upload a new UFM APL image before applying the upgrade.
- Request URL –
POST /ufmRest/app//images/appliance
- Request Content Type – Application/json
Request Data:
{ "file": " image-ufm_appliance-x86_64-UFMAPL_4.8.0.6_UFM_6.9.0.7-20220502-060753.img" }
- Status Codes
- 202 – ACCEPTED
- 400 – bad request (bad or missing parameters, allowed only 10 images).
Delete UFM APL Image
- Description – allows users to delete an uploaded ufm apl .
- Request URL – DELETE /ufmRest/app/images/appliance/<image_name>
- Request Content Type – Application/json
- Status Codes
- 202 – ACCEPTED
- 404 – NOT_FOUND
Activate UFM APL Upgrade Image
- Description – Allows users to activate upgrade.
- Request URL –
POST /ufmRest/
actions/appliance/upgrade
- Request Content Type – Application/json
Request Data:
{ "name": " image-ufm_appliance-x86_64-UFMAPL_4.8.0.6_UFM_6.9.0.7-20220502-060753.img" }
- Status Codes
- 202 – ACCEPTED
- 400 – BAD REQUEST— Bad or missing parameter
- 404 – NOT_FOUND
Activate UFM APL Master reload
- Description – Allows users to to reload master system.
- Request URL –
POST /ufmRest/
actions/appliance/master_reboot
- Request Content Type – Application/json
- Request Data:
- Status Codes
- 202 – ACCEPTED
Get the List of Available Images
- Description – allows users to get all the availebe images applied on a device.
- Request URL –
GET /ufmRest/app/
images/appliance
- Request Content Type – Application/json
Response Data:
{ image-ufm_appliance-x86_64-UFMAPL_4.8.0.6_UFM_6.9.0.7-20220502-060753.img, image-ufm_appliance-x86_64-UFMAPL_4.8.0.6_UFM_6.9.0.9-20220502-060753.img }
- Status Codes
- 200 – OK
Get Upgrade Status
- Description – get the upgrade status.
- Request URL –
GET /ufmRest/
actions/appliance/upgrade_status
- Request Content Type – Application/json
Response Data:
{ 2022-05-17 07:44:49.374 INFO Going to install image-ufm_appliance-x86_64-UFMAPL_4.8.0.6_UFM_6.9.0.7-20220502-060753.img: image version UFMAPL_4.8.0.6_UFM_6.9.0.7 2022-05-17 07:44:49.381 INFO Validating cluster: 10.209.36.38, 10.209.36.35 2022-05-17 07:44:49.382 INFO Validating cluster: 10.209.36.38, 10.209.36.35 2022-05-17 07:44:49.382 INFO Retrieving ha status info from: 10.209.36.38 2022-05-17 07:44:49.382 INFO Retrieving version info from: 10.209.36.38 2022-05-17 07:45:25.069 INFO Image version for 10.209.36.38 is: UFMAPL_4.8.0.4_UFM_6.9.0.4 2022-05-17 07:45:25.069 INFO Retrieving ufm status info from: 10.209.36.38 2022-05-17 07:45:41.007 INFO Show installed images on: 10.209.36.38 2022-05-17 07:45:47.015 INFO Retrieving ha status info from: 10.209.36.35 2022-05-17 07:45:47.016 INFO Retrieving version info from: 10.209.36.35 2022-05-17 07:45:52.491 INFO Image version for 10.209.36.35 is: UFMAPL_4.8.0.4_UFM_6.9.0.4 2022-05-17 07:45:52.491 INFO Retrieving ufm status info from: 10.209.36.35 2022-05-17 07:46:07.550 INFO Show installed images on: 10.209.36.35 2022-05-17 07:46:13.212 INFO Upgrading cluster: 10.209.36.38, 10.209.36.35 2022-05-17 07:46:13.212 INFO Uploading image /tmp/image-ufm_appliance-x86_64-UFMAPL_4.8.0.6_UFM_6.9.0.7-20220502-060753.img on: 10.209.36.38 2022-05-17 07:46:13.213 INFO Uploading image /tmp/image-ufm_appliance-x86_64-UFMAPL_4.8.0.6_UFM_6.9.0.7-20220502-060753.img on: 10.209.36.35 2022-05-17 07:47:59.972 INFO Installing image on: 10.209.36.38 2022-05-17 07:48:00.964 INFO Installing image on: 10.209.36.35 2022-05-17 07:49:28.473 INFO Changing boot location on: 10.209.36.38 2022-05-17 07:49:33.882 INFO Rebooting device: 10.209.36.38 2022-05-17 07:49:38.744 INFO Reload command 'reload noconfirm' initiated on '10.209.36.38' 2022-05-17 07:53:47.738 INFO Reload command on '10.209.36.38' ended, status: True 2022-05-17 07:53:47.739 INFO Retrieving version info from: 10.209.36.38 2022-05-17 07:53:52.999 INFO Changing boot location on: 10.209.36.35 }
- Status Codes
- 200 – OK
- 404 – NOT_FOUND (log file not found)