Skip to main content

PUT /api/v1/boarding/discoverySettings

Use this method to modify the discovery settings.

Note
This REST API requires Lenovo XClarity Orchestrator v2.0 or later.

Authentication​

Authentication with username and password is required.

Resource URI​

PUT https://{orchestrator_server_IP}/api/v1/boarding/discoverySettings

Query parameters​

None

Request body​

This PUT request updates the entire resource. To clear a value, set the attribute to null (if applicable). If an array is specified, the entire array is replaced (unless stated otherwise). If an optional attribute is not specified, that attribute is not changed. If an immutable (unchangeable) attribute is specified, it is ignored.

AttributesRequired / OptionalTypeDescription
autoDiscoveryEnabledOptionalBooleanIndicates whether you can automatically discover baseboard management controllers using the SLP discovery method. This can be one of the following values.
  • true. (default) Automatic discovery using SLP is enabled.

    XClarity Orchestrator attempts to discover new devices every 15 minutes and at every user login.

  • false. Automatic discovery using SLP is disabled.
Note
The SLP Discovery setting that you choose in XClarity Orchestrator overrides any SLP discovery setting chosen for Lenovo XClarity Administrator instances that are managed by XClarity Orchestrator.

If the SLP Discovery setting is changed in Lenovo XClarity Administrator, it will be synchronized with XClarity Orchestrator.

offlineDevicesCleanupOptionalBooleanIndicates whether Lenovo XClarity Orchestrator automatically unmanages devices that are offline for a specific amount of time. This can be one of the following values.
  • true. Enables automatic unmanagement of offline devices.

    XClarity Orchestrator checks for offline devices every hour. If a device is offline for at least the amount of time specified by offlineDevicesTimeout, XClarity Orchestrator automatically unmanages that device.

  • false. (default) Disables automatic unmanagement of offline devices.
offlineDevicesTimeoutOptionalBooleanAmount of time, in hours, that devices must be offline before they are automatically unmanaged

This value can be from 1 – 24 hours. The default is 24 hours.

encapsulationEnabledOptionalBooleanIndicates whether encapsulation is enabled during device management. This can be one of the following values.
  • true. Encapsulation is enabled.

    When the global encapsulation setting is enabled and the device supports encapsulation, XClarity Orchestrator communicates with the device (through the resource manager) during the management process to change the device encapsulation mode to encapsulationLite and to change the firewall rules on the device to limit incoming requests to those only from the resource manager that was chosen to manage the device.

    Attention
    If encapsulation is enabled and the resource manager that was chosen to manage the device becomes unavailable before a device is unmanaged, necessary steps must be taken to disable encapsulation to establish communication with the device.
  • false. (default) Encapsulation is disabled.

    The global encapsulation setting is disabled by default. When disabled, the device encapsulation mode is set to normal and the firewall rules are not changed as part of the management process.

registerRequestEnabledOptionalBooleanIndicates whether Lenovo XClarity Administrator resource managers accept discovery requests from a baseboard management controller when the management controller uses DNS to find Lenovo XClarity Administrator instances.
  • true. (default) Management controller can register with Lenovo XClarity Administrator instances as a discovered device.
  • false. Management controller cannot register with Lenovo XClarity Administrator instances as a discovered device.
The following example modifies the discovery settings.
{
   "autoDiscoveryEnabled": true,
   "offlineDevicesCleanup": true,
   "offlineDevicesTimeout": 24,
   "encapsulationEnabled": true,
   "registerRequestEnabled": true
}

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
401UnauthorizedThe user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403ForbiddenThe orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
{message_attributes}variesStatus messages (see Status messages)