Skip to main content

PUT /switches/configurationData

Use this method to restore configuration data for one or more RackSwitch or Flex System switches. The switch configuration-data file is downloaded from Lenovo XClarity Administrator to the target switch, and the configuration takes effect automatically.

Authentication​

Authentication with username and password is required.

Request URL​

PUT https://{management_server_IP}/switches/configurationData

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDescription
actionRequiredStringAction to perform. This can be the following value.

  • restore. Restore configuration data to a specific switch.

restartOptionalBoolean(Switches running CNOS only) Indicates whether to restart the switch after configuration data is restored.

  • true. Restarts the switch after the restore operation completes.

  • false. (default). Do not restart the switch.

    If you choose not to restart the switch, you must manually restart the switch to activate the restored configuration data.

targetsRequiredArray of objectsInformation about each target to be restored
 filenameRequiredStringName of the configuration-data file to restore on the specified switch
 uuidRequiredStringUUID of the switches to be restored. To obtain the switch UUIDs, use the GET /switches method.
The following example restores configuration data for multiple switches and restarts the switches to activate the restored data.
{
   "action": "restore",
   "restart": true,
   "targets" : [{
      "filename" : "Switch1.cfg",
      "uuid" : "00000000000010008000A897DCF7FC00"
   }, 
   {
      "filename" : "Switch2.cfg",
      "uuid" : "A1A9642D7D763A8096A9F1657FB07929"
   }]
}

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.
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 body​

AttributesTypeDescription
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.
messagesArrayInformation about one or more messages
 explanationStringAdditional information to clarify the reason for the message
 recoveryArrayRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
 statusCodeStringResponse code
 statusDescriptionStringDescription of the response code
 textStringMessage text associated with the message identifier
 uuidStringSwitch UUID
The following example is returned if the request is successful.
{
   "result": "success",
   "messages": [{
      "explanation": "",
      "recovery": {
         "text": "text here",
         "URL": "URL here"
      },
      "statusCode": 200,
      "statusDescription": "Configuration data was restored successfully.",
      "text": "",
      "uuid": "00000000000010008000A897DCF7FC00"
   },
   {
      "explanation": "",
      "recovery": {
         "text": "text here",
         "URL": "URL here"
      },
      "statusCode": 200,
      "statusDescription": "Configuration data was restored successfully.",
      "text": "",
      "uuid": "A1A9642D7D763A8096A9F1657FB07929"
   }]
}