OpenDovePolicySouthbound
Open DOVE Southbound REST APIs for Subnets.
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:
/policies
Mount Point: /controller/sb/v2/opendove/odmc/policies
GET
List all policies
Response Body
| element: | openDovePolicyRequest |
| media types: | application/json |
list of all policies
Example:
Request URL:
http://localhost:8080/controller/sb/v2/opendove/odmc/policies
Response body in JSON:
{
"policies" : [ {
"is_tombstone" : false,
"change_version" : 10,
"create_version" : 10,
"id" : "496c2591-3b57-4a2f-9ea6-c902768c8601",
"type" : 1,
"src_network" : 8293070,
"dst_network" : 9725207,
"ttl" : 1000,
"action" : 1,
"domain_id" : "4b5b6730-05a6-4ed8-b0d1-da3ddb9225e4",
"traffic_type" : 1
}, {
"is_tombstone" : false,
"change_version" : 12,
"create_version" : 12,
"id" : "f5e8dc57-e1cd-42b7-a796-5ccd82f4fe1b",
"type" : 1,
"src_network" : 9725207,
"dst_network" : 8293070,
"ttl" : 1000,
"action" : 1,
"domain_id" : "4b5b6730-05a6-4ed8-b0d1-da3ddb9225e4",
"traffic_type" : 1
}, {
"is_tombstone" : false,
"change_version" : 11,
"create_version" : 11,
"id" : "e9aa8058-62cb-4fff-87a5-e0372711c61a",
"type" : 1,
"src_network" : 9725207,
"dst_network" : 8293070,
"ttl" : 1000,
"action" : 1,
"domain_id" : "4b5b6730-05a6-4ed8-b0d1-da3ddb9225e4",
"traffic_type" : 0
}, {
"is_tombstone" : false,
"change_version" : 9,
"create_version" : 9,
"id" : "72787da8-f332-4f70-9221-e676cb0e09f6",
"type" : 1,
"src_network" : 8293070,
"dst_network" : 9725207,
"ttl" : 1000,
"action" : 1,
"domain_id" : "4b5b6730-05a6-4ed8-b0d1-da3ddb9225e4",
"traffic_type" : 0
} ]
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 204 | No content |
| 401 | Unauthorized |
| 500 | Internal Error |
/policies/{policyUUID}
Mount Point: /controller/sb/v2/opendove/odmc/policies/{policyUUID}
GET
Show policy
Parameters
| name | description | type | default |
|---|---|---|---|
| policyUUID | uuid of policy | path |
Response Body
| element: | openDovePolicyRequest |
| media types: | application/json |
policy Information
Example:
Request URL:
http://127.0.0.1:8080/controller/sb/v2/opendove/odmc/policies/72787da8-f332-4f70-9221-e676cb0e09f6
Response body in JSON:
{
"policy" : {
"is_tombstone" : false,
"change_version" : 9,
"create_version" : 9,
"id" : "72787da8-f332-4f70-9221-e676cb0e09f6",
"type" : 1,
"src_network" : 8293070,
"dst_network" : 9725207,
"ttl" : 1000,
"action" : 1,
"domain_id" : "4b5b6730-05a6-4ed8-b0d1-da3ddb9225e4",
"traffic_type" : 0
}
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 204 | No content |
| 401 | Unauthorized |
| 404 | Not Found |
| 500 | Internal Error |