OpenDoveSubnetSouthbound

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:

/subnets

Mount Point: /controller/sb/v2/opendove/odmc/subnets

GET

List all subnets

Response Body

element: openDoveSubnetRequest
media types: application/json

list of all opendove sunets 


Example:

Request URL:
http://localhost:8080/controller/sb/v2/opendove/odmc/subnets

Response body in JSON:

{
"subnets" : [ {
"is_tombstone" : false,
"change_version" : 6,
"create_version" : 6,
"id" : "3dc34bec-cc59-44ca-a946-721a2385b345",
"domain_id" : "4b5b6730-05a6-4ed8-b0d1-da3ddb9225e4",
"subnet" : "10.1.1.0",
"mask" : "255.255.255.0",
"nexthop" : "10.1.1.1",
"type" : "Dedicated",
"network_ids" : [ "87a95eaa-bd99-4c16-bdb2-536623fc91bc" ],
"associatedOSSubnetUUID" : "13150214-0513-1400-0000-000000000001"
}, {
"is_tombstone" : false,
"change_version" : 8,
"create_version" : 8,
"id" : "8f8226a9-1443-480f-abbc-43ba9f37d223",
"domain_id" : "4b5b6730-05a6-4ed8-b0d1-da3ddb9225e4",
"subnet" : "10.1.2.0",
"mask" : "255.255.255.0",
"nexthop" : "10.1.2.1",
"type" : "Dedicated",
"network_ids" : [ "8f53683e-da75-486a-a53a-32c3804a282f" ],
"associatedOSSubnetUUID" : "13150214-0513-1400-0000-000000000002"
} ]
}

Status Codes

code description
200 Operation successful
204 No content
401 Unauthorized
500 Internal Error

/subnets/{subnetUUID}

Mount Point: /controller/sb/v2/opendove/odmc/subnets/{subnetUUID}

GET

Show subnet

Parameters

name description type default
subnetUUID uuid of subnet path

Response Body

element: openDoveSubnetRequest
media types: application/json

subnet Information 


Example:

Request URL:
http://127.0.0.1:8080/controller/sb/v2/opendove/odmc/subnets/8f8226a9-1443-480f-abbc-43ba9f37d223

Response body in JSON:

{
"subnet" : {
"is_tombstone" : false,
"change_version" : 8,
"create_version" : 8,
"id" : "8f8226a9-1443-480f-abbc-43ba9f37d223",
"domain_id" : "4b5b6730-05a6-4ed8-b0d1-da3ddb9225e4",
"subnet" : "10.1.2.0",
"mask" : "255.255.255.0",
"nexthop" : "10.1.2.1",
"type" : "Dedicated",
"network_ids" : [ "8f53683e-da75-486a-a53a-32c3804a282f" ]
}
}

Status Codes

code description
200 Operation successful
204 No content
401 Unauthorized
404 Not Found
500 Internal Error