OpenDoveSwitchNorthbound
Open DOVE Northbound REST APIs for 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:
/switches
Mount Point: /controller/nb/v2/opendove/odmc/switches
GET
Returns all switches
Response Body
| element: | openDoveSwitchRequest |
| media types: | application/json |
List of all switches
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/switches
Response body in JSON:
{
"switches": [ {
"id": "uuid",
"name": "switch name",
"tunnelip": "10.10.10.1",
"mgmtip": "20.20.20.2",
"timestamp": "now"
} ]
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 204 | No content |
| 401 | Unauthorized |
| 500 | Internal Error |
/switches/{switchUUID}
Mount Point: /controller/nb/v2/opendove/odmc/switches/{switchUUID}
GET
Returns a particular switch
Parameters
| name | description | type | default |
|---|---|---|---|
| switchUUID | Identifier of the switch | path |
Response Body
| element: | openDoveSwitchRequest |
| media types: | application/json |
Data on that switch
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/switches/uuid
Response body in JSON:
{
"switch": {
"id": "uuid",
"name": "switch name",
"tunnelip": "10.10.10.1",
"mgmtip": "20.20.20.2",
"timestamp": "now"
}
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 204 | No content |
| 401 | Unauthorized |
| 404 | Not Found |
| 500 | Internal Error |