Devices

List all devices

Sample request 

GET /sdn/v2.0/net/devices

There is no request body for this API.

Sample Response 

{
	"devices": [
		{
			"uid": "00:00:00:00:00:00:00:0e",
			"uris": [
				"OF:00:00:00:00:00:00:00:0e"
			]
		}
	]
}

Response Codes 

  • Normal: OK(200)

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

List details of a specific device

Sample request 

GET /sdn/v2.0/net/devices/{uid}

There is no request body for this API.

Sample Response 

{
   "Device Status":"Online",
   "device identity":{
      "contact":"",
      "description":"",
      "device type":"J9586A",
      "fw":"KA.15.15.0006",
      "ip":"10.100.162.42",
      "location":"",
      "name":"HP-3800-48G-4XG",
      "product":"3800-48G-4XG Switch",
      "serial":"SG36G0YR04",
      "vendor":"HP"
   },
   "if count":53,
   "uid":"10:00:10:60:4b:39:dc:40"
}

Response Codes 

  • Normal: OK(200)

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

List all interfaces associated with a device

Sample request 

GET /sdn/v2.0/net/devices/{uid}/interfaces

There is no request body for this API.

Sample Response 

{
   "Interfaces":[
      {
         "Info":"Name:s21-eth3, State:[UP], Mac:fe:23:d6:ee:df:49, HostedBy:00:00:00:02:00:00:00:01, ips:",
         "InterfaceId":"0x3"
      },
      {
         "Info":"Name:s21, State:[UP], Mac:3e:55:6c:26:62:48, HostedBy:00:00:00:02:00:00:00:01, ips:",
         "InterfaceId":"0xfffffffe"
      }
   ]
}

Response Codes 

  • Normal: OK(200)

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

Delete a device

Sample request 

DELETE /sdn/v2.0/net/devices/{uid}

There is no request body for this API.

Sample Response 

If success, response is a 200, else an error code is reported.

Response Codes 

  • Normal: OK(200)

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