opendaylight web service REST api

Section 1. Get familiar with ODL REST API

MD-SAL cannot provide doc. of REST APIs, because the API are generated at runtime based on YANG models. Then how to get acknowledge of REST APIs? You can access it by

http://localhost:8080/apidoc/explorer

or in karaf
http://localhost:8181/apidoc/explorer/index.html

 

These REST APIs are designed on RESTCONF protocol, a OSDI bundle named RESTCONF API Explorer [1] that can be deployed in ODL to generate doc. based on Swagger specification [2].

The above tips are what the ODL wiki [3] said on MD-SAL's RESTconf API. Some northbound APIs does not work well. The webpage [4] shows some northbound APIs of MD-SAL, however I cannot open the URL as the certification of the web is not registered yet. When I google the oepndaylight REST APIs, I get [5] with full of nonexistent links.

[1] https://datatracker.ietf.org/doc/draft-bierman-netconf-restconf/
[2] https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md
[3] https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:Restconf_API_Explorer
[4] https://wiki.opendaylight.org/view/OpenDaylight_Controller:RESTCONF_Northbound_APIs
[5] https://wiki.opendaylight.org/view/OpenDaylight_Controller:REST_Reference_and_Authentication

Section 2. Example of VTN manager

You can understand the following works easily, after you get familiar with the ODL ws (web service) REST api.

   

1. This page describes examples on how to configure VTN Manager for Service Chaining.

OpenDaylight Virtual Tenant Network (VTN):How to Configure Service Function Chaining using VTN

2. This page describes the various Mininet Scripts that are used in examples for VTN usage.

OpenDaylight Virtual Tenant Network (VTN):Scripts:Mininet