OpenDoveDomainSouthbound

Open DOVE Southbound REST APIs for Domains.


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:

/domains

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

GET

List all domains

Response Body

element: openDoveDomainRequest
media types: application/json

list of all domains 


Example:

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

Response body in JSON:
{
"domains": [ {
"is_tombstone": false,
"change_version": 1,
"create_version": 1,
"id": "3f749e3e-a7cc-4e55-bb05-eb9cde963a0c",
"name": "Neutron 14050e01-0e14-0000-0000-000000000001",
"replication_factor": 2
} ]
}

Status Codes

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

/domains/{domainUUID}

Mount Point: /controller/sb/v2/opendove/odmc/domains/{domainUUID}

GET

Show domain by uuid

Parameters

name description type default
domainUUID uuid of domain path

Response Body

element: openDoveDomainRequest
media types: application/json

domain Information 


Example:

Request URL:
http://localhost:8080/controller/sb/v2/opendove/odmc/domains/3f749e3e-a7cc-4e55-bb05-eb9cde963a0c

Response body in JSON:
{
"domain": [ {
"is_tombstone": false,
"change_version": 1,
"create_version": 1,
"id": "3f749e3e-a7cc-4e55-bb05-eb9cde963a0c",
"name": "Neutron 14050e01-0e14-0000-0000-000000000001",
"replication_factor": 2
} ]
}

Status Codes

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

/domains/bynumber/{domainNumber}

Mount Point: /controller/sb/v2/opendove/odmc/domains/bynumber/{domainNumber}

GET

Show domain by createVersion number

Parameters

name description type default
domainNumber (no documentation provided) path

Response Body

element: openDoveDomainRequest
media types: application/json

domain Information 


Example:

Request URL:
http://localhost:8080/controller/sb/v2/opendove/odmc/domains/bynumber/1

Response body in JSON:
{
"domain": [ {
"is_tombstone": false,
"change_version": 1,
"create_version": 1,
"id": "3f749e3e-a7cc-4e55-bb05-eb9cde963a0c",
"name": "Neutron 14050e01-0e14-0000-0000-000000000001",
"replication_factor": 2
} ]
}

Status Codes

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

/domains/{domainUUID}/networks/{vnid}

Mount Point: /controller/sb/v2/opendove/odmc/domains/{domainUUID}/networks/{vnid}

GET

Show network scoped by domain

Parameters

name description type default
domainUUID uuid of domain path
vnid virtual network ID of network path

Response Body

element: openDoveNetwork
media types: application/json

network Information 


Example:

Request URL:
http://127.0.0.1:8080/controller/sb/v2/opendove/odmc/domains/7c1a671d-f2fd-4c3e-ad7b-097263abc3ff/networks/11099999

Response body in JSON:
{
"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
}

Status Codes

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

/domains/{domainUUID}/policy/{policyUUID}

Mount Point: /controller/sb/v2/opendove/odmc/domains/{domainUUID}/policy/{policyUUID}

GET

Show policy scoped by domain

Parameters

name description type default
domainUUID UUID of domain path
policyUUID UUID of policy path

Response Body

element: openDovePolicy
media types: application/json

policy Information 


Example:

Request URL:
http://127.0.0.1:8080/controller/sb/v2/opendove/odmc/domains/7c1a671d-f2fd-4c3e-ad7b-097263abc3ff/policy/b68088f9-ce4a-48fc-839e-b376f81aac70

Response body in JSON:
{
"is_tombstone": false,
"change_version": 9,
"create_version": 9,
"id": "b68088f9-ce4a-48fc-839e-b376f81aac70",
"type": 1,
"src_network": 11099999,
"dst_network": 9220207,
"ttl": 1000,
"action": 1,
"domain_id": "7c1a671d-f2fd-4c3e-ad7b-097263abc3ff",
"traffic_type": 0
}

Status Codes

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

/domains/bynumber/{domainID}/networks/{vnid}

Mount Point: /controller/sb/v2/opendove/odmc/domains/bynumber/{domainID}/networks/{vnid}

GET

Show network scoped by domain (using its createVersion number)

Parameters

name description type default
domainID (no documentation provided) path
vnid virtual network ID of network path

Response Body

element: openDoveNetwork
media types: application/json

network Information 


Example:

Request URL:
http://127.0.0.1:8080/controller/sb/v2/opendove/odmc/domains/bynumber/1/networks/11099999

Response body in JSON:
{
"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
}

Status Codes

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

/domains/bynumber/{domainID}/policy/{policyUUID}

Mount Point: /controller/sb/v2/opendove/odmc/domains/bynumber/{domainID}/policy/{policyUUID}

GET

Show policy scoped by domain (byNumber)

Parameters

name description type default
domainID ID of domain path
policyUUID UUID of policy path

Response Body

element: openDovePolicy
media types: application/json

policy Information 


Example:

Request URL:
http://127.0.0.1:8080/controller/sb/v2/opendove/odmc/domains/bynumber/domainID/policy/b68088f9-ce4a-48fc-839e-b376f81aac70

Response body in JSON:
{
"is_tombstone": false,
"change_version": 9,
"create_version": 9,
"id": "b68088f9-ce4a-48fc-839e-b376f81aac70",
"type": 1,
"src_network": 11099999,
"dst_network": 9220207,
"ttl": 1000,
"action": 1,
"domain_id": "7c1a671d-f2fd-4c3e-ad7b-097263abc3ff",
"traffic_type": 0
}

Status Codes

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