What’s new in the REST API for v4.3
Lenovo XClarity Administrator v4.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.
- Inventory
- GET /chassis and GET /chassis/{uuid_list}. Added the bladeSlotsLabels response attribute to return a list of labels of all blade slots of the chassis. Added the chassisTypeLocalID response attribute to return the ID that is assigned to each supported chassis type.
- GET /nodes and GET /nodes/{uuid_list}. Added the memoryModules.locationType response attribute to return whether the DIMM is in a slot or bay. Added the networkAdapters response attribute to return information about each network adapter. Added the raidsettings.diskDrives.firmware.updateable response attribute to return whether the drive supports out-of-box updates. Added the securityModePossibleValues response attribute to return a list of possible security-mode values for the server. For the securityMode response attribute, added the High Security values for ThinkSystem V1 and V2 servers. Added the slotLabels response attribute to return a list of labels for the chassis slots that are occupied by this server
- GET /nodes/{uuid}/mediaMount, GET /nodes/{uuid}/mediaMount/{uid}, and PUT /nodes/{uuid}/mediaMount. If the share type is HTTPS, the username and password are passed only to ThinkSystem V4 servers. For all other servers, they are omitted.
- PUT /nodes/cryptoSettings. For the securityMode response attribute, added the High Security values for ThinkSystem V1 and V2 servers.
- OS deployment
- GET /osdeployment/globalSettings. Added the win2025r1 response attribute to return information about volume-license keys for Microsoft Windows 2025 R1.
- PUT /osdeployment/globalSettings. Added the win2025r1 request attribute to configure volume-license keys for Microsoft Windows 2025 R1.
- (New) DELETE /osImages. Remove one or more OS images, OS image-profiles, and custom files (such as device drivers, boot files, configuration settings, installation scripts, software, and unattend files) from the OS images repository.
- DELETE /osImages/{images_list}. This REST API is deprecated. Use DELETE /osImages instead.
- Server configuration
- POST /patterns. Added support for extended V4 port category patterns (see Extended ThinkSystem V4 port pattern attributes).
- GET /patterns/{id}/includeSettings. Added the ExtendedV4Port value for server_template.type response attribute. Added support for extended V4 port category patterns in the sub_templates response attribute.
- Remote control
- GET /remoteaccess/remoteControl. For System x (IMM2), a ZIP file is returned. Extract the zip file, and then run the JAR file to start the remote-control application on the local system. You must provide IP address, username, and password for XClarity Administrator.
Give documentation feedback