Systems
prev Chapter 3 /sdn/v2.0 next

Systems

List controllers

Sample request 

List all controllers:

GET /sdn/v2.0/systems

List controller by the given IP:

GET /sdn/v2.0/systems?ip="192.168.1.100"

There is no request body for this API.

Sample response 

 {
   "systems":[
      {
         "uid":"adc5e492-957c-4f8c-aa0a-97fa2dac5f23",
         "version":"01.11.00.0000",
         "role":"leader",
         "core_data_version":0,
         "core_data_version_timestamp":"1970-01-01T00:00:00.000Z",
         "time":"1970-01-01T00:00:00.000Z",
         "self":true,
         "status":"active"
      }
   ]
}

Response codes 

  • Normal: OK (200)

  • Error: Unauthorized (401), Not Found (404), Service Unavailable (503)

Systems/{system uid}

Get information on the given controller

Sample request 

List controller information:

GET /sdn/v2.0/systems/adc5e492-957c-4f8c-aa0a-97fa2dac5f23

There is no request body for this API.

Sample response 

{
   "system":{
      "uid":"adc5e492-957c-4f8c-aa0a-97fa2dac5f23",
      "version":"01.11.00.0000",
      "ip":"192.168.1.100",
      "role":"leader",
      "core_data_version":0,
      "core_data_version_timestamp":"1970-01-01T00:00:00.000Z",
      "time":"1970-01-01T00:00:00.000Z",
      "self":true,
      "status":"active"
   }
}

Response codes 

  • Normal: OK (200)

  • Error: Unauthorized (401), Not Found (404), Service Unavailable (503)

Update the IP address of a non-teamed system

Updating the IP address of a system applies only to a non-teamed system where the system information being updated is a representation of the system being called, i.e., "self":true. If the system being updated is teamed and/or is not self, then an error will be returned. This is a partial update operation.

Sample request 

This example updates the IP address of a non-teamed system with the UID of "adc5e492-957c-4f8c-aa0a-97fa2dac5f23":

PUT /sdn/v2.0/systems/adc5e492-957c-4f8c-aa0a-97fa2dac5f23

The request body contains:

{
   "system":{
      "ip":"192.168.1.200"
   }
}

Sample response 

Updated JSON for the system information of the system that was updated will be returned, for example:

{
   "system":{
      "uid":"adc5e492-957c-4f8c-aa0a-97fa2dac5f23",
      "version":"01.14.00.0000",
      "ip":"192.168.1.200",
      "role":"leader",
      "core_data_version":8,
      "core_data_version_timestamp":"2013-08-21T18:17:33.187Z",
      "time":"2013-08-21T18:17:23.899Z",
      "status":"active",
      "self":true
   }
}

Response codes 

  • Normal: OK (200)

  • Error: Unauthorized (401), Not Found (404), Service Unavailable (503)

prev up next
Audit logs home Region