Lenovo XClarity Administrator v2.0.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.
Discovery and management resources
(New) GET /ipSettings. Retrieves information about whether XClarity Administrator checks for duplicate IP addresses in the same subnet.
(New) PUT /ipSettings. Enables or disables checking for duplicate IP addresses in the same subnet.
Inventory
GET /chassis and GET /chassis/{uuid_list}. Added the publicAccess response parameter to indicate whether the device can be accessed by all role groups. Added the roleGroups response parameter to retrieve the list of role groups that are permitted to view and manage this device. Added the userDefineName response parameter to retrieve the name of the device that was defined by the user.
Deprecated the activeAlerts response parameters. Use GET /events/activeAlerts/{uuid} instead.
Resource-group resources
Configuration Pattern resources
Operating-system deployment resources
Success,
Warning,and
Errordeployment status values for the deployStatus response parameter. Added the unattendFileId request parameter to specify the ID of the unattend file to be used in the OS deployment.
Added the imageType=OSPROFILE and id query parameters to return only information for a specified OS-image profile.
Added the configFileDiskUsage, scriptFileDiskUsage, softwareFileDiskUsage, and unattendFileDiskUsage response parameters to return information about disk space that is used by the custom files.
Added the customConfigFiles response parameter to return information about configuration-settings files that are imported and available to the OS image profiles, including a list of custom macros that are defined for the custom configuration settings file.
Added the customSoftware response parameter to return information about software payloads that are imported and available to the OS image profiles.
Added the installScriptFiles response parameter to return information about installation-script-files are imported and available to the OS image profiles.
Added the osBuildId response parameter to return the build number of the operating-system image.
Added the customConfigOptions, customSoftwareOptions, installScriptOptions, and unattendOptions response parameters to return a list of IDs for each custom file file that is associated with the OS-image profile.
Added the predefinedMacros response parameter to return a list of predefined macros that are associated with this customized OS-image profile.
Added the allowCustomConfigSchema, allowCustomInstallScriptFile, allowCustomSoftware, and allowCustomUnattendFile response parameter to indicate whether the specified image supports specific custom files.
Added the type response parameter to return information about the OS image type.
Added the unattendFiles response parameter to return information about unattend files are imported and available to the OS image profiles. Added new request body parameters to specify content and metadata to import unattend or configuration-settings files without creating a job.
Monitoring and event resources
Added the escapeHTML query parameter to return special characters (for example, ") in place of escape characters in the message.
Added the outputFormat query parameter to return Information about all active alerts (by default) or the number of active alerts per resource group.
Added the groupUID query parameter to specify the resource groups for which you want alert counts. Added the uids query parameter to return task information only for one or more specific groups and devices.
Added the args response parameter to return a list of dynamic arguments in the event message string.
Added the componentIdentifierText response parameter to return the component description.
Added the failFRUs response parameter to return a list of FRU numbers for FRUs associated to the fault.
Added the failSNs response parameter to return a list of FRUs associated to the fault
Added the groupName and groupUUID response parameters to identify which resource groups the source of the alert belongs.
Added the <group_UUID> response parameter to return the alert counts per resource group.
Added the severityText response parameter to return the severity text.
Added the following additional response parameters: bayText, chassisText, eventSourceText, failFRUNames, failFRUPartNumbers, failFRUUUIDs, fruSerialNumberText, isManagement, msgID, serviceabilityText, systemFruNumberText, systemSerialNumberText, systemText, systemTypeModelText, systemTypeText, and typeText.
Added the escapeHTML query parameter to return special characters (for example, ") in place of escape characters in the message.
Added the uids query parameter to return task information only for one or more specific groups and devices.
Added the componentIdentifierText response parameter to return a list of dynamic arguments in the event message string.
Added the componentIdentifierText response parameter to return the component description.
Added the failFRUs response parameter to return a list of FRU numbers for FRUs associated to the fault.
Added the failSNs response parameter to return a list of FRUs associated to the fault
Added the groupName and groupUUID response parameters to identify which resource groups the source of the alert belongs.
Added the severityText response parameter to return the severity text.
Added the following additional response parameters: bayText, chassisText, eventSourceText, failFRUNames, failFRUPartNumbers, failFRUUUIDs, fruSerialNumberText, isManagement, msgID, serviceabilityText, systemFruNumberText, systemSerialNumberText, systemText, systemTypeModelText, systemTypeText, and typeText.
Added the format query parameter to specify what type of information is returned. Added the id query parameter to specify the remote event recipient ID when the content of the recipient is to be returned.
Added response parameters to specify the information about new OMS and REST recipients.
For email recipients:
Added the authenticationEmail response parameter to specify the authentication type for email (SMTP) server recipients.
Added the connectionEmail response parameter to specify the Connection type to secure connection to the email (SMTP) server recipients.
Added the enable response parameter to specify whether the recipient is enabled.
Added categories, severity and type response parameters to specify the event filter information.
Added the id response parameter to specify the recipient ID.
Added the ignoreExcluded response parameter to specify whether to disable the forwarding of excluded events.
Added the outputFormat response parameter to specify the output format for the forwarded event.
Added the requestTimeout response parameter to specify the amount of time, in seconds, that a remote event recipient has to forward events before the request times out.
Added the scheduler response parameter to specify the times and days when you want the specified events to be forwarded.
Added the senderDomain response parameter to specify the sender domain for email (SMTP) server recipients.
Added the senderUserName response parameter to specify the sender name for email (SMTP) server recipients.
For SNMP recipients
Added the authPasswordSet response parameter to specify the the password string.
Added the enable response parameter to indicate whether the recipient is enabled.
Added catetories , severity and type response parameters to specify the event filter information.
Added the id response parameter to specify the recipient ID.
Added the ignoreExcluded response parameter to specify whether to disable the forwarding of excluded events.
Added the outputFormat response parameter to specify the output format for the forwarded event.
Added the privacyPasswordSet response parameter to return the privacy password.
Added the oms_log_analytics and rest values for protocol response parameter.
Added the requestTimeout response parameter to specify the amount of time, in seconds, that a remote event recipient has to forward events before the request times out.
Added the scheduler response parameter to specify the times and days when you want the specified events to be forwarded.
For syslog recipients
Added catetories, severity and type response parameters to specify the event filter information.
Added the id response parameter to specify the recipient ID.
Added the ignoreExcluded response parameter to specify whether to disable the forwarding of excluded events.
Added the outputFormat response parameter to specify the output format for the forwarded event.
Added the oms_log_analytics and rest values for protocol response parameter.
Added the requestTimeout response parameter to specify the amount of time, in seconds, that a remote event recipient has to forward events before the request times out.
Added the scheduler response parameter to specify the times and days when you want the specified events to be forwarded.
Added response parameters to return information about new OMS and REST recipients.
For email recipients:
Added the authenticationEmail request parameter to specify the authentication type for email (SMTP) server recipients.
Added the connectionEmail request parameter to specify the Connection type to secure connection to the email (SMTP) server recipients.
Added the enable request parameter to specify whether the recipient is enabled.
Added catetories, severity and type request parameters to return event filter information.
Added the ignoreExcluded request parameter to specify whether to disable the forwarding of excluded events.
Added the outputFormat request parameter to specify the output format for the forwarded event.
Added the requestTimeout request parameter to specify the amount of time, in seconds, that a remote event recipient has to forward events before the request times out.
Added the scheduler request parameter to specify the times and days when you want the specified events to be forwarded.
Added the senderDomain request parameter to specify the sender domain for email (SMTP) server recipients.
Added the senderUserName request parameter to specify the sender name for email (SMTP) server recipients.
For SNMP recipients
Added the authPasswordSet request parameter to return the password string.
Added the enable request parameter to indicate whether the recipient is enabled.
Added catetories, severity and type request parameters to return event filter information.
Added the ignoreExcluded request parameter to specify whether to disable the forwarding of excluded events.
Added the outputFormat request parameter to specify the output format for the forwarded event.
Added the privacyPasswordSet request parameter to return the privacy password.
Added the oms_log_analytics and rest values for protocol request parameter.
Added the requestTimeout request parameter to specify the amount of time, in seconds, that a remote event recipient has to forward events before the request times out.
Added the scheduler request parameter to specify the times and days when you want the specified events to be forwarded.
For syslog recipients
Added catetories, severity and type request parameters to return event filter information.
Added the ignoreExcluded request parameter to specify whether to disable the forwarding of excluded events.
Added the outputFormat request parameter to specify the output format for the forwarded event.
Added the oms_log_analytics and rest values for protocol request parameter.
Added the requestTimeout request parameter to specify the amount of time, in seconds, that a remote event recipient has to forward events before the request times out.
Added the scheduler request parameter to specify the times and days when you want the specified events to be forwarded.
Job management resources
Remote control resources
Service and support resources
Security resources
Energy metrics
The following methods were deprecated in earlier releases and are no longer included in the documentation.
Inventory resources