Skip to main content

GET /api/v1/boarding/discoverySettings

Use this method to return the discovery settings.

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

Authentication​

Authentication with user name and password is required.

Resource URI​

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

Query parameters​

None

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).

AttributesTypeDescription
autoDiscoveryEnabledBooleanIndicates 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.
encapsulationEnabledBooleanIndicates 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.

offlineDevicesCleanupBooleanIndicates 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.
offlineDevicesTimeoutBooleanAmount 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.

registerRequestEnabledBooleanIndicates 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.
_linksObjectResource URI (see Links)
The following example is returned if the request is successful.
{
   "autoDiscoveryEnabled": true,
   "offlineDevicesCleanup": true,
   "offlineDevicesTimeout": 24,
   "encapsulationEnabled": true,
   "registerRequestEnabled": true,
   "_links": {
      "rel": "self",
      "uri": "/api/v1/boarding/discoverySettings"
   }
}