OpenDoveNetworksNorthbound
Open DOVE Northbound REST APIs for Networks.
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:
/networks
Mount Point: /controller/nb/v2/opendove/odmc/networks
GET
Lists networks
Response Body
| element: | openDoveNetworkRequest |
| media types: | application/json |
List of networks
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/networks
Response body in JSON:
{
"networks": [ {
"id": "uuid",
"network_id": 102,
"name": "Test Network",
"domain_id": "domain_uuid",
"type": 1,
} ]
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 204 | No content |
| 401 | Unauthorized |
| 500 | Internal Error |
/networks/{networkUUID}
Mount Point: /controller/nb/v2/opendove/odmc/networks/{networkUUID}
GET
Returns a particular network
Parameters
| name | description | type | default |
|---|---|---|---|
| networkUUID | Identifier of the network | path |
Response Body
| element: | openDoveNetworkRequest |
| media types: | application/json |
Data on that network
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/networks/uuid
Response body in JSON:
{
"network": {
"id": "uuid",
"network_id": 102,
"name": "Test Network",
"domain_id": "domain_uuid",
"type": 1,
}
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 204 | No content |
| 401 | Unauthorized |
| 404 | Not Found |
| 500 | Internal Error |
/networks/{networkUUID}/endpoints
Mount Point: /controller/nb/v2/opendove/odmc/networks/{networkUUID}/endpoints
GET
List endpoints on a particular network
Parameters
| name | description | type | default |
|---|---|---|---|
| networkUUID | Identifier of the network | path |
Response Body
| element: | openDoveEndpointRequest |
| media types: | application/json |
List of endpoints on that network
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/networks/uuid/endpoints
Response body in JSON:
{
"endpoints": [ {
"Host IP": "100.100.100.100",
"mac": "00:00:00:00:00:00",
"virtual IPs": "10.10.10.1",
"physical IPs": "1.2.3.4"
} ]
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 204 | No content |
| 401 | Unauthorized |
| 404 | Not Found |
| 500 | Internal Error |