OpenDoveServiceApplianceNorthbound
Open DOVE Northbound REST APIs for 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:
/serviceAppliances
Mount Point: /controller/nb/v2/opendove/odmc/serviceAppliances
GET
Returns all service appliances
Response Body
| element: | openDoveServiceApplianceRequest |
| media types: | application/json |
List of all service appliances
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/serviceAppliances
Response body in JSON:
{
"service_appliances": [ {
"ip_family": 4,
"ip": "10.10.10.1",
"uuid": "uuid",
"dcs_rest_service_port": 1888,
"dgw_rest_service_port": 1888,
"dcs_raw_service_port": 932,
"timestamp": "now",
"build_version": "openDSA-1",
"dcs_config_version": 60,
"canBeDCS": true,
"canBeDGW": true,
"isDCS": false,
"isDGW": false
} ]
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 204 | No content |
| 401 | Unauthorized |
| 500 | Internal Error |
/serviceAppliances/{saUUID}
Mount Point: /controller/nb/v2/opendove/odmc/serviceAppliances/{saUUID}
DELETE
Deletes a particular service appliance
Parameters
| name | description | type | default |
|---|---|---|---|
| saUUID | Identifier of the service appliance | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
none Example: Request URL: http://localhost:8080/controller/nb/v2/opendove/odmc/serviceAppliances/uuid
Status Codes
| code | description |
|---|---|
| 204 | No content |
| 401 | Unauthorized |
| 404 | Not Found |
| 500 | Internal Error |
GET
Returns a particular service appliance
Parameters
| name | description | type | default |
|---|---|---|---|
| saUUID | Identifier of the service appliance | path |
Response Body
| element: | openDoveServiceApplianceRequest |
| media types: | application/json |
Data on that service appliance
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/serviceAppliances/uuid
Response body in JSON:
{
"service_appliance": {
"ip_family": 4,
"ip": "10.10.10.1",
"uuid": "uuid",
"dcs_rest_service_port": 1888,
"dgw_rest_service_port": 1888,
"dcs_raw_service_port": 932,
"timestamp": "now",
"build_version": "openDSA-1",
"dcs_config_version": 60,
"canBeDCS": true,
"canBeDGW": true,
"isDCS": false,
"isDGW": false
}
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 204 | No content |
| 401 | Unauthorized |
| 404 | Not Found |
| 500 | Internal Error |