Skip to main content

Summary of changes in the REST API for v3.5

Lenovo XClarity Administrator v3.5 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

    • (New) GET /authCodes. Returns a list of authorization codes in XClarity Administrator.
    • (New) POST /authCodes. Adds one or more license authorization codes in XClarity Administrator, modifies contact information, and fetch licenses key from the Features on Demand web portal.
    • (New) PUT /authCodes. Manages license keys for one or more authorization codes and modify customer information.
    • (New) PATCH /authCodes. Manages license keys for one or more authorization codes and modify customer information.
    • (New) PUT /authCodes/{code}. Manages license keys for a single authorization code and modify customer information.
    • (New) PATCH /authCodes/{code}. Manages license keys for a single authorization code and modify customer information.
    • (New) GET /licenseCountries. Returns a list of countries and languages that can be for customer information associated with licenses.

  • Inventory resources

    • GET /nodes/{uuid_list}. Added the releaseName response attribute to return the name of the baseboard management controller firmware release. Added the selLog response attribute to return whether the SEL log is supported and present on this server.
    • GET /storage and GET /storage/{uuid_list}. Returns information about tape libraries.

  • Monitoring and event resources

    • GET /bulletinService. Added the end_date response attribute to return the end date in the range of bulletin publish dates. Added the start_date response attribute to return the start date in the range of bulletin publish dates.

    • GET /events/monitors. Added the “BULLETINS value to the eventFilter.filter.categories response attribute.

    • POST /events/monitors. Added the BULLETINS” value to the eventFilter.filter.categories response attribute.

    • GET /events/monitors/{monitor_id} .Added the BULLETINS value to the eventFilter.filter.categories response attribute.

    • PUT /events/monitors/{forwarder_id}. Added the BULLETINS value to the eventFilter.filter.categories response attribute.

  • Metrics

    • POST /metrics_service/metrics/servers. Added the bottom query parameter to return the sum of specified number of bottom (lowest) values during the period. Added the values max and total to the metricsType query parameter. Added the values cpuTemp, inletAirTemp, PowerInputWatts, and function to the metricsType query parameter. Added the energyMetrics.slot response parameter to return the slot located (if applicable).