Update SXP user guide for Fluorine 46/74946/5
authorIvan Hrasko <ihrasko@cisco.com>
Wed, 8 Aug 2018 13:52:23 +0000 (15:52 +0200)
committerIvan Hrasko <ihrasko@cisco.com>
Tue, 14 Aug 2018 06:31:31 +0000 (06:31 +0000)
Change-Id: I9b64c20e43bfa17fe3338ef097417b4a1dcd6d61
Signed-off-by: Ivan Hrasko <ihrasko@cisco.com>
docs/user-guide/sxp-user-guide.rst

index ea2ce60ed85c9be80e9049260492e33814c34ab5..43ec3427c8a5a1a3f1920aa1484a663f488aeca7 100644 (file)
@@ -11,7 +11,7 @@ OpenDaylight platform with IP-SGT (IP Address to Source Group Tag)
 bindings that can be learned from connected SXP-aware network nodes. The
 current implementation supports SXP protocol version 4 according to the
 Smith, Kandula - SXP `IETF
-draft <https://tools.ietf.org/html/draft-smith-kandula-sxp-05>`__ and
+draft <https://tools.ietf.org/html/draft-smith-kandula-sxp-06>`__ and
 grouping of peers and creating filters based on ACL/Prefix-list syntax
 for filtering outbound and inbound IP-SGT bindings. All protocol legacy
 versions 1-3 are supported as well. Additionally, version 4 adds
@@ -58,11 +58,7 @@ SXP-Domains by ACL, Prefix List or Peer-Sequence filters
 Configuring SXP
 ---------------
 
-The OpenDaylight Karaf distribution comes pre-configured with baseline
-SXP configuration. Configuration of SXP Nodes is also possible via
-NETCONF.
-
--  **22-sxp-controller-one-node.xml** (defines the basic parameters)
+SXP requires no manual configuration.
 
 Administering or Managing SXP
 -----------------------------
@@ -137,46 +133,45 @@ status):
      <peer-address>172.20.161.50</peer-address>
     </input>
 
--  Add Binding Entry POST
-   http://127.0.0.1:8181/restconf/operations/sxp-controller:add-entry
+-  Add/Update Bindings POST
+   http://127.0.0.1:8181/restconf/operations/sxp-controller:add-bindings
 
 ::
 
-    <input xmlns:xsi="urn:opendaylight:sxp:controller">
-     <requested-node>0.0.0.100</requested-node>
-     <domain-name>global</domain-name>
-     <ip-prefix>192.168.2.1/32</ip-prefix>
-     <sgt>20</sgt >
-    </input>
-
--  Update Binding Entry POST
-   http://127.0.0.1:8181/restconf/operations/sxp-controller:update-entry
-
-::
-
-    <input xmlns:xsi="urn:opendaylight:sxp:controller">
-     <requested-node>0.0.0.100</requested-node>
-     <domain-name>global</domain-name>
-     <original-binding>
-      <ip-prefix>192.168.2.1/32</ip-prefix>
-      <sgt>20</sgt>
-     </original-binding>
-     <new-binding>
-      <ip-prefix>192.168.3.1/32</ip-prefix>
-      <sgt>30</sgt>
-     </new-binding>
+    <input xmlns="urn:opendaylight:sxp:controller">
+      <node-id>0.0.0.100</node-id>
+      <domain-name>global</domain-name>
+      <origin>LOCAL</origin>
+      <master-database>
+        <binding>
+          <sgt>50</sgt>
+          <ip-prefix>192.168.2.1/32</ip-prefix>
+          <ip-prefix>192.168.2.2/32</ip-prefix>
+        </binding>
+        <binding>
+          <sgt>100</sgt>
+          <ip-prefix>192.168.3.1/32</ip-prefix>
+          <ip-prefix>192.168.3.2/32</ip-prefix>
+        </binding>
+      </master-database>
     </input>
 
--  Delete Binding Entry POST
-   http://127.0.0.1:8181/restconf/operations/sxp-controller:delete-entry
+-  Delete Bindings POST
+   http://127.0.0.1:8181/restconf/operations/sxp-controller:delete-bindings
 
 ::
 
-    <input xmlns:xsi="urn:opendaylight:sxp:controller">
-     <requested-node>0.0.0.100</requested-node>
-     <domain-name>global</domain-name>
-     <ip-prefix>192.168.3.1/32</ip-prefix>
-     <sgt>30</sgt >
+    <input xmlns="urn:opendaylight:sxp:controller">
+      <node-id>0.0.0.100</node-id>
+      <domain-name>global</domain-name>
+      <binding>
+        <sgt>50</sgt>
+        <ip-prefix>192.168.2.2/32</ip-prefix>
+      </binding>
+      <binding>
+        <sgt>100</sgt>
+        <ip-prefix>192.168.3.2/32</ip-prefix>
+      </binding>
     </input>
 
 -  Get Node Bindings
@@ -327,26 +322,25 @@ status):
 ::
 
     <input xmlns="urn:opendaylight:sxp:controller">
-        <node-id>1.1.1.1</node-id>
-        <source-ip>0.0.0.0</source-ip>
-        <timers>
-            <retry-open-time>5</retry-open-time>
-            <hold-time-min-acceptable>120</hold-time-min-acceptable>
-            <delete-hold-down-time>120</delete-hold-down-time>
-            <hold-time-min>90</hold-time-min>
-            <reconciliation-time>120</reconciliation-time>
-            <hold-time>90</hold-time>
-            <hold-time-max>180</hold-time-max>
-            <keep-alive-time>30</keep-alive-time>
-        </timers>
-        <mapping-expanded>150</mapping-expanded>
-        <security>
-            <password>password</password>
-        </security>
-        <tcp-port>64999</tcp-port>
-        <version>version4</version>
-        <description>ODL SXP Controller</description>
-        <master-database></master-database>
+      <node-id>1.1.1.1</node-id>
+      <source-ip>0.0.0.0</source-ip>
+      <timers>
+        <retry-open-time>5</retry-open-time>
+        <hold-time-min-acceptable>120</hold-time-min-acceptable>
+        <delete-hold-down-time>120</delete-hold-down-time>
+        <hold-time-min>90</hold-time-min>
+        <reconciliation-time>120</reconciliation-time>
+        <hold-time>90</hold-time>
+        <hold-time-max>180</hold-time-max>
+        <keep-alive-time>30</keep-alive-time>
+      </timers>
+      <mapping-expanded>150</mapping-expanded>
+      <security>
+        <password>password</password>
+      </security>
+      <tcp-port>64999</tcp-port>
+      <version>version4</version>
+      <description>ODL SXP Controller</description>
     </input>
 
 -  Delete SXP aware node POST
@@ -384,11 +378,11 @@ status):
 ::
 
     <sxp-cluster-route xmlns="urn:opendaylight:sxp:cluster:route">
-        <routing-definition>
-            <ip-address>80.12.43.2</ip-address>
-            <interface>eth1:0</interface>
-            <netmask>255.255.255.0</netmask>
-        </routing-definition>
+      <routing-definition>
+        <ip-address>80.12.43.2</ip-address>
+        <interface>eth1:0</interface>
+        <netmask>255.255.255.0</netmask>
+      </routing-definition>
     </sxp-cluster-route>
 
 Use cases for SXP
@@ -451,4 +445,3 @@ bringing the ability of OpenDaylight to process and distribute the
 bindings, is a very specific immediate useful implementation of policy
 groups. It would go a long way to develop both the usefulness of
 OpenDaylight and of policy groups.
-