GET /switches/configurationData

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

Note: This API requires Lenovo XClarity Administrator v1.4.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

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

Query parameters

None

Request body

None

Response codes

Code Description Comments
200 OK The request completed successfully.
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.
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.
409 Conflict There is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
switches Array of objects Information about configuration-back files for the switches.
  configurationData Array of objects Information about each configuration-data file.
    comment String Comment about the configuration-data file
    date String Date when the configuration-data file was created.
    fileId String ID of the configuration-data file
    filename String Name of the configuration-data file
    fwVersion String Version of firmware that is running on the switch
    size String Size of the configuration-data file
    switchUuid String UUID of the switch
  hostname String Hostname for the switch
  ipAddress String IP address of the switch
  type String Type of switch
  uuid String UUID 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"
   }]
}