Skip to main content

POST /discoverRequest

Use this method to discover manageable devices. The response header includes a URI that is associated with a job that indicates that a task was started.

Attention
This REST API does not support SLP discovery for the Lenovo ThinkSystem DB-series FC SAN switches and NVIDIA Mellanox switches. Use POST /manageRequest?discovery=true instead.

Authentication

Authentication with username and password is required.

Request URL

POST https://{management_server_IP}/discoverRequest

Query parameters

None

Request body

AttributesRequired / OptionalTypeDescription
ipAddressesRequiredArray of stringsList of IP addresses for each device to be discovered
The following example discovers a manageable device.
[{
"ipAddresses":["10.243.2.233"]
}]

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.
403ForbiddenThe orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
409ConflictThere is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response header

If this POST method results in a job getting started, the response header includes a URI in the form /discoverRequest/jobs/{job_id} (for example, /discoverRequest/jobs/12) that represents the job that is monitored by the management server. You can use GET /discoverRequest/jobs/{job_id} to determine the status of the job. If a job was not successfully started, refer to the response code and response body for details.

Note
A successful response indicates that the request was successfully transmitted and accepted by the management server. It does not indicate that the operation that is associated with the job was successful.

Response body

None