POST /api/v1/boarding/agentInstaller
Use this method to create a Lenovo Universal Device Client (UDC) agent installation package for specific ThinkEdge Client devices. This UDC agent must be installed on ThinkEdge Client devices so that the devices can be securely discovered and managed by a Lenovo XClarity Management Hub resource manager.
After the UDC-agent installation package is created, you can download the package the local system using GET /api/v1/boarding/agentInstaller/{filename}.
An asynchronous job is created to complete this request. The response header returns the job URI and job ID.
A successful response code indicates that the job was successfully transmitted and accepted by the hub. It does not indicate that the operation that is associated with the job was successful. If a job was not successfully started, refer to the response code and response body for details.
Authentication
Authentication with username and password is required.
Resource URI
POST https://{orchestrator_server_IP}/api/v1/boarding/agentInstaller
Query parameters
None
Request body
| Attributes | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| expirationTimeInDays | Optional | Integer | Number of days before the UDC agent installer becomes unusable after it is downloaded. This can be one of the following values.
| ||
| managerID | Required | String | Lenovo XClarity Management Hub resource manager ID | ||
| maxUsageLimit | Optional | Integer | Number of times that you plan to install the UDC agent on a server. This is typically the number of servers on which you need to install the UDC agent. The minimum value is 1, and the maximum value is 1,000,000. The default is 10 usages. | ||
| operatingSystem | Required | String | Operating system that is installed on the server
| ||
{
expirationTimeInDays: 7,
managerID: "48331a223bf34fba90732b379b837b9c",
maxUsageLimit: 10,
operatingSystem: "Windows"
}
Response codes
| Code | Description | Comments |
|---|---|---|
| 201 | Created | One or more new resources were successfully created. |
| 400 | Bad Request | A 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. |
Response header
The URI and ID of the root job are returned in the Location and JobID fields respectively.
Response body
When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).
| Attributes | Type | Description | ||
|---|---|---|---|---|
| installer | String | File name of the UDC agent installer, in the following format: edgeInstaller_{operatingSystem}_{managerID}_{timestamp}.gz for Linux or zip for Windows} | ||
| jobID | Integer | Job ID | ||
| _links | Object | Resource URI (see Links) | ||
{
installer: "edgeInstaller_Windows_Hub1_2019-05-02T19:28:14.000Z.zip",
jobID: 1 // The job id which was triggered when making the POST
}