Skip to main content

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.

ParametersRequired / OptionalDescription
key={value}OptionalReturns the specified type of information for a specific management-server update. This can be one of the following values.
  • all. (default) Returns all information.

  • actions. Returns the actions that are supported by the specified update.

  • keys. Returns the specified key values.

  • filetypes. Returns the file types that are supported by the specified update.

  • update. Returns information about the update package.

filetype={type}OptionalReturns the readme or change history file. This can be one of the following values.
  • changeHistory. Returns the change-history file for the specified management-server update.

  • readme. Returns the readme file for the specified management-server update

The following example returns all information about multiple specific updates.
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
The following example returns the status a specific update.
GET https://192.0.2.0/managementServer/updates/
lnvgy_sw_lxca_222-1.2.0_anyos_noarch?action=status
The following example returns the readme file for a specific update.
GET https://192.0.2.0/managementServer/updates/
lnvgy_sw_lxca_222-1.2.0_anyos_noarch?filetype=readme

Request body

None

Response codes

CodeDescriptionComments
200OKThe request completed successfully.
401UnauthorizedThe user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403ForbiddenThe 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.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body

Table 1. Returns key values.
AttributesTypeDescription
actionsObjectInformation about the actions that are supported by the specified update.
 actionStringAction to take. This can be one of the following value.
  • acquire.

  • apply.

  • delete.

filetypesStringFile types that are supported by the specified update
keysObjectInformation about the specified key values
 keyStringKey values for this request. This can be one of the following values.
  • all. (default) Returns all information.
  • actions. Returns the actions that are available for the specified update.
  • keys. Returns the specified key values.
  • filetypes. Returns the file types that are available for the specified update.
  • update. Returns information about the update package.
updateArray of objectsInformation about the update package
 applyableStringIdentifies whether the management-server update can be installed. This can be one of the following values.
  • true.

  • false.

 buildNumberStringUpdate package build number
 buildTypeStringBuild type
 changeStringIdentifies whether a change-history file exists in the update package. This can be one of the following values.
  • true. A change-history file exists.

  • false. A change-history file does not exist.

 compStringComponent name that is defined in the XML file
  • Utility.

 downloadedsizeIntegerSize of the downloaded update package
 errorMsgStringError message when downloading
 fixidStringUpdate package ID
 latestStringIndicates 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.
  • true.

  • false.

 nameStringUpdate package name
 originString 
 payloadStringIdentifies whether a payload file exists in the update package This can be one of the following values.
  • true. A payload file exists.

  • false. A payload file does not exist.

 payloadFilenameStringName of the payload file
 percentageIntegerDownload percentage if the package is downloading
 readableNameStringPackage readable name (for example, such as Lenovo XClarity Administrator Pack for Flex CMM and Switches)
 readmeStringIdentifies whether a readme file exists in the update package. This can be one of the following values.
  • true. A readme file exists.

  • false. A readme file does not exist.

 releasedateStringDate when the update package was released
 severityIntegerUpdate severity. This can be one of the following values.
  • initialRelease. This is the first release of the firmware.

  • critical. The firmware release contains urgent fixes for data corruption, security, or stability issue.

  • suggested. The firmware release contains significant fixes for problems that you are likely to encounter.

  • noncritical. The firmware release contains minor fixes, performance enhancements, and textual changes.

 stateStringPackage status
 supportDownloadStringIndicates whether the update package can be downloaded from the web. This can be one of the following values.
  • true.

  • false.

 totalsizeLongTotal size of the update package
 versionStringUpdate 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"
}]
}
Table 2. Returns file types that are supported by the specified update.
AttributesTypeDescription
fieldStringFile type. This can be one of the following values.
  • changeHistory. Returns the change-history file for the specified management-server update.
  • readme. Returns the readme file for the specified management-server update.
fixidStringUUID of the update package
statusObjectInformation about one or more messages
 messagesArray of objectsMessage
  idStringIdentifier of a returned message
  textStringText associated with the message identifier
 resultStringResults of the request. This can be one of the following values.
  • success. The request completed successfully.

  • failure. The request failed. A descriptive error message is returned.

valueStringContents 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:
..."
}
}