Skip to main content

GET /switches/configurationData

Use this method to return information about all configuration-data files for all managed RackSwitch and Flex System switches.

Authentication​

Authentication with username and password is required.

Request URL​

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

Query parameters​

None

Request body​

None

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
switchesArray of objectsInformation about configuration-back files for the switches.
 configurationDataArray of objectsInformation about each configuration-data file.
  commentStringComment about the configuration-data file
  dateStringDate when the configuration-data file was created.
  fileIdStringID of the configuration-data file
  filenameStringName of the configuration-data file
  fwVersionStringVersion of firmware that is running on the switch
  sizeStringSize of the configuration-data file
  switchUuidStringUUID of the switch
 hostnameStringHostname for the switch
 ipAddressStringIP address of the switch
 typeStringType of switch
 uuidStringUUID of the switch
The following example is returned if the request is successful.
{
   "switches": [{
      "configurationData": [{
         "comment": "comment2",
         "date": "2017-03-06T01:47:57Z",
         "fileId": "hwpdo"
         "filename": "config2.cfg",
         "fwVersion": "10.3.1.3",
         "size": "11375",
         "switchUuid": "00000000000010008000A897DCF89800"
      },
      {
         "comment": "comment1",
         "date": "2017-03-06T01:45:25Z",
         "fileId": "ihwdZ",
         "filename": "config1.cfg",
         "fwVersion": "10.3.1.3",
         "size": "11375",
         "switchUuid": "00000000000010008000A897DCF89800"
      }],
      "hostname": "G8296_CNOS",
      "ipAddress": "10.240.196.152",
      "type": "LENOVO G8296",
      "uuid": "00000000000010008000A897DCF89800"
   }]
}