OpenDoveVGWVNIDMappingNorthbound
Open DOVE Southbound REST APIs for VGW VNID Mappings.
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:
/vlan-gws
Mount Point: /controller/nb/v2/opendove/odmc/vlan-gws
GET
Returns the list of VNID to VLAN mappings
Response Body
| element: | openDoveVGWVNIDMappingRequest |
| media types: | application/json |
Mapping data
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/vlan-gws/
Response body in JSON:
{
"vnid_mapping_rules": [ {
"id": "uuid",
"net_id": 100,
"gatewayUUID": "uuid2"
} ... ]
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 204 | No content |
| 401 | Unauthorized |
| 500 | Internal Error |
POST
Creates a new VNID to VLAN mappings
Request Body
| element: | openDoveVGWVNIDMappingRequest |
| media types: | application/json |
Mapping request data
Response Body
| element: | (custom) |
| media types: | application/json |
Created mapping
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/vlan-gws/
Request body in JSON:
{
"vnid_mapping_rule": {
"id": "uuid",
"net_id": 100,
"gatewayUUID": "uuid2"
}
}
Response body in JSON:
{
"vnid_mapping_rule": {
"id": "uuid",
"net_id": 100,
"gatewayUUID": "uuid2"
}
}
Status Codes
| code | description |
|---|---|
| 201 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 501 | Not Implemented |
/vlan-gws/{mappingUUID}
Mount Point: /controller/nb/v2/opendove/odmc/vlan-gws/{mappingUUID}
The following operations are supported on this resource:
GET
Returns a particular VNID to VLAN mapping
Parameters
| name | description | type | default |
|---|---|---|---|
| mappingUUID | Identifier of the mapping | path |
Response Body
| element: | (custom) |
| media types: | application/json |
Data on that mapping
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/vlan-gws/uuid
Response body in JSON:
{
"vnid_mapping_rule": {
"id": "uuid",
"net_id": 100,
"vlan" : 50,
"gatewayUUID": "uuid2"
}
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 204 | No content |
| 401 | Unauthorized |
| 404 | Not Found |
| 500 | Internal Error |
PUT
Updates a rule
Parameters
| name | description | type | default |
|---|---|---|---|
| mappingUUID | Identifier of the mapping | path |
Request Body
| element: | openDoveVGWVNIDMappingRequest |
| media types: | application/json |
Mapping request delta
Response Body
| element: | (custom) |
| media types: | application/json |
Modified mapping
Example:
Request URL:
http://localhost:8080/controller/nb/v2/opendove/odmc/vlan-gws/uuid
Request body in JSON:
{
"vnid_mapping_rule": {
"net_id": 110200,
}
}
Response body in JSON:
{
"vnid_mapping_rule": {
"id": "uuid",
"net_id": 110200,
"vlan" : 50,
"gatewayUUID": "uuid2"
}
}
Status Codes
| code | description |
|---|---|
| 200 | Operation successful |
| 400 | Bad Request |
| 401 | Unauthorized |
| 404 | Not Found |
| 501 | Not Implemented |
DELETE
Deletes a mapping
Parameters
| name | description | type | default |
|---|---|---|---|
| mappingUUID | Identifier of the mapping | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
nothing
Example: Request URL: http://localhost:8080/controller/nb/v2/opendove/odmc/vlan-gws/uuid Request body in JSON: none Response body in JSON: none
Status Codes
| code | description |
|---|---|
| 204 | No Content |
| 401 | Unauthorized |
| 404 | Not Found |
| 409 | Conflict |
| 501 | Not Implemented |