GET /managementServer/updates/{fix_id_list}
Use this method to return information or the readme or change history file for a specific update in the management-server updates repository.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/managementServer/updates/
{fix_id_list}
Where {fix_id_list} is the ID of one or more update packages, separated b y a comma. You can specify one or more IDs, separated by a comma. To obtain the update UUID, use the GET /chassis method.
Query parameters
You can specify one of the following query parameters, but both at the same time.
Parameters | Required / Optional | Description |
---|---|---|
key={value} | Optional | Returns the specified type of information for a specific management-server update. This can be one of the following values.
|
filetype={type} | Optional | Returns the readme or change history file. This can be one of the following values.
|
GET https://192.0.2.0/managementServer/updates/
lnvgy_sw_lxca_222-1.1.0_anyos_noarch,lnvgy_sw_lxca_222-1.2.0_anyos_noarch
GET https://192.0.2.0/managementServer/updates/
lnvgy_sw_lxca_222-1.2.0_anyos_noarch?action=status
GET https://192.0.2.0/managementServer/updates/
lnvgy_sw_lxca_222-1.2.0_anyos_noarch?filetype=readme
Request body
None
Response codes
Code | Description | Comments |
---|---|---|
200 | OK | The request completed successfully. |
401 | Unauthorized | The user cannot be authenticated. Authentication has not been provided or has failed. 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. |
500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
Attributes | Type | Description | ||
---|---|---|---|---|
actions | Object | Information about the actions that are supported by the specified update. | ||
action | String | Action to take. This can be one of the following value.
| ||
filetypes | String | File types that are supported by the specified update | ||
keys | Object | Information about the specified key values | ||
key | String | Key values for this request. This can be one of the following values.
| ||
update | Array of objects | Information about the update package | ||
applyable | String | Identifies whether the management-server update can be installed. This can be one of the following values.
| ||
buildNumber | String | Update package build number | ||
buildType | String | Build type | ||
change | String | Identifies whether a change-history file exists in the update package. This can be one of the following values.
| ||
comp | String | Component name that is defined in the XML file
| ||
downloadedsize | Integer | Size of the downloaded update package | ||
errorMsg | String | Error message when downloading | ||
fixid | String | Update package ID | ||
latest | String | Indicates whether the update package is the latest package for the component in the repository for the components. This can be one of the following values.
| ||
name | String | Update package name | ||
origin | String | |||
payload | String | Identifies whether a payload file exists in the update package This can be one of the following values.
| ||
payloadFilename | String | Name of the payload file | ||
percentage | Integer | Download percentage if the package is downloading | ||
readableName | String | Package readable name (for example, such as Lenovo XClarity Administrator Pack for Flex CMM and Switches) | ||
readme | String | Identifies whether a readme file exists in the update package. This can be one of the following values.
| ||
releasedate | String | Date when the update package was released | ||
severity | Integer | Update severity. This can be one of the following values.
| ||
state | String | Package status | ||
supportDownload | String | Indicates whether the update package can be downloaded from the web. This can be one of the following values.
| ||
totalsize | Long | Total size of the update package | ||
version | String | Update package version |
The following example returns information about a specific management-server update.
{
"actions": [
{"action": "acquire"},
{"action": "apply"},
{"action": "delete"}
],
"filetypes": ["change", "readme"],
"keys": [
{"key": "actions"},
{"key": "update"},
{"key": "filetypes"},
{"key": "keys"}
],
"status": {
"result": "informational",
"messages": [{
"id": "FQXHMUP2500I",
"text": "Repository operation completed successfully."
}]
},
"update": [{
"applyable": "false",
"buildNumber": "SWITCH-01",
"buildType": "production",
"change": "true",
"comp": "Utility",
"downloadedsize": 0,
"errorMsg": "",
"fixid": "lnvgy_sw_lxca_cmmswitchrepo1-1.1.0_anyos_noarch",
"latest": "false",
"name": "",
"origin": "lnvgy_sw_lxca_cmmswitchrepo1-1.1.0_anyos_noarch.xml",
"payload": "false",
"payloadFilename": "",
"percentage": 0,
"readableName": "Lenovo XClarity Administrator Repository Pack for Flex CMM and Switches",
"readme": "true",
"releasedate": "2016-04-21",
"severity": 2,
"state": "",
"supportDownload": "true",
"totalsize": 3846590000,
"version": "1.1.0"
}]
}
Attributes | Type | Description | ||
---|---|---|---|---|
field | String | File type. This can be one of the following values.
| ||
fixid | String | UUID of the update package | ||
status | Object | Information about one or more messages | ||
messages | Array of objects | Message | ||
id | String | Identifier of a returned message | ||
text | String | Text associated with the message identifier | ||
result | String | Results of the request. This can be one of the following values.
| ||
value | String | Contents of the file |
The following example returns the readme for the specified update.
{
"field": "readme",
"fixid": "lnvgy_sw_lxca_222-1.2.0_anyos_noarch",
"status": {
"result": "informational",
"messages": [{
"id": "FQXHMUP2500I",
"text": "Repository operation completed successfully."
}],
"value": "Lenovo XClarity Administrator Virtual Appliance 1.2.0
Installation README File
Version 1.2.0 Build 222
(C) Copyright Lenovo Corporation 2015, 2016.
LIMITED AND RESTRICTED RIGHTS NOTICE: If data or software is delivered
pursuant a General Services Administration "GSA" contract, use,
reproduction, or disclosure is subject to restrictions set forth in
Contract No. GS-35F-05925.
CONTENTS
--------
1.0 Overview
2.0 Installation and Setup Instructions
3.0 Web Sites and Support Phone Number
4.0 Trademarks and Notices
5.0 Disclaimer
1.0 Overview
1.1 This README file contains the latest information about installing the
XClarity Administrator virtual appliance update package.
1.2 Limitations:
- This update only applies to the 1.0 and 1.1 release families of
XClarity Administrator.
1.3 Enhancements:
- Refer to the change history file lnvgy_sw_lxca_222-1.2.0_anyos_noarch.chg
for a history of enhancements and fixes.
1.4 Recommendations and Prerequisites for the Updates:
..."
}
}