Skip to main content

PUT /managementServer/updates

Use this method to install a management-server update.

This method starts a job to perform the operation. The response body includes a job ID that represents the job that is monitored by the management server. You can use GET /tasks/{job_list} to determine the status of the job. If a job was not successfully started, refer to the response code and response body for details.

To cancel the request, use GET /tasks/{job_list}, where {job_id} is the ID that is returned by this request.

Attention
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.

Authentication​

Authentication with username and password is required.

Request URL​

PUT https://{management_server_IP}/managementServer/updates

Query parameters​

ParametersRequired / OptionalDescription
action=applyRequiredInstalls the specified management-server updates.
The following example applies a specific update to the management server.
PUT https://192.0.2.0/managementServer/updates?action=apply

Request body​

AttributesRequired / OptionalTypeDescription
fixidsRequiredArray of stringsUpdate ID. You can specify only one update ID. To obtain the update UUID, use the GET /chassis method.
The following example installs a management-server update.
{
   "fixids": ["lnvgy_sw_lxca_222-1.2.0_anyos_noarch"] 
}

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
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. Ensure that you have privileges to perform the request.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
jobidStringJob ID
resultStringResults of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
errorMsgObjectInformation about one or more messages
 messagesArray of objectsInformation about a message
  idStringMessage identifier of a returned message.
  recoveryObject 
   textString 
  textStringMessage text associated with the message identifier.
 resultStringResults of the request. This can be one of the following values.

  • informational.

  • warning.

The following example is returned if the request is successful.
{ 
   "jobid": "5", 
   "result": "success", 
   "errorMsg": { 
      "messages": [{ 
         "id": "FQXHMUP2508I", 
         "text": "The operation has started successfully." 
      }],
      "result": "informational"
   } 
}