OpenDoveDgwServiceApplianceSouthbound
Open DOVE Southbound REST APIs for DGW Service Appliance.
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:
/odgw
Mount Point: /controller/sb/v2/opendove/odmc/odgw
POST
Registers an oDGW with the oDMC
Request Body
| element: | openDoveServiceAppliance |
| media types: | application/json |
(no documentation provided)
Response Body
| element: | openDoveServiceAppliance |
| media types: | application/json |
registered oDGW information
Example:
Request URL:
http://localhost:8080/controller/sb/v2/opendove/odmc/odgw
Request body in JSON:
{
"ip_family": 0,
"ip": "1.1.1.1",
"uuid": "1",
"dcs_rest_service_port": 0,
"dgw_rest_service_port": 0,
"dcs_raw_service_port": 0,
"build_version": "",
"dcs_config_version": 0,
"dgw_config_version": 0,
"canBeDCS": false,
"canBeDGW": true,
"isDCS": false,
"isDGW": false
}
Response body in JSON:
{
"ip_family": 0,
"ip": "1.1.1.1",
"uuid": "1",
"dcs_rest_service_port": 0,
"dgw_rest_service_port": 0,
"dcs_raw_service_port": 0,
"timestamp": "Thu Oct 03 13:50:01 PDT 2013",
"build_version": "",
"dcs_config_version": 0,
"dgw_config_version": 0,
"canBeDCS": false,
"canBeDGW": true,
"isDCS": false,
"isDGW": false
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 201 | Registration Accepted |
| 409 | Service Appliance IP Address Conflict |
| 500 | Internal Error |
/odgw/{dsaUUID}
Mount Point: /controller/sb/v2/opendove/odmc/odgw/{dsaUUID}
PUT
oDGW Heartbeat method to oDMC
Parameters
| name | description | type | default |
|---|---|---|---|
| dsaUUID | (no documentation provided) | path |
Request Body
| element: | openDoveServiceAppliance |
| media types: | application/json |
(no documentation provided)
Response Body
| element: | openDoveServiceAppliance |
| media types: | application/json |
updated oDGW information
Example:
Request URL:
http://localhost:8080/controller/sb/v2/opendove/odmc/odgw/1
Request body in JSON:
{
"ip_family": 0,
"ip": "1.1.1.1",
"dgw_config_version": 1
"canBeDGW": true,
"isDGW": true|false
}
Response body in JSON:
{
"ip_family": 0,
"ip": "1.1.1.1",
"uuid": "1",
"dcs_rest_service_port": 0,
"dgw_rest_service_port": 0,
"dcs_raw_service_port": 0,
"timestamp": "Thu Oct 03 14:00:01 PDT 2013",
"build_version": "",
"dcs_config_version": 0,
"dgw_config_version": 1,
"canBeDCS": false,
"canBeDGW": true,
"isDCS": false,
"isDGW": true
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 409 | Service Appliance IP Address Conflict |
| 500 | Internal Error |