POST /managementServer/updates
Use this method to manage management-server updates in the updates repository.
When the action=import query parameter is specified, this method creates a job that can be used to import a management-server update package into the updates repository. The method returns the job ID, which you can then use with the POST /files/managementServer/updates?action=import&jobid={job_id} method.
To import a management-server update package into the updates repository, follow these steps:
Start a job to import the update using POST /managementServer/updates?action=import.
Import the update using POST /files/managementServer/updates?action=import&jobid={job_id} method, where the job ID is the ID that was returned in step 1.
Monitor the status of the import job using GET /tasks/{job_list}, where the job ID is the ID that was returned in step 1. You can also cancel the import job using this method.
Authentication
Authentication with username and password is required.
Request URL
POST https://{management_server_IP}/managementServer/updates
Query parameters
Parameters | Required / Optional | Description |
---|---|---|
action={action} | Required | Action to take. This can be one of the following values.
|
POST https://192.0.2.0/managementServer/updates?action=acquire
POST https://192.0.2.0/managementServer/updates?action=import
Request body
Attributes | Required / Optional | Type | Description |
---|---|---|---|
mts | Required if action=refresh | Array of strings | For management-server updates, this is always “lxca.” |
fixid | Required if action=acquire | Array of strings | UUIDs of one or more update packages, separated by a comma. To obtain the update UUIDs, use the GET /chassis method. |
size | Optional | Long | Total size, in bytes, of the file to be imported |
{
"mts": ["lxca"],
}
{
"fixids": ["lnvgy_sw_lxca_222-1.2.0_anyos_noarch,
lnvgy_sw_lxca_cmmswitchrepo1-1.2.0_anyos_noarch"]
}
{
"size": 1234567
}
Response codes
Code | Description | Comments |
---|---|---|
200 | OK | The request completed successfully. |
401 | Unauthorized | The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body. |
403 | Forbidden | The 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. |
500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
Attributes | Type | Description | ||
---|---|---|---|---|
jobid | String | Job ID | ||
result | String | Results of the request. This can be one of the following values.
| ||
errorMsg | Object | Information about one or more messages | ||
messages | Array of objects | Information about a message | ||
id | String | Message identifier of a returned message | ||
text | String | Message text associated with the message identifier | ||
result | String | Results of the request. This can be one of the following values.
|
{
"jobid": "5",
"result": "success",
"errorMsg": {
"messages": [{
"id": "FQXHMUP2508I",
"text": "The operation has started successfully."
}],
"result": "informational"
}
}