Skip to main content

Summary of changes in the REST API for v4.0

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

  • Virtual appliance management

    • (New) POST /FQDNConfigRequest. Modifies the management server’s fully-qualified domain name (FQDN) and DNS configuration on managed devices with IMM2, XCC, and CMM, or validates communication between the management server and managed devices using the set values.
  • Inventory
    • GET /nodes and GET /nodes/{uuid_list}. Added the agentVersion response attribute to return the version of the XClarity management agent that is running on edge devices. Added the deviceDrivers response attribute to return information about device drivers. Added the pciDevices.pciSegmentNumber response attribute to return the PCI segment number, if supported. Added the fipsMode, fruPartNumber, memoryMetrics and securityStateString response attributes under the memoryModules.additionalInfo object. Added os_country, os_language, os_name, and os_version response attributes under the osinfo object. Added the udcVersion response attribute to return the version of the management agent that is installed on edge devices. Changed the value IMM3v1 to XCC for the mgmtProcType attribute. Changed the value XCC to BMC-Primary and value XCC-Backup to BMC-Backup for the firmware.type attribute. Added the securityMode response attribute to return the current security mode that is set on servers with XCC2. Added the systemGuardEnabled response attribute to return whether System Guard is enabled on servers with XCC2. Added the BundleRepoAvailableSpaceInKB response attribute to return the amount of available space in the repository. Added the value XCC2 for the mgmtProcType attribute.
    • PUT /nodes/{uuid}. Added the systemGuardEnabled request attribute to enable or disable System Guard on servers with XCC2.
    • (New) GET /nodes/{uuid}/bundleRepoAvailableSpaceInKB. Returns the amount of space that is available in repository on the baseboard management controller for an ThinkSystem server with XCC2
    • (New) GET /nodes/{uuid}/systemGuardSetting. Returns the System Guard settings for a specific ThinkSystem server with XCC2.
    • (New) PUT /nodes/cryptoSettings. Modifies the current cryptographic settings on specific managed servers with XCC2.
    • (New) PUT /nodes/systemGuardSetting. Enables or disables System Guard on one or more managed servers with XCC2.
    • (New) PUT /nodes/tlsSettings. Enables or disables System Guard on one or more managed servers with XCC2.
    • GET /storage and GET /storage/{uuid_list}. Added the enclosures.canisters.ethPorts and enclosures.canisters.fcPorts response attribute to return information about Ethernet and Fibre Channel ports. Added enclosures.drives.firmwareVersion response attribute to return the firmware version. Changed the enclosures.drives.size, storageNodeCapacityList.blockStorage.available, storageNodeCapacityList.blockStorage.size, and storageNodeCapacityList.blockStorage.used to TiB.
    • GET /switches and GET /switches/{uuid_list}. Deprecated the connectedDrives response attribute.

  • Security

    • (New) GET /certificatePolicy. Returns the certificate policy type for the management server.
    • (New) PUT /certificatePolicy. Modifies the certificate policy type for the management server.
    • GET /cryptoSettings. Added the value TLSv1.3 to the minTlsVersionClient, minTlsVersionOsDeploy, and minTlsVersionServer response attributes.
    • PUT /cryptoSettings. Deprecated the applyToManagedDevices request parameter. To modify the current cryptographic setting for managed servers with XCC2, use PUT /nodes/cryptoSettings. Added the value TLSv1.3 to the minTlsVersionClient, minTlsVersionOsDeploy, and minTlsVersionServer response attributes.
    • The following REST APIs are deprecated.
  • OS deployments
    • PUT /hostPlatforms. Added the osCredentials response attribute to return the OS credentials for the operating system.
    • GET /osdeployment/globalSettings. Added the licenseKeys.win10 and licenseKeys.win11 response attribute to return the license keys for those operating systems. Removed the licenseKeys.win2012r1 response attribute.
    • PUT /osdeployment/globalSettings. Added the licenseKeys.win10 and licenseKeys.win11 request attribute to set license keys for those operating systems. Removed the licenseKeys.win2012r1 request attribute.