OpenDoveDgwServiceApplianceNorthbound

Open DOVE Northbound REST APIs for DGW Service Appliance.


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:

/odgw/{odgwUUID}/allstats

Mount Point: /controller/nb/v2/opendove/odmc/odgw/{odgwUUID}/allstats

GET

Gets statistics for a gateway

Parameters

name description type default
odgwUUID gateway UUID to interrogate path

Response Body

element: openDoveGWStats
media types: application/json

statistics 


Example:

Request URL:
http://localhost:8080/controller/nb/v2/opendove/odgw/uuid/allstats

Response body in JSON:
{
"ovl_to_ext_leave_bytes": "count",
"ovl_to_ext_leave_pkts": "count",
"ovl_to_ext_leave_bps": "count",
"ovl_to_ext_leave_pps": "count",
"ext_to_ovl_enter_bytes": "count",
"ext_to_ovl_enter_pkts": "count",
"ext_to_ovl_enter_bps": "count",
"ext_to_ovl_enter_pps": "count",
"ovl_to_vlan_leave_bytes": "count",
"ovl_to_vlan_leave_pkts": "count",
"ovl_to_vlan_leave_bps": "count",
"ovl_to_vlan_leave_pps": "count",
"vlan_to_ovl_enter_bytes": "count",
"vlan_to_ovl_enter_pkts": "count",
"vlan_to_ovl_enter_bps": "count",
"vlan_to_ovl_enter_pps": "count"
}

Status Codes

code description
200 Operation successful
204 No content
404 Not Found

/odgw/{odgwUUID}/ipv4

Mount Point: /controller/nb/v2/opendove/odmc/odgw/{odgwUUID}/ipv4

PUT

Creates odgw IPv4 Interface ("dovetunnel"/"external") on a service appliance

Parameters

name description type default
odgwUUID serivce appliance UUID to modify path

Request Body

element: openDoveGwIpv4Request
media types: application/json

(no documentation provided)

Response Body

element: openDoveServiceApplianceRequest
media types: application/json

Updated DGW IPv4 Interface information 


Example:

Request URL:
http://localhost:8080/controller/nb/v2/opendove/odgw/uuid/ipv4

Request body in JSON:
{
"gw_ipv4_assignment": {
"id"         : STRING
"ip"         : STRING
"mask"       : STRING
"nexthop"    : STRING
"intf_type"  : STRING  ("dovetunnel")
"vlan"       : INTEGER
}
}

Response body in JSON:
{
"gw_ipv4_assignment": {
"id"         : STRING
"ip"         : STRING
"nexthop"    : STRING
"mask"       : STRING
"intf_type"  : STRING  ("dovetunnel")
"gwUUID"     : STRING  ("dovetunnel")
"vlan"       : INTEGER
}
}

Status Codes

code description
200 Operation successful
204 No content
401 Unauthorized
409 DGW is in a Conflicted State
404 Not Found
500 Internal Error

/odgw/{odgwUUID}/role

Mount Point: /controller/nb/v2/opendove/odmc/odgw/{odgwUUID}/role

PUT

Sets/Resets the odgw service role on a service appliance

Parameters

name description type default
odgwUUID serivce appliance UUID to modify path

Request Body

element: openDoveServiceApplianceRequest
media types: application/json

(no documentation provided)

Response Body

element: openDoveServiceApplianceRequest
media types: application/json

Updated service appliance information 


Example:

Request URL:
http://localhost:8080/controller/nb/v2/opendove/odgw/uuid/role

Request body in JSON:
{
"service_appliance": {
"isDGW": true
}
}

Response body in JSON:
{
"service_appliance": {
"ip_family": 4,
"ip": "10.10.10.1",
"uuid": "uuid",
"dcs_rest_service_port": 1888,
"dgw_rest_service_port": 1888,
"dcs_raw_service_port": 932,
"timestamp": "now",
"build_version": "openDSA-1",
"dcs_config_version": 60,
"canBeDCS": true,
"canBeDGW": true,
"isDCS": false,
"isDGW": true
}
}

Status Codes

code description
200 Operation successful
204 No content
401 Unauthorized
409 DCS is in a Conflicted State
404 Not Found
500 Internal Error

/odgw/{odgwUUID}/session_stats

Mount Point: /controller/nb/v2/opendove/odmc/odgw/{odgwUUID}/session_stats

GET

Gets session statistics for a gateway

Parameters

name description type default
odgwUUID gateway UUID to interrogate path

Response Body

element: openDoveGWSessionStatsRequest
media types: application/json

statistics 


Example:

Request URL:
http://localhost:8080/controller/nb/v2/opendove/odgw/uuid/session_stats

Response body in JSON:
{
"sessions": [ {
"net_id": "%s",
"age": "%s",
"ovl_sip": "%s",
"ovl_dip": "%s",
"ovl_sport": %d,
"ovl_dport": %d,
"orig_sip": "%s",
"orig_dip": "%s",
"orig_sport": %d,
"orig_dport": %d,
"sip": "%s",
"dip": "%s",
"proto": %d,
"sport": %d,
"dport": %d,
"action": "%s",
"snat_ip": "%s",
"snat_port": %d
} ]
}

Status Codes

code description
200 Operation successful
204 No content
404 Not Found

/odgw/{odgwUUID}/vnid_stats/{vnid}

Mount Point: /controller/nb/v2/opendove/odmc/odgw/{odgwUUID}/vnid_stats/{vnid}

GET

Gets vnid statistics for a gateway

Parameters

name description type default
odgwUUID gateway UUID to interrogate path
vnid VNID to get statistics on path

Response Body

element: openDoveVNIDStats
media types: application/json

statistics 


Example:

Request URL:
http://localhost:8080/controller/nb/v2/opendove/odgw/uuid/allstats

Response body in JSON:
{
"net_id": "vnid",
"ovl_to_ext_leave_bytes": "count",
"ovl_to_ext_leave_pkts": "count",
"ovl_to_ext_leave_bps": "count",
"ovl_to_ext_leave_pps": "count",
"ext_to_ovl_enter_bytes": "count",
"ext_to_ovl_enter_pkts": "count",
"ext_to_ovl_enter_bps": "count",
"ext_to_ovl_enter_pps": "count",
"ovl_to_vlan_leave_bytes": "count",
"ovl_to_vlan_leave_pkts": "count",
"ovl_to_vlan_leave_bps": "count",
"ovl_to_vlan_leave_pps": "count",
"vlan_to_ovl_enter_bytes": "count",
"vlan_to_ovl_enter_pkts": "count",
"vlan_to_ovl_enter_bps": "count",
"vlan_to_ovl_enter_pps": "count"
}

Status Codes

code description
200 Operation successful
204 No content