Summary of changes in the REST API for v3.3

Lenovo XClarity Administrator v3.3 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.
  • Virtual appliance management resources

    • PUT /aicc. Added the tls1.3 value to the tlsMode response attribute.
  • Inventory resources

    • GET /chassis. Added the TLS_13 value to the tlsVersion response attribute. Added the accountLockoutPeriod response attribute to return the account lockout duration, in minutes, after certain login failures occur on the device.
    • GET /chassis/{uuid_list}. Added the TLS_13 value to the tlsVersion response attribute. Added the accountLockoutPeriod response attribute to return the account lockout duration, in minutes, after certain login failures occur on the device.
    • PUT /chassis/{uuid}. Added the TLS_13 value to the tlsVersion response attribute.
    • GET /nodes. Added the TLS_13 value to the tlsVersion response attribute. Added the accountLockoutPeriod response attribute to return the account lockout duration, in minutes, after certain login failures occur on the device.
    • GET /nodes/{uuid_list}. Added the TLS_13 value to the tlsVersion response attribute. Added the accountLockoutPeriod response attribute to return the account lockout duration, in minutes, after certain login failures occur on the device.
    • PUT /nodes/{uuid}. Added the TLS_13 value to the tlsVersion response attribute.
    • (New) GET /nodes/{uuid}/singleSignOn. Returns the single sign-on setting for the specified ThinkSystem or ThinkAgile server.
    • (New) PUT /nodes/{uuid}/singleSignOn. Enables or disables single sign-on for the specified ThinkSystem or ThinkAgile server.
    • (New) GET /nodes/{uuid}/maintenanceHistory. Returns information about the maintenance history for a specific ThinkSystem or ThinkAgile device.
  • Firmware update resources

  • Security resources

    • GET /cryptoSettings. The minimum tls1.2 value supports either TLS v1.2 or v1.3. This applies to the cipherSuite, minTlsVersionClient, minTlsVersionOsDeploy, and minTlsVersionServer response attributes
    • PUT /cryptoSettings. The minimum tls1.2 value supports either TLS v1.2 or v1.3. This applies to the cipherSuite, minTlsVersionClient, minTlsVersionOsDeploy, and minTlsVersionServer request attributes.
    • (New) GET /singleSignOn. Returns the single sign-on setting.
    • (New) PUT /singleSignOn. Enables or disables single sign-on for managed devices.
    • (New) GET /service/country. Returns the current country.
    • (New) PUT /service/country. Modifies the current country.
    • (New) GET /utils/countries. Returns a list of country and region codes.
  • Metrics