OpenDoveSystemNorthbound
Open DOVE Northbound REST APIs.
This class provides REST APIs for managing the open DOVE
Authentication scheme : 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:
/system
Mount Point: /controller/nb/v2/opendove/odmc/system
GET
Returns the system control block
Response Body
| element: | (custom) |
| media types: | application/json |
System Control Block
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/system
Response body in JSON:
{
"domain_separation": false,
"snat_pool_size": 1,
"egw_replication_factor": 1
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 401 | Unauthorized |
| 501 | Not Implemented |
PUT
Updates the control block
Request Body
| element: | openDoveNeutronControlBlock |
| media types: | application/json |
system control block in patch format
Response Body
| element: | (custom) |
| media types: | application/json |
Updated System Control Block
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/system
Request body in JSON:
{
"domain_separation": true
}
Response body in JSON:
{
"domain_separation": true,
"snat_pool_size": 1,
"egw_replication_factor": 1
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 400 | Bad Request |
| 401 | Unauthorized |
| 501 | Not Implemented |