manuals/developer-guide/src/main/asciidoc/ovsdb/ovsdb-northbound-developer.adoc

   1 == OVSDB Northbound Developer Guide
   2
   3 === Overview
   4 The OVSDB Northbound feature's goal is to give low level access to
   5 an OVS instance. For instance, one would like to be able to directly create, read, update and delete rows into an OVS instance by using RESTCONF.
   6
   7 The target audience for this feature is one that needs low level
   8 access to an OVS instance from inside OpenDaylight
   9
  10 === OVSDB Northbound Developer Architecture
  11 The northbound bundle architecture is as follow:
  12
  13 - mdsal-northbound-aggregator
  14
  15 - mdsal-northbound-api
  16
  17 - mdsal-northbound-impl
  18
  19 - mdsal-northbound-features
  20
  21
  22 === Key APIs and Interfaces
  23 [width="80%",cols="10%,10%,10%,70%"]
  24 |=======
  25 |Type | Action | Input | URL
  26 |PUT | Insert Row |Row Data | restconf/config/network-topology:network-topology/topology/ovsdb:1/\{nodeId\}/tables/\{tableName\}/rows
  27 |GET | Show Row |N/A | restconf/config/network-topology:network-topology/topology/ovsdb:1/\{nodeId\}/tables/\{tableName\}/rows/\{rowUuid\}
  28 |GET | Show All Row |N/A | restconf/config/network-topology:network-topology/topology/ovsdb:1/\{nodeId\}/tables/\{tableName\}/rows
  29 |PUT | Update Row |Row Data | restconf/config/network-topology:network-topology/topology/ovsdb:1/\{nodeId\}/tables/\{tableName\}/rows/\{rowUuid\}
  30 |DELETE | Delete Row |N/A | restconf/config/network-topology:network-topology/topology/ovsdb:1/\{nodeId\}/tables/\{tableName\}/rows/\{rowUuid\}
  31 |=======