GET /updateRepositories/firmware
Use this method to return information about firmware in the firmware-updates repository or export firmware-update files to the local system.
Export (collect) the firmware updates as a. zip file using the PUT /updateRepositories/firmware?action=export method. The response body returns the job (task) ID in the taskid parameter.
Ensure that the job for creating the .zip file completed and retrieve the name of the zip file using the GET /updateRepositories/firmware/status?tasktype=EXPORTREPOSITORY&taskid={job_id} method, where {job_id} is the job (task) ID that is returned in the previous step. The response body returns the name of the .zip file in the current parameter.
Download the zip file using the GET /updateRepositories/firmware?action=export&exportRepoFilename=<file_name} method, where {file_name} is the name of the ZIP file that is returned in the previous step.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/updateRepositories/firmware
Query parameters
Parameters | Required / Optional | Description |
---|---|---|
key=export | Required | Downloads a ZIP file that contains the firmware-update and UXSP files to the local system. Use PUT /updateRepositories/firmware?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. |
GET https://192.0.2.0/updateRepositories/firmware?key=export&exportRepoFilename=repository20181217142307.zip
Parameters | Required / Optional | Description |
---|---|---|
updates | Required | Returns all information about firmware updates that are in the repository |
GET https://192.0.2.0/updateRepositories/firmware?updates
Parameters | Required / Optional | Description |
---|---|---|
key={key} | Required | Returns specific information about firmware updates that are in the repository. 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. Note This attribute is applicable only when key is set to |
with={scope} | Optional | Returns information about the firmware-update versions. This can be one of the following values.
Note This attribute is applicable only when key is set to |
payload={boolean} | Optional | Returns information about the firmware-updates. This can be one of the following values.
Note This attribute is applicable only when key is set to |
managedOnly={boolean} | Optional | Returns information about the device types. This can be one of the following values.
Note This attribute is applicable only when key is set to |
GET https://192.0.2.0/updateRepositories/firmware?key=importedUxsps
GET https://192.0.2.0/updateRepositories/firmware?key=supportedMts
GET https://192.0.2.0/updateRepositories/firmware?key=updates&with=latest
GET https://192.0.2.0/updateRepositories/firmware?key=updaesInUXSPByMt&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. |
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
The following parameters are returned when the updates query parameter is specified.
A subset of parameters is returned when the key query parameter is specified. The object that is returned matches the key value that is specified. For example, if you specify ?key=size, only the size parameter is returned.
Attributes | Type | Description | |||
---|---|---|---|---|---|
importDir | String | Import directory for the repository | |||
importedUxsps | Array of objects | Information about UXSPs in the repository | |||
category | String | Device category. This can be one of the following values.
| |||
displayType | String | Machine type that displays in the web interface | |||
inventoryMT | String | Indicates whether devices with this machine type are currently managed by XClarity Administrator. This can be one of the following values.
| |||
name | String | Device name | |||
supportDownload | String | Indicate whether download from Lenovo XClarity Support website is supported. This can be one of the following values.
| |||
type | String | Device type | |||
uxsp | Array of strings | List of UXSPs in the repository that are associated with the device type | |||
isUpdating | String | Identifies whether the firmware repository is being updated. This can be one of the following values.
| |||
lastRefreshed | String | Timestamp of the last catalog refresh operation. | |||
publicKeys | Object | Public keys that are used in this repository for update packages | |||
size | Object | Information about the size of the firmware-updates repository | |||
allotment | Long | Amount of space that is available | |||
freeSpace | Long | Amount of free space | |||
firmwareRepoUsage | Long | Amount of used space, in bytes, in the firmware updates repository | |||
highusage | String | Used capacity. This can be one of the following values.
| |||
selfRepoUsage | Long | Amount of used space, in bytes, in the updates repository | |||
upperLimitSpace | Long | Maximum amount of space, in GB, that can be allocated to the updates repository (including firmware, OS device drivers, and management server updates) The minimum size is 50 GB. The maximum size is dependent on the amount of disk space on the local system. | |||
usedSpace | Long | Amount of used space | |||
windowsDriverRepoUsage | Long | Amount of used space, in bytes, in the Windows device-drivers repository | |||
supportedMts | Object | Information about each device type for which the firmware-updates function is supported | |||
category | String | Device category. This can be one of the following values.
| |||
comp | Array of strings | List of components that are associated with the firmware update (for example, XCC, UEFI, and LXPM) | |||
displayType | String | Device type that displayed in the web interface | |||
inventoryMT | Boolean | Indicates whether devices with this machine type are currently managed by XClarity Administrator. This can be one of the following values.
| |||
name | String | Device name | |||
supportDownload | String | Indicate whether the firmware update can be downloaded from the Lenovo XClarity Support website. This can be one of the following values.
| |||
type | String | Device type | |||
uxsp | Array of strings | List of UXSPs in the repository that are associated with the device type | |||
updates | Array of objects | Information about the updates. | |||
applyable | String | Indicates whether the update can be applied. This can be one of the following values.
| |||
buildNumber | String | The update build number, if applicable and available. | |||
buildType | String | Specifies that this update is a GA-level update | |||
change | String | Indicates whether the change log file exists in the repository for this firmware update. This can be one of the following values.
| |||
comp | Array of strings | List of components that are associated with the firmware update (for example, XCC, UEFI, and LXPM) | |||
downloadedsize | Integer | Size of the firmware-update file that is currently downloaded. After the download is complete, the download size is the same as the total size. | |||
errorMsg | String | Not used | |||
fixid | String | Firmware update UUID | |||
latest | String | Indicates whether the firmware update is the latest version. This can be one of the following values.
| |||
name | String | Not used | |||
OperatingSystemList | Array of strings | List of operating systems that are associated with the firmware update | |||
origin | String | Firmware update file name | |||
payload | String | Indicates whether the payload file exists in the repository for this firmware update. This can be one of the following values.
| |||
payloadFilename | String | Name of the payload file | |||
percentage | Integer | Percentage of the firmware update that is downloaded. If the download is complete, the value is set to 100. | |||
prereq | Array of strings | List of IDs of prerequisite firmware updates | |||
readableName | String | Name of the readme file | |||
readme | String | Indicates whether the readme file exists in the repository for this firmware update. This can be one of the following values.
| |||
rebootRequired | String | Indicates whether the device must be rebooted after installing this firmware update. 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.
| |||
state | String | Not used | |||
supportDownload | String | Indicate whether download from Lenovo XClarity Support website is supported.
| |||
totalsize | Integer | Total size of the update | |||
uxsp | Array of strings | ID of the UXSP in the repository that is associated with the firmware update | |||
version | String | Update version | |||
updatesByMt | Object | Information about updates by device type | |||
current | String | Not used | |||
downloadednum | Integer | Number of updates that are downloaded | |||
downloadedsize | Integer | Size of downloaded updates | |||
jobid | Integer | Job ID that currently is running | |||
progress | Double | Job progress. This can be one of the following values.
| |||
state | String | Job status. This can be one of the following values.
| |||
total | Integer | Total number of updates | |||
totalsize | Integer | Total size of updates | |||
updates | Array of objects | Information about the firmware update | |||
inventoryMT | String | Indicates whether devices with this machine type are currently managed by XClarity Administrator. This can be one of the following values.
| |||
mt | String | Machine type | |||
updates | Array of objects | Information about each firmware update | |||
updatesByMtByComp | Object | Update information organized by machine type and component name | |||
parameter | |||||
value | |||||
comp | |||||
category | |||||
displayType | |||||
inventoryMT | Indicates whether devices with this machine type are currently managed by XClarity Administrator. This can be one of the following values.
| ||||
name | String | ||||
supportDownload | |||||
type | String | ||||
uxsp | |||||
updatesInUXSPByMt | Object | Information about firmware updates, organized by device type and UXSP | |||
current | Integer | ||||
downloadednum | Integer | ||||
downloadedsize | Integer | ||||
jobid | Integer | ||||
progress | Integer | ||||
state | Integer | ||||
total | Integer | ||||
totalsize | Integer | ||||
updates | Array of objects | ||||
status | Object | Information about one or more messages | |||
result | String | Results of the request. This can be one of the following values.
| |||
messages | Array of objects | Information about each message | |||
id | String | Message ID | |||
text | String | Message text associated with the ID |
{
"importDir": "\/opt\/lenovo\/lxca\/data\/updates\/repository",
"status": {
"result": "informational",
"messages": [{
"id": "FQXHMUP2500I",
"text": "Repository operation completed successfully."
}]
}
}
{
"importedUxsps": [{
"category": "server",
"displayType": "4259",
"inventoryMT": "false",
"name": "IBM Flex System x280\/x480\/x880 X6 Compute Node",
"supportDownload": "true",
"type": "4259",
"uxsp": "[ibm_utl_uxsp_n2ib06p-2.30_sles_32-64, ibm_utl_uxsp_n2ib03p-2.50_sles11_32-64]"
},
{
"category": "server",
"displayType": "8738",
"inventoryMT": "false",
"name": "IBM Flex System x240 Compute Node",
"supportDownload": "true",
"type": "8738",
"uxsp": "[ibm_utl_uxsp_b2ib04p-2.50_sles11_32-64, ibm_utl_uxsp_b2ib05p-2.30_sles_32-64]"
},
...,
{
"category": "server",
"displayType": "7X99",
"inventoryMT": "false",
"name": "Lenovo ThinkSystem SR590 Server",
"supportDownload": "true",
"type": "7X99",
"uxsp": "[]"
}],
"status": {
"result": "informational",
"messages": [{
"id": "FQXHMUP2500I",
"text": "Repository operation completed successfully."
}]
}
}
{
"isUpdating": "false"
"status": {
"result": "informational",
"messages": [{
"id": "FQXHMUP2500I",
"text": "Repository operation completed successfully."
}]
},
}
{
"lastRefreshed": "2018-10-31T15:26:52Z",
"status": {
"result": "informational",
"messages": [{
"id": "FQXHMUP2500I",
"text": "Repository operation completed successfully."
}]
}
}
{
"size": {
"allotment": 53687091200,
"firmwareRepoUsage": 34685248291,
"freeSpace": 11407376384,
"highusage": "high",
"selfRepoUsage": 97299561694,
"upperLimitSpace": 158230491136,
"usedSpace": 133804243686,
"windowsDriverRepoUsage": 1819433701
},
"status": {
"result": "informational",
"messages": [{
"id": "FQXHMUP2500I",
"text": "Repository operation completed successfully."
}]
}
}
{
"supportedMts": [{
"category": "server",
"comp": "[Emulex HBA (LPe1600x) Firmware Update for Linux, Online Qlogic NetXtreme II Firmware
Utility, IBM Online SAS\/SATA Hard Disk Drive Update Program - contains Lenovo Drives, Emulex
OCe14xxx UCNA Firmware Update for Linux, Diagnostics, Online Broadcom NetXtreme I Linux Firmware
Utility, Firmware Update for ServeRAID M5115 PSoC3, IBM Flex System FC3172 2-port 8Gb FC
Multiboot Update Package, IMM2, ServeRAID 6GB SAS\/SATA Controller Firmware Update, IBM Online
SAS\/SATA Hard Disk Drive Update Program For Legacy, Mellanox Firmware Update, UEFI, ServeRAID
M1210e SAS\/SATA Controller Firmware Update, Emulex OCe11xxx UCNA Firmware Update for Linux,
QLogic BR series BootCode Update for 16G FC 10G CNA and 4\/8G FC HBA, IBM Flex System FC5172
2-port 16Gb FC Multiboot Update Package, Emulex HBA (LPe1205\/LPe1200x) Firmware Update for
Linux]",
"displayType": "7903",
"inventoryMT": "true",
"name": "IBM Flex System x280\/x480\/x880 X6 Compute Node",
"supportDownload": "true",
"type": "7903",
"uxsp": "[ibm_utl_uxsp_n2ib06p-2.30_sles_32-64, ibm_utl_uxsp_n2ib03p-2.50_sles11_32-64]"
},
{
"category": "server",
"comp": "[Online Qlogic NetXtreme II Firmware Utility, Emulex HBA (LPe1600x) Firmware Update for
Linux, LSI 2004 SAS Controller BIOS and Firmware Update for IBM Flex x440 Compute Node, IBM Online
SAS\/SATA Hard Disk Drive Update Program - contains Lenovo Drives, Emulex OCe14xxx UCNA Firmware
Update for Linux, Diagnostics, Online Broadcom NetXtreme I Linux Firmware Utility, Firmware Update
for ServeRAID M5115 PSoC3, IBM Flex System FC3172 2-port 8Gb FC Multiboot Update Package, IMM2,
ServeRAID 6GB SAS\/SATA Controller Firmware Update, IBM Online SAS\/SATA Hard Disk Drive Update
Program For Legacy, Mellanox Firmware Update, UEFI, QLogic BR series BootCode Update for 16G FC
10G CNA and 4\/8G FC HBA, Emulex OCe11xxx UCNA Firmware Update for Linux, IBM Flex System FC5172
2-port 16Gb FC Multiboot Update Package, Emulex HBA (LPe1205\/LPe1200x) Firmware Update for Linux]",
"displayType": "7917",
"inventoryMT": "true",
"name": "IBM Flex System x440 Compute Node",
"supportDownload": "true",
"type": "7917",
"uxsp": "[ibm_utl_uxsp_cnib06p-3.20_sles_32-64, ibm_utl_uxsp_cnib03p-3.30_sles_32-64]"
},
...,
{
"category": "server",
"comp": "[BIOS and Firmware Update for ThinkSystem 430-x SAS\/SATA 12Gb HBA(06.02.00.02), Broadcom NX-1
Ethernet Firmware Update for Linux, Emulex OCe14xxx UCNA Firmware Update for Linux, Intel
v23.2 Network FW Update Release for Linux, QLogic FastLinQ Ethernet Adapter Firmware Update
for Linux, ThinkSystem RAID 530-x Adapters update BIOS and Firmware for windows and linux,
Firmware Update for ThinkSystem 1610-4P NVMe Switch Card, LXPM, Emulex HBA (LPe3100x) Firmware
Update for Linux, DRVLN, ThinkSystem RAID 930-x xGB Flash PCIe 12Gb Adapters2Gb Adapters update
BIOS and Firmware for windows and linux, ThinkSystem 810-4p NVMe Switch Card Firmware, Lenovo
Online SAS\/SATA Hard Disk Drive Update Program, UEFI, QLogic Fibre Channel HBA Firmware Update
for ThinkSystem, XCC, DRVWN, Emulex HBA (LPe1205\/LPe1200x) Firmware Update for Linux, Broadcom
NX-E Ethernet Firmware Update for Linux, ThinkSystem RAID 730-8i XGB Cache\/Flash PCIe 12Gb
Adapter Update BIOS and Firmware, ThinkSystem M.2 with Mirroring Enablement Kit Firmware Update
For Anyos]",
"displayType": "7X99",
"inventoryMT": "false",
"name": "Lenovo ThinkSystem SR590 Server",
"supportDownload": "true",
"type": "7X99",
"uxsp": "[]"
}],
"status": {
"result": "informational",
"messages": [{
"id": "FQXHMUP2500I",
"text": "Repository operation completed successfully."
}]
}
}
{
"updates": [{
"applyable": "true",
"buildNumber": "1AON20A",
"buildType": "production",
"change": "true",
"comp": "CMM",
"downloadedsize": 0,
"errorMsg": "",
"fixid": "lnvgy_fw_cmm_1aon20a-1.8.0_anyos_noarch",
"latest": "false",
"name": "",
"OperatingSystemList": [],
"origin": null,
"payload": "false",
"payloadFilename": "",
"percentage": 0,
"prereq": ["lnvgy_fw_cmm_1aon16b-1.6.1_anyos_noarch"],
"readableName": "Lenovo Chassis Management Module 2 [CMM2] Firmware 1.8.0 [1AON20A]
18A GA",
"readme": "true",
"rebootRequired": "true",
"releasedate": "2018-06-05",
"releasedinterval": 5,
"severity": 2,
"state": "",
"supportDownload": "true",
"totalsize": 80617000,
"uxsp": [],
"version": "1.8.0"
},
...,
{
"applyable": "true",
"buildNumber": "",
"buildType": "production",
"change": "true",
"comp": "Broadcom NX-E Ethernet Firmware Update for Linux",
"downloadedsize": 0,
"errorMsg": "",
"fixid": "brcm-lnvgy_fw_nic_nxe-20.06.04.02a_linux_x86-64",
"latest": "true",
"name": "",
"OperatingSystemList": [],
"origin": null,
"payload": "false",
"payloadFilename": "",
"percentage": 0,
"prereq": [],
"readableName": "Broadcom NetXtreme-E Ethernet Adapter Firmware Utility for Linux",
"readme": "true",
"rebootRequired": "true",
"releasedate": "2017-08-04",
"releasedinterval": 15,
"severity": 0,
"state": "",
"supportDownload": "true",
"totalsize": 5571000,
"uxsp": [],
"version": "nxe-20.06.04.02a"
}],
"status": {
"result": "informational",
"messages": [{
"id": "FQXHMUP2500I",
"text": "Repository operation completed successfully."
}]
}
}
{
"updatesByMt": {
"current": "",
"downloadednum": 0,
"downloadedsize": 1,
"jobid": -1,
"progress": 100,
"state": "complete",
"total": 0,
"totalsize": 1,
"updates": [{
"inventoryMT": "true",
"mt": "7917",
"updates": [{
"applyable": "true",
"buildNumber": "",
"buildType": "production",
"change": "true",
"comp": "Emulex OCe14xxx UCNA Firmware Update for Linux",
"downloadedsize": 0,
"errorMsg": "",
"fixid": "elx_fw_cna_15a-oc14-10.3.148.0-1_linux_32-64",
"latest": "true",
"name": "",
"OperatingSystemList": [],
"origin": null,
"payloadFilename": "",
"percentage": 0,
"prereq": [],
"payload": "false",
"readableName": "Emulex OCe14xxx UCNA Firmware Update for Linux",
"readme": "true",
"rebootRequired": "true",
"releasedate": "2016-11-22",
"releasedinterval": 23,
"severity": 0,
"state": "",
"supportDownload": "true",
"totalsize": 20640000,
"uxsp": [],
"version": "oc14-10.3.148.0-1"
},
...,
{
"applyable": "true",
"buildNumber": "1.20.02",
"buildType": "production",
"change": "true",
"comp": "LSI 2004 SAS Controller BIOS and Firmware Update for IBM Flex x440 Compute Node",
"downloadedsize": 0,
"errorMsg": "",
"fixid": "ibm_fw_mpt2sas_x440-1.20.02_linux_32-64",
"latest": "true",
"name": "",
"OperatingSystemList": [],
"origin": null,
"payload": "false",
"payloadFilename": "",
"percentage": 0,
"prereq": [],
"readableName": "LSI 2004 SAS Controller BIOS and Firmware Update for IBM Flex x440 Compute Node",
"readme": "true",
"rebootRequired": "true",
"releasedate": "2015-12-03",
"releasedinterval": 35,
"state": "",
"severity": 2,
"supportDownload": "true",
"totalsize": 1436000,
"uxsp": [],
"version": "1.20.02",
}]
}]
},
"status": {
"result": "informational",
"messages": [{
"id": "FQXHMUP2500I",
"text": "Repository operation completed successfully."
}]
}
}
{
"updatesByMtByComp": {
"parameter": "MTS",
"value": [{
"comp": "[Emulex HBA (LPe1600x) Firmware Update for Linux, Emulex OCe14xxx UCNA
Firmware Update for Linux, Lenovo Online SAS\/SATA Hard Disk Drive Update
Program, Intel v22.9 Network FW Update Release for Linux, Diagnostics, Online
Broadcom NetXtreme I Linux Firmware Utility, BIOS and Firmware Update for ServeRAID
M5200 Series SAS\/SATA Controllers, IMM2, Emulex HBA (LPe1205\/LPe1200x) Firmware
Update for Linux, BIOS and Firmware Update for ServeRAID M1200 Series SAS\/SATA
Controllers(24.21.0-0016), Emulex HBA (LPe3100x) Firmware Update for Linux]",
"category": "server",
"displayType": "3633",
"inventoryMT": "false",
"name": "Lenovo System x3250 M6",
"supportDownload": "true",
"type": "3633",
"uxsp": "[]",
},
{
"category": "server",
"comp": "[Online Qlogic NetXtreme II Firmware Utility, Emulex HBA (LPe1600x)
Firmware Update for Linux, Emulex OCe14xxx UCNA Firmware Update for Linux,
Diagnostics, Online Broadcom NetXtreme I Linux Firmware Utility, BIOS and
Firmware Update for ServeRAID M5200 Series SAS\/SATA Controllers, IMM2,
Emulex HBA (LPe3100x) Firmware Update for Linux, Mellanox Firmware Update
(17B), Lenovo Online SAS\/SATA Hard Disk Drive Update Program, Intel v22.9
Network FW Update Release for Linux,QLogic Fibre Channel HBA Firmware Update
for ThinkSystem, Emulex OCe11xxx UCNA Firmware Update for Linux, Emulex HBA
(LPe1205\/LPe1200x) Firmware Update for Linux,BIOS and Firmware Update for
ServeRAID M1200 Series SAS\/SATA Controllers(24.21.0-0016), ServeRAID 6gb
SAS\/SATA Controller Firmware Update]",
"displayType": "6241",
"inventoryMT": "false",
"name": "Lenovo System x3850 \/ x3950 X6",
"supportDownload": "true",
"type": "6241",
"uxsp": "[]",
}]
},
"status": {
"result": "informational",
"messages": [{
"id": "FQXHMUP2500I",
"text": "Repository operation completed successfully."
}]
}
}
{
"updatesInUXSPByMt": {
"current": "",
"downloadednum": 0,
"downloadedsize": 1,
"jobid": -1,
"progress": 100,
"state": "complete",
"total": 0,
"totalsize": 1,
"updates": [{
"inventoryMT": "false",
"mt": "3633",
"updates": [{
"applyable": "true",
"buildNumber": "SAS-1.27.08",
"buildType": "production",
"change": "true",
"comp": "Lenovo Online SAS\/SATA Hard Disk Drive Update Program",
"downloadedsize": 220516907,
"errorMsg": "",
"fixid": "lnvgy_fw_hdd_sas-1.27.08_linux_x86-64",
"latest": "true",
"name": "",
"OperatingSystemList": [],
"origin": null,
"payload": "true",
"payloadFilename": "lnvgy_fw_hdd_sas-1.27.08_linux_x86-64.bin",
"percentage": 100,
"prereq": [],
"readableName": "Lenovo Online SAS\/SATA Hard Disk Drive Update Program",
"readme": "true",
"rebootRequired": "false",
"releasedate": "2018-10-09",
"releasedinterval": 1,
"severity": 2,
"state": "",
"supportDownload": "true",
"totalsize": 220516907,
"uxsp": [],
"version": "sas-1.27.08"
},
...,
]
...,
}]
},
"status": {
"result": "informational",
"messages": [{
"id": "FQXHMUP2500I",
"text": "Repository operation completed successfully."
}]
}
}