Skip to main content

Summary of changes in the REST API for v2.0

Lenovo XClarity Orchestrator v2.0 supports enhancements to the Open REST API.

This documentation includes new methods and parameters that apply to the current XClarity Orchestrator release and later. If you are using an earlier release of XClarity Orchestrator, 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.

  • Resources
    • (New) GET /api/v1/boarding/agentInstaller/{filename}. Download a specific Lenovo Universal Device Client (UDC) agent installation package to the local system.
    • (New) POST /api/v1/boarding/agentInstaller. Create a Lenovo Universal Device Client (UDC) agent installation package for specific ThinkEdge Client devices.
    • (New) GET /api/v1/boarding/devices. Returns a list of all discovered (but not managed) Lenovo devices with or without baseboard management controllers.
    • (New) GET /api/v1/boarding/devices/{id}. Returns information about a specific discovered (but not managed) Lenovo device with or without baseboard management controllers.
    • (New) POST /api/v1/boarding/discovery. Directly discovers manageable Lenovo devices with or without baseboard management controllers by specifying an individual IP addresses or hostname, range of IP addresses, or subnet.
    • (New) GET /api/v1/boarding/discoverySettings. Returns the discovery settings.
    • (New) PUT /api/v1/boarding/discoverySettings. Modifies the discovery settings.
    • (New) POST /api/v1/boarding/management. Directly manage discovered devices with or without baseboard management controllers.
    • (New) DELETE /api/v1/boarding/management. Unmanages devices that are directly managed by the orchestrator server.
    • (New) GET /api/v1/boarding/managementSettings. Returns the UDS Portal credentials.
    • (New) PUT /api/v1/boarding/managementSettings. Retrieves and verifies the UDS Portal credentials, and then save the credentials in the vault.
    • (New) DELETE /api/v1/boarding/managementSettings. Deletes the stored UDS Portal credentials.
    • GET /api/v1/data/devices/{id}. Added the accessStateRecords response attribute to return information about access state records. Added the accountLockoutPeriod response attribute to return the account lockout period. Added the deviceTypeKey response attribute to several objects to return the device-type key. Added the agentVersion response attribute to return the version of the UDC agent that is running on a ThinkEdge Client device. Added the deviceDrivers response attribute to return information about device drivers. Added the manager.id response attribute to return the resource manager ID. Added the diskDriverSensorInfo response attribute to return a list of hard-driver sensor names. Added the drives.encryptionStatus response attribute to return whether disk drive is encrypted. Added drives.hotSpareType response attribute to return the type of hot spare drive. Added the inProcessing response attribute. Added the lanOverUsbPortForwardingModes response attribute to return information about the Ethernet-over-USB port forwarding mode. Added the lastSyncTimestamp response attribute to return the timestamp when this data was last refreshed from the resource manager. Added the lastUpdateTimestamp response attribute to return the timestamp when this data was last updates from the resource manager. Added the m2Presence response attribute to return whether the device contains M.2 storage. Added the onboardPciDevices response attribute to return information about onboard PCI device. Added the osInfo response attribute to return information about the operating system that is installed on the device. Added the osProfiles response attribute to return information about operating-system profile for the server. Added the pattern response attribute to return information about the server-configuration pattern that is assigned to this device. Added the processorIntelSpeedSelect response attribute to return information about the Intel processor speed setting. Added the raidSettings.diskDrives .encryptionStatus response attribute to return whether the disk drive is encrypted. Added the raidSettings.diskDrives .hotSpareType response attribute to return the hot-spare drive type. Added the releaseName response attribute to return the release name. Added the securityMode response attribute to return the security mode. Added the selLog response attribute to return whether the SEL log is supported and present on this server. Added the ssoEnabled response attribute to return whether single sign-on is enabled on the server.
    • (New) GET /api/v1/managers-management/managers. Determines whether the connection to the management hub is active.
    • (New) POST /api/v1/managers-management/managers. Connects to a resource manager.
    • (New) GET /api/v1/managers-management/managers/{id}. Returns information about a specific resource manager.
    • (New) DELETE /api/v1/managers-management/managers/{id}. Deletes a specific resource manager.
    • The following REST APIs will be deprecated in a future release.