OpenDoveSwitchSouthbound

Open DOVE Southbound REST APIs for oDCS Switch.


Authentication scheme [for now]: HTTP Basic
Authentication realm : opendaylight
Transport : HTTP and HTTPS

HTTPS Authentication is disabled by default. Administrator can enable it in tomcat-server.xml after adding a proper keystore / SSL certificate from a trusted authority.
More info : http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration

The following resources are part of this group:

/switch

Mount Point: /controller/sb/v2/opendove/odmc/switch

POST

Registers an opendove switch with the oDMC

Request Body

element: openDoveSwitch
media types: application/json

(no documentation provided)

Response Body

element: openDoveSwitch
media types: application/json

registered opendove switch information 


Example:

Request URL:
http://localhost:8080/controller/sb/v2/opendove/odmc/switch

Request body in JSON:
{
"name": "test_switch",
"tunnelip": "5.5.5.5",
"managementip": "6.6.6.6"
}

Response body in JSON:
{
"change_version" : 13,
"create_version" : 13,
"id" : "5086a907-3107-4cda-8e99-6b67675634b2",
"name" : "test_switch",
"tunnelip" : "5.5.5.5",
"managementip" : "6.6.6.6",
"timestamp" : "Sun Nov 03 09:03:51 CST 2013"
}

Status Codes

code description
201 Registration Accepted
204 Switch previously registered, no endpoint registration needed
205 Switch previously registered, endpoint registration required
500 Internal Error

/switch/{switchUUID}

Mount Point: /controller/sb/v2/opendove/odmc/switch/{switchUUID}

PUT

Heartbeat method for an opendove switch

Parameters

name description type default
switchUUID (no documentation provided) path

Request Body

element: openDoveSwitch
media types: */*
application/xml

(no documentation provided)

Response Body

element: (custom)
media types: */*
application/xml

none 


Example:

Request URL:
http://localhost:8080/controller/sb/v2/opendove/odmc/switch/5086a907-3107-4cda-8e99-6b67675634b2

Request body in JSON:
{
"name": "test_switch",
"tunnelip": "5.5.5.5",
"managementip": "6.6.6.6"
}

Status Codes

code description
204 No endpoint registration needed
205 Endpoint registration required
409 Switch not registered
500 Internal Error

/switch/{switchUUID}/getVNIDbyPort/{portUUID}

Mount Point: /controller/sb/v2/opendove/odmc/switch/{switchUUID}/getVNIDbyPort/{portUUID}

GET

Map openstack port to opendove vnid

Parameters

name description type default
switchUUID UUID of switch making request path
portUUID openstack neutron port UUID path

Response Body

element: openDoveNetwork
media types: application/json

opendove network information 


Example:

Request URL:
http://127.0.0.1:8080/controller/sb/v2/opendove/odmc/switch/473931b4-0f79-4139-8af2-87dc100be0de/getVNIDbyPort/100f1214-0000-0000-0000-000000000001

Response body in JSON
{
"is_tombstone" : false,
"change_version" : 5,
"create_version" : 5,
"id" : "892dab23-94c9-4676-94c9-89da84b8cdf1",
"network_id" : 13586458,
"name" : "Neutron 0d051418-0f12-0b00-0000-000000000001",
"domain_uuid" : "e47a1688-ed1d-4163-a3c6-c8be30c714ea",
"type" : 0
}

Status Codes

code description
204 No content
401 Unauthorized
404 some Resource Not Found
500 Internal Error