GET /updateRepositories/firmware/uxsps
Use this method to return information about all UpdateXpress System Packs (UXSPs) in the repository (for firmware updates and OS device drivers.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/updateRepositories/firmware/uxsps
Query parameters
| Parameters | Required / Optional | Description |
|---|---|---|
| key=export | Required | Downloads a ZIP file that contains the UXSP files to the local system. You must specify filetypes query parameter. Use PUT /updateRepositories/firmware/uxsp?action=export&filetype=<type} to export (collect) the files as a. zip file that you can download using this method. |
| exportRepoFilename={name} | Required | Name of the .zip file To obtain the file name, use the GET /updateRepositories/firmware/status?tasktype=EXPORTREPOSITORY&taskid={job_id} method. The name of the ZIP file is returned by the current parameter in the response body. |
The following example downloads a zip file of UXSPs to the local system.
GET https://192.0.2.0/updateRepositories/firmware/uxsps?key=export&exportRepoFilename=repository20181217142307.zip
| Parameters | Required / Optional | Description |
|---|---|---|
| key={key} | Required | Action to take. This can be one of the following values.
|
| mt={type_list} | Optional | Returns information for one or more specific device types, separated by a comma. If not specified, information about all device types is returned. |
| with={scope} | Optional | UXSP versions. This can be one of the following values.
|
The following example returns information about the most current UXSPs by device type.
PUT https://192.0.2.0/updateRepositories/firmware/uxsps?key=uxsps&with=latest
The following example returns information about UXSPs for specific devices.
PUT https://192.0.2.0/updateRepositories/firmware/uxsps?key=uxspsByMt&mt=7X21,7X15
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. |
| 404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
| 409 | Conflict | There is a conflict with the current state of the resource. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
A subset of the following Attributes are displayed, depending on the specified query parameters.
| Attributes | Type | Description | |||
|---|---|---|---|---|---|
| uxsps | Object | Information about the UXSPs | |||
| uxspsByMt | Object | Information about UXSPs by device type | |||
| current | String | Not used | |||
| downloadednum | Integer | Not used | |||
| downloadedsize | Integer | Not used | |||
| progress | Double | This can be one of the following values.
| |||
| state | String | This can be one of the following values.
| |||
| totalsize | Integer | Not used | |||
| uxsps | Array of objects | Information about the UXSPs | |||
| mt | String | Machine type. | |||
| updates | Array of objects | Information about each update in the UXSP | |||
| applyable | Boolean |
| |||
| buildNumber | String | Update build number, if applicable and available | |||
| buildType | String | Specifies that this update is a GA-level update | |||
| change | Boolean |
| |||
| comp | String | Update component name | |||
| child | Array of strings | Updates fix IDs that belongs to this UXSP | |||
| errorMsg | String | Not used | |||
| fixid | String | Update UUID | |||
| origin | String | Origin file name | |||
| latest | Boolean |
| |||
| name | String | Not used | |||
| payload | Boolean | This can be one of the following values.
| |||
| payloadFilename | String | Name of the update payload | |||
| percentage | Integer | Percentage of the update that is downloaded. If the download is complete, the value is set to 100. | |||
| readableName | String | Name of the README file | |||
| readme | Boolean | This can be one of the following values.
| |||
| rebootRequired | Boolean | This can be one of the following values.
| |||
| releasedate | String | Update release date | |||
| releasedinterval | Integer | Number of months since the firmware update was released | |||
| severity | Integer | Update severity. This can be one of the following values.
| |||
| supportDownload | String | Indicate whether download from Lenovo XClarity Support website is supported.
| |||
| state | String | Not used | |||
| totalsize | Integer | Total size of the update | |||
| version | String | Version of the update | |||
| downloadedsize | Integer | Size of the downloaded update. After the download is complete, this will be the same as totalsize. | |||
The following examples returns firmware-update information for the supported machine types (for example, ?key=uxspsByMt&with=all&payload=&mt=7X21,7X15).
{
"uxspsByMt": {
"current": "",
"downloadednum": 0
"downloadedsize": 1,
"progress": 100,
"state": "complete",
"total": 0,
"totalsize": 1,
"uxsps": [{
"mt": "7X25",
"updates": [{
"applyable": "false",
"buildNumber": "0709",
"buildType": "production",
"change": "true",
"comp": "",
"child": ["lnvgy_fw_hdd_sas-1.26.05_linux_x86-64",
"brcm-lnvgy_fw_cna_18b-oc14-12.0.1141.7-1_linux_x86-64",
"elx-lnvgy_fw_fc_18a-lp3x-11.4.329.13-6_linux_x86-64",
"qlgc-lnvgy_fw_nic_ah-8.35.04-4_linux_x86-64",
"lnvgy_fw_mpt35sas_430-06.01.00.07_linux_x86-64",
"brcm-lnvgy_fw_nic_nxe-212.0.112.0-a_linux_x86-64",
"intc-lnvgy_fw_nic_6.01-3.3d-1.1892.0-b_linux_x86-64",
"mlnx-lnvgy_fw_nic_4.3-1.0.1.0.3_linux_x86-64",
"lnvgy_fw_m2raid_2.3.10.1095_anyos_noarch",
"elx-lnvgy_fw_fc_18a-2.10x6-8_linux_x86-64",
"qlgc-lnvgy_fw_fc_1.90.48-2690-2742.e_linux_x86-64",
"lnvgy_fw_xcc_tei326q-1.80_anyos_noarch",
"lnvgy_fw_uefi_tee124n-1.40_anyos_32-64",
"lnvgy_fw_lxpm_pdl114n-1.30_anyos_noarch"],
"downloadedsize": 37374651,
"errorMsg": "",
"fixid": "lnvgy_utl_uxsp_tesp05p-2.50_platform_32-64",
"latest": "true",
"name": "",
"origin": null,
"payload": "true",
"payloadFilename": "lnvgy_utl_uxsp_tesp05p-2.50_platform_32-64.zip",
"percentage": 100,
"readableName": "Lenovo UpdateXpress System Pack",
"readme": "true",
"rebootRequired": "true",
"releasedate": "2018-11-18",
"releasedinterval": 9,
"severity": 2,
"state": "",
"supportDownload": "true",
"totalsize": 37374651,
"version": "2.50"
}]
},
{
"mt": "7917"
"updates": [{
"applyable": "true",
"buildType": "production",
"buildNumber": "",
"change": "true",
"comp": "",
"child": ["lnvgy_fw_hdd_sas-1.26.05_linux_x86-64",
"brcm-lnvgy_fw_cna_18b-oc14-12.0.1141.7-1_linux_x86-64",
"elx-lnvgy_fw_fc_18a-lp3x-11.4.329.13-6_linux_x86-64",
"qlgc-lnvgy_fw_nic_ah-8.35.04-4_linux_x86-64",
"lnvgy_fw_mpt35sas_430-06.01.00.07_linux_x86-64",
"brcm-lnvgy_fw_nic_nxe-212.0.112.0-a_linux_x86-64",
"intc-lnvgy_fw_nic_6.01-3.3d-1.1892.0-b_linux_x86-64",
"mlnx-lnvgy_fw_nic_4.3-1.0.1.0.3_linux_x86-64",
"lnvgy_fw_m2raid_2.3.10.1095_anyos_noarch",
"elx-lnvgy_fw_fc_18a-2.10x6-8_linux_x86-64",
"qlgc-lnvgy_fw_fc_1.90.48-2690-2742.e_linux_x86-64",
"lnvgy_fw_xcc_tei326q-1.80_anyos_noarch",
"lnvgy_fw_uefi_tee124n-1.40_anyos_32-64",
"lnvgy_fw_lxpm_pdl114n-1.30_anyos_noarch"],
"downloadedsize": 21828067,
"errorMsg": "",
"fixid": "lnvgy_utl_uxsp_w8sp04p-2.50_platform_32-64",
"latest": "true"
"name": "",
"origin": null,
"payload": "true",
"payloadFilename": "lnvgy_utl_uxsp_w8sp04p-2.50_platform_32-64.zip",
"percentage": 100,
"readableName": "Lenovo UpdateXpress System Pack",
"readme": "true",
"rebootRequired": "true",
"releasedate": "2018-08-29",
"releasedinterval": 9,
"severity": 2,
"state": "",
"supportDownload": "true",
"totalsize": 21828067,
"version": "2.50",
}
]
}]
}
}
Give documentation feedback