Summary of changes in the REST API for v3.2.0

Lenovo XClarity Administrator v3.2.0 supports enhancements to the Open REST API.

This documentation includes new methods and parameters that apply to the current XClarity Administrator release and later. If you are using an earlier release of XClarity Administrator, you can use the REST API Reference PDF for a list of methods and parameters that apply to that specific release. To find PDFs for the release that you need, see PDF files.

The following methods were added or updated in this release.
  • Management-server update resources

    • GET /managementServer/updates. Added the firmwareRepoUsage response parameter to return the amount of used space in the firmware updates repository. Added the selfRepoUsage response parameter to return the amount of used space in the XClarity Administrator updates repository. Added the windowsDriverRepoUsage response parameter to return the amount of used space in the Windows device-drivers repository.
  • Discovery and management resources

    • POST /manageRequest. Added the identityManagementIdentityId response parameter to return the ID of the identity in the Identity-management system that is associated with this device. Added the identityManagementSystem response parameter to return the identity-management system type. Added the identityManagementSystemEnabled response parameter to return whether an identity-management system (such as CyberArk) is configured and enabled .
  • Inventory resources

    • GET /nodes and GET /nodes/{uuid_list}. Added the raidSettings.diskDrives.hotSpareType response parameter to return the type of hot spare drive. Added the processors.tdpWatts response parameter to return the thermal design power usage. Added the memoryModules.operatingMemoryMode response parameter to return the memory operating mode.
    • GET /storage and GET /storage/{uuid_list}. Added the firmware.version response parameter to return the firmware version. Added the firmware.versionType response parameter to return the firmware type.
    • (New) GET /nodes/{uuid}/isRAIDReady. Returns the hardware RAID status for a specific server.
  • Firmware update resources

    • GET /compliancePolicies. Added the details.components.rule response attribute to return information about the alert rule for the firmware component. Added the custom value for details..rule response attribute to follow the detailed rules of each firmware component.
    • GET /updateRepositories/firmware. Added the firmwareRepoUsage response parameter to return the amount of used space in the firmware updates repository. Added the selfRepoUsage response parameter to return the amount of used space in the XClarity Administrator updates repository. Added the windowsDriverRepoUsage response parameter to return the amount of used space in the Windows device-drivers repository.
  • Security resources