Skip to main content

Summary of changes in the REST API for v4.1

Lenovo XClarity Administrator v4.1 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

    • GET /aicc. Added the is_clean response attribute to return information about whether initial setup has not been started on the virtual appliance. Added the hideUnmanagedChassis response attribute to return whether to hide the chassis that are not explicitly managed.
    • (New) GET /aicc/service/sftp/locks. Returns a list of all SFTP service locks.
    • (New) POST /aicc/service/sftp/locks. Starts (enable) the SFTP service for a specific function and acquire an SFTP service lock by creating a lock ID.
    • (New) GET /aicc/service/sftp/locks/{id}. Returns information about a specific SFTP service lock.
    • (New) DELETE /aicc/service/sftp/locks/{id}. Releases a specific SFTP service lock by deleting a specific lock ID and, if all locks are deleted, stop (disable) the SFTP service (unless dbgshell account exist on the Lenovo XClarity Administrator instance).

  • Firmware updates

    • POST /compliancePolicies. The exportWithPackages value was added to the action query parameter to compress the specified compliance policy .xml file and the update files used by the policy into a .zip file and downloads the .zip file to the local system. A job is created to export a compliance policy with or without packages.
    • PUT /compliancePolicies. When the action=import query is specified, a job is created to import the compliance policy with or without packages.

  • Security

    • GET /ldapClientSettings. Added the groupFilters response attribute to return the groups search filters to customize the authentication process when configuring XClarity Administrator with an external LDAP server . Added the userFilters response attribute to return the users search filters to customize the authentication process when configuring XClarity Administrator with an external LDAP server . Added the searchLimit response attribute to return the number of in-search results that can be retrieved in an LDAP search operation using user and group filters. Added the timeout response attribute to return the amount of time, in seconds, to complete an LDAP search operation before timing out.
    • PUT /ldapClientSettings. Added the groupFilter, searchFilter, searchSizeLimit, and timeoutLimit request attributes to manually configure the LDAP search parameters.