GET /managementServer/updates

Use this method to return information about all updates in the management-server updates repository.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/managementServer/updates

Query parameters

Parameters Required / Optional Description
key={value} Optional Returns the specified type of information for all management-server update-related tasks that are in progress. This can be one of the following values.
  • all. (default) Returns all information.
  • currentVersion. Returns the current version of XClarity Administrator.
  • history. Returns the history of management-server updates.
  • importDir. Returns the directory for the management-server updates repository.
  • size. Returns the repository size (in bytes).
  • updates. Returns information about all updates packages.
  • updatedDate. Returns the date when the last update was performed.

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
history Object Information about the management-server update history
  buildNumber String Update build number
  dateApplied String Timestamp when the update was applied
  description String Short description of the update
  detailInfo String Detailed description of the update
  fileName String Update file name
  flavor String Type of update. This can be one of the following values.
  • base install. The initial installation of XClarity Administrator code changes.

  • license enablement. License for full-function entitlement.

  • patch. XClarity Administrator code changes, including new releases and fix packs

  • supplemental pack. Firmware-update repository packs, which contain firmware update packages for all manageable devices. When imported and applied, the firmware updates are added in the firmware-updates repository.

  installationFailedDate String Timestamp when the update was applied and failed
  version String XClarity Administrator version
importDir String Directory of the management-server updates repository
size Object Information about the size of the management-server updates repository
  allotment Long Amount of space that is reserved for the repository
  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.
  • high. 85% capacity or higher
  • medium. 50% capacity or higher
  • low. 49% or lower
  selfRepoUsage Long Amount of used space, in bytes, in the XClarity Administrator 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
updatedDate String Timestamp for the last applied update
updates Array of objects Information about the latest applied update
  applied String Applied status. This can be one of the following values.
  • applied. The update was successfully applied.

  • not applied. The update was not applied.

  buildNumber String Update build number
  fixid String ID of the update package
  flavor String Type of update. This can be one of the following values.
  • base install. The initial installation of XClarity Administrator code changes.

  • license enablement. License for full-function entitlement.

  • patch. XClarity Administrator code changes, including new releases and fix packs

  • supplemental pack. Firmware-update repository packs, which contain firmware update packages for all manageable devices. When imported and applied, the firmware updates are added in the firmware-updates repository.

  id Integer ID of the update
  payload String File name of the update package
  readableName String Detailed description of the update
  rebootRequired Boolean Identifies whether the update requires the management server to be rebooted. This can be one of the following values.
  • true. The update requires a reboot.

  • false. The update does not require a reboot.

  releasedate String Date when the update was released
  size Long Size of the update package file
  status String Update-package status. This can be one of the following values.
  • acquired. The entire update package is stored in the repository.

  • not acquired. The update package was not downloaded to the repository.

  title String Name of the update
  version String Version of the update
version String Version of the currently installed updated
The following example is returned if the request is successful.
{
   "history": [{
      "buildNumber": "173",
      "dateApplied": "06-16-2016-19:04",
      "description": "base install",
      "detailInfo": "Base Install",
      "fileName": "Base Install",
      "flavor": "base install",
      "installationFailedDate": "06-16-2016-19:04",
      "version": "1.2.0"
   },
   {
      "buildNumber": "SWITCH-01",
      "dateApplied": "06-16-2016-19:21",
      "description": "TBD",
      "detailInfo": "Lenovo XClarity Administrator Repository Pack for Flex CMM and Switches",
      "fileName": "lnvgy_sw_lxca-fw-cmm-switch-repository-pack_1-1.2.0_anyos_noarch",
      "flavor": "supplement pack",
      "installationFailedDate": "06-16-2016-19:21",
      "version": "Version 1.2.0-[SWITCH-01-1.2.0]-"
   }],
   "importDir": "\/opt\/lenovo\/lxca\/data\/updates\/self",
   "size": {
      "allotment": 53687091200,
      "firmwareRepoUsage": 34685248291,
      "highusage": "high",
      "selfRepoUsage": 97299561694,
      "upperLimitSpace": 158230491136,
      "usedSpace": 133804243686,
      "windowsDriverRepoUsage": 1819433701
   },
   "updatedDate": "06-22-2016-19:47",
   "updates": [{
      "applied": "Applied",
      "buildNumber": "SWITCH-01",
      "datainfo": "Info",
      "fixid": "lnvgy_sw_lxca-fw-cmm-switch-repository-pack_1-1.2.0_anyos_noarch",
      "flavor": "supplement pack",
      "id": 1,
      "payload": "lnvgy_sw_lxca-fw-cmm-switch-repository-pack_1-1.2.0_anyos_noarch.tgz",
      "readableName": "Lenovo XClarity Administrator Repository Pack for Flex CMM and Switches",
      "releasedate": "2016-06-03",
      "size": 4091905320,
      "status": "Acquired",
      "title": "lnvgy_sw_lxca-fw-cmm-switch-repository-pack_1-1.2.0_anyos_noarch",
      "version": "Version 1.2.0-[SWITCH-01-1.2.0]-"
   }],
   "version": "1.2.0"
}