Code Review / docs.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Merge "Boron update of SXP aDocs"
[docs.git] / manuals / user-guide / src / main / asciidoc / bgpcep / odl-bgpcep-bgp-all-user.adoc
diff --git a/manuals/user-guide/src/main/asciidoc/bgpcep/odl-bgpcep-bgp-all-user.adoc b/manuals/user-guide/src/main/asciidoc/bgpcep/odl-bgpcep-bgp-all-user.adoc
index 97dad514269f98a5a8d1f92464538a1e7d0ab905..65b4d83cfae069209a39981220a5a3afe69be187 100644 (file)
--- a/manuals/user-guide/src/main/asciidoc/bgpcep/odl-bgpcep-bgp-all-user.adoc
+++ b/manuals/user-guide/src/main/asciidoc/bgpcep/odl-bgpcep-bgp-all-user.adoc
@@ -67,7 +67,7 @@ uncomment the module containing bgp-peer.
  <holdtimer>180</holdtimer>
  <peer-role>ibgp</peer-role>
  <rib>
-  <type xmlns:prefix="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:cfg">prefix:rib</type>
+  <type xmlns:prefix="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">prefix:rib-instance</type>
   <name>example-bgp-rib</name>
  </rib>
  ...
@@ -220,9 +220,11 @@ used in BGP Best Path Selection algorithm.
 - *target-rib* - RIB ID of existing RIB where the data should be transferred
 - *application-rib-id* - RIB ID of local application RIB (all the routes that you put to OpenDaylight will be displayed here)
 
-To populate RIB use //TODO: internal link to Populate RIB
+//TODO: internal link to Populate RIB
+//To populate RIB use 
 
-In order to get routes advertised to other peers, you have to also configure the peers, as described in section BGP Peer //TODO: internal jump to section?
+//TODO: internal jump to section?
+//In order to get routes advertised to other peers, you have to also configure the peers, as described in section BGP Peer 
 
 === Configuration through RESTCONF ===
 
@@ -239,6 +241,8 @@ This URL is also used to POST new configuration. If you want to change any
 other configuration that is listed here, make sure you include the correct
 namespaces. RESTCONF will tell you if some namespace is wrong.
 
+To update  an existing configuration use *PUT* and give the full path to the element you  wish to update.
+
 It is vital that you respect the order of steps described in user guide.
 
 ==== RIB ====
@@ -247,14 +251,62 @@ First, configure RIB. This module is already present in the configuration,
 therefore we change only the parameters we need. In this case, it's
 *bgp-rib-id* and *local-as*.
 
-.*POST:*
+*URL:* _
+_http://127.0.0.1:8181/restconf/config/network-topology:network-topology/topology/topology-netconf/node/controller-config/yang-ext:mount/config:modules/module/odl-bgp-rib-impl-cfg:rib-impl/example-bgp-rib_
+
+*PUT:*
 [source,xml]
 ----
 <module xmlns="urn:opendaylight:params:xml:ns:yang:controller:config">
-  <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">x:rib-impl</type>
-  <name>example-bgp-rib</name>
-  <bgp-rib-id xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">192.0.2.2</bgp-rib-id>
-  <local-as xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">64496</local-as>
+ <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">x:rib-impl</type>
+ <name>example-bgp-rib</name>
+ <session-reconnect-strategy xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">
+  <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:protocol:framework">x:reconnect-strategy-factory</type>
+  <name>example-reconnect-strategy-factory</name>
+ </session-reconnect-strategy>
+ <rib-id xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">example-bgp-rib</rib-id>
+ <extensions xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">
+  <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:spi">x:extensions</type>
+  <name>global-rib-extensions</name>
+ </extensions>
+ <codec-tree-factory xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">
+  <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:md:sal:binding">x:binding-codec-tree-factory</type>
+  <name>runtime-mapping-singleton</name>
+ </codec-tree-factory>
+ <tcp-reconnect-strategy xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">
+  <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:protocol:framework">x:reconnect-strategy-factory</type>
+  <name>example-reconnect-strategy-factory</name>
+ </tcp-reconnect-strategy>
+ <data-provider xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">
+  <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:md:sal:binding">x:binding-async-data-broker</type>
+  <name>pingpong-binding-data-broker</name>
+ </data-provider>
+ <local-as xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">64496</local-as>
+ <bgp-dispatcher xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">
+  <type>bgp-dispatcher</type>
+  <name>global-bgp-dispatcher</name>
+ </bgp-dispatcher>
+ <dom-data-provider xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">
+  <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom">x:dom-async-data-broker</type>
+  <name>pingpong-broker</name>
+ </dom-data-provider>
+ <local-table xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">
+  <type>bgp-table-type</type>
+  <name>ipv4-unicast</name>
+ </local-table>
+ <local-table xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">
+  <type>bgp-table-type</type>
+  <name>ipv6-unicast</name>
+ </local-table>
+ <local-table xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">
+  <type>bgp-table-type</type>
+  <name>linkstate</name>
+ </local-table>
+ <local-table xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">
+  <type>bgp-table-type</type>
+  <name>flowspec</name>
+ </local-table>
+ <bgp-rib-id xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">192.0.2.2</bgp-rib-id>
 </module>
 ----
 
@@ -262,7 +314,9 @@ IMPORTANT: MIGHT NOT BE NEEDED depending on your BGP router, you might need a
 switch from linkstate attribute type 99 to 29. Check with your router vendor.
 Switch the field to true if your router supports type 29.
 
-.*POST:*
+*URL:* _http://127.0.0.1:8181/restconf/config/network-topology:network-topology/topology/topology-netconf/node/controller-config/yang-ext:mount/config:modules/module/odl-bgp-linkstate-cfg:bgp-linkstate/bgp-linkstate_
+
+*PUT:*
 [source,xml]
 ----
 <module xmlns="urn:opendaylight:params:xml:ns:yang:controller:config">
@@ -289,7 +343,7 @@ and *peer-role* (if necessary).
  <holdtimer xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">180</holdtimer>
  <peer-role xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">ibgp</peer-role>
  <rib xmlns"urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">
-  <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:cfg">x:rib</type>
+  <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">x:rib-instance</type>
   <name>example-bgp-rib</name>
  </rib>
  <peer-registry xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">
@@ -335,14 +389,12 @@ BGP Best Path Selection algorithm.
   </target-rib>
  <application-rib-id xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">example-app-rib</application-rib-id>
  <data-broker xmlns="urn:opendaylight:params:xml:ns:yang:controller:bgp:rib:impl">
-  <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:md:sal:binding">x:binding-async-data-broker</type>
-  <name>pingpong-binding-data-broker</name>
+  <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:md:sal:dom">x:dom-async-data-broker</type>
+  <name>pingpong-broker</name>
  </data-broker>
 </module>
 ----
 
-To populate the RIB through the RESTCONF : //TODO: internal link to Populate RIB
-
 === Tutorials ===
 
 ==== Viewing BGP Topology ====
@@ -447,7 +499,7 @@ If your peer is configured, you can populate the RIB by making following POST ca
 [source,xml]
 ----
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<ipv4-routes xmlns="urn:opendaylight:params:xml:ns:yang:bgp-rib">
+<ipv4-routes xmlns="urn:opendaylight:params:xml:ns:yang:bgp-inet">
  <ipv4-route>
   <prefix>200.20.160.1/32</prefix>
   <attributes>
OpenDaylight Documentation