OpenDoveNetworkSouthbound

Open DOVE Southbound REST APIs for Networks.


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:

/networks

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

GET

List all networks

Response Body

element: openDoveNetworkRequest
media types: application/json

list of all networks 


Example:

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

Response body in JSON:
{
"networks": [ {
"is_tombstone": false,
"change_version": 2,
"create_version": 2,
"id": "419fb938-26bf-459e-83b8-5a5700deec52",
"network_id": 9725101,
"name": "Ext_MCast_9725101",
"domain_uuid": "7c1a671d-f2fd-4c3e-ad7b-097263abc3ff",
"type": 1
}, {
"is_tombstone": false,
"change_version": 4,
"create_version": 4,
"id": "db256e1a-6601-4001-8ece-0ca2d1c75609",
"network_id": 11099999,
"name": "Neutron 0d051418-0f12-0b00-0000-000000000002",
"domain_uuid": "7c1a671d-f2fd-4c3e-ad7b-097263abc3ff",
"type": 0
}, {
"is_tombstone": false,
"change_version": 3,
"create_version": 3,
"id": "11051cde-73e2-4193-8c94-bc45eca8022d",
"network_id": 9220207,
"name": "Neutron 0d051418-0f12-0b00-0000-000000000001",
"domain_uuid": "7c1a671d-f2fd-4c3e-ad7b-097263abc3ff",
"type": 0
} ]
}

Status Codes

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

/networks/{networkUUID}

Mount Point: /controller/sb/v2/opendove/odmc/networks/{networkUUID}

GET

Show network

Parameters

name description type default
networkUUID uuid of network path

Response Body

element: openDoveNetworkRequest
media types: application/json

network Information 


Example:

Request URL:
http://127.0.0.1:8080/controller/sb/v2/opendove/odmc/networks/419fb938-26bf-459e-83b8-5a5700deec52

Response body in JSON:
{
"network": {
"is_tombstone": false,
"change_version": 2,
"create_version": 2,
"id": "419fb938-26bf-459e-83b8-5a5700deec52",
"network_id": 9725101,
"name": "Ext_MCast_9725101",
"domain_uuid": "7c1a671d-f2fd-4c3e-ad7b-097263abc3ff",
"type": 1
}
}

Status Codes

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

/networks/{vnid}/endpoint-register

Mount Point: /controller/sb/v2/opendove/odmc/networks/{vnid}/endpoint-register

PUT

Signal endpoints attached to a network to re-register with the oDCS

Parameters

name description type default
vnid virtual network identifier path

Response Body

element: (custom)
media types: */*
application/xml

none 


Example:

Request URL:
http://localhost:8080/controller/sb/v2/opendove/odmc/networks/9220207/endpoint-register

Status Codes

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

/networks/{vnid}/networkSubnets/{subnetUUID}

Mount Point: /controller/sb/v2/opendove/odmc/networks/{vnid}/networkSubnets/{subnetUUID}

GET

Show subnet associated with a network (identified by vnid)

Parameters

name description type default
subnetUUID subnet UUID path
vnid virtual network identifier path

Response Body

element: openDoveSubnet
media types: application/json

subnet information 


Example:
Used for DGW
Request URL:
http://127.0.0.1:8080/controller/sb/v2/opendove/odmc/networks/11099999/networkSubnets/7787235a-4452-4107-9dfd-6731df5f9799

Response body in JSON:
subnet
{
"is_tombstone": false,
"change_version": 8,
"create_version": 8,
"id": "7787235a-4452-4107-9dfd-6731df5f9799",
"domain_id": "7c1a671d-f2fd-4c3e-ad7b-097263abc3ff",
"subnet": "10.1.2.0",
"mask": "255.255.255.0",
"nexthop": "10.1.2.1",
"type": "Dedicated",
"network_ids": [ "db256e1a-6601-4001-8ece-0ca2d1c75609" ]
}

Status Codes

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

/networks/{vnid}/subnets/{subnetUUID}

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

GET

Show subnet associated with a network (identified by vnid)

Parameters

name description type default
subnetUUID subnet UUID path
vnid virtual network identifier path

Response Body

element: openDoveSubnet
media types: application/json

subnet information 


Example:

Request URL:
http://127.0.0.1:8080/controller/sb/v2/opendove/odmc/networks/11099999/subnets/7787235a-4452-4107-9dfd-6731df5f9799

Response body in JSON:
{
"is_tombstone": false,
"change_version": 8,
"create_version": 8,
"id": "7787235a-4452-4107-9dfd-6731df5f9799",
"domain_id": "7c1a671d-f2fd-4c3e-ad7b-097263abc3ff",
"subnet": "10.1.2.0",
"mask": "255.255.255.0",
"nexthop": "10.1.2.1",
"type": "Dedicated",
"network_ids": [ "db256e1a-6601-4001-8ece-0ca2d1c75609" ]
}

Status Codes

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