docs/bgp/bgp-user-guide-route-refresh-capability.rst

   1 .. _bgp-user-guide-route-refresh-capability:
   2
   3 Route Refresh
   4 =============
   5 The Route Refresh Capability allows to dynamically request a re-advertisement of the Adj-RIB-Out from a BGP peer.
   6 This is useful when the inbound routing policy for a peer changes and all prefixes from a peer must be reexamined against a new policy.
   7
   8 .. contents:: Contents
   9    :depth: 2
  10    :local:
  11
  12 Configuration
  13 ^^^^^^^^^^^^^
  14 The capability is enabled by default, no additional configuration is required.
  15
  16 Usage
  17 ^^^^^
  18 To send a Route Refresh request from OpenDaylight BGP speaker instance to its neighbor, invoke RPC:
  19
  20 **URL:** ``/restconf/operations/bgp-peer-rpc:route-refresh-request``
  21
  22 **Method:** ``POST``
  23
  24 **Content-Type:** ``application/xml``
  25
  26 **Request Body:**
  27
  28 .. code-block:: xml
  29
  30    <input xmlns="urn:opendaylight:params:xml:ns:yang:bgp-peer-rpc">
  31        <afi xmlns:types="urn:opendaylight:params:xml:ns:yang:bgp-types">types:ipv4-address-family</afi>
  32        <safi xmlns:types="urn:opendaylight:params:xml:ns:yang:bgp-types">types:unicast-subsequent-address-family</safi>
  33        <peer-ref xmlns:rib="urn:opendaylight:params:xml:ns:yang:bgp-rib">/rib:bgp-rib/rib:rib[rib:id="bgp-example"]/rib:peer[rib:peer-id="bgp://10.25.1.9"]</peer-ref>
  34    </input>
  35
  36 References
  37 ^^^^^^^^^^
  38 * `Route Refresh Capability for BGP-4 <https://tools.ietf.org/html/rfc2918>`_
  39
  40 Peer Session Release
  41 --------------------
  42
  43 BGP provides a RPC feature to release a Neighbor session.
  44
  45 .. contents:: Contents
  46    :depth: 2
  47    :local:
  48
  49 Configuration
  50 ^^^^^^^^^^^^^
  51 The capability is enabled by default, no additional configuration is required.
  52
  53 Usage
  54 ^^^^^
  55 To release neighbor session, invoke RPC:
  56
  57 **URL:** ``/restconf/operations/bgp-peer-rpc:reset-session``
  58
  59 **Method:** ``POST``
  60
  61 **Content-Type:** ``application/xml``
  62
  63 **Request Body:**
  64
  65 .. code-block:: xml
  66
  67    <input xmlns="urn:opendaylight:params:xml:ns:yang:bgp-peer-rpc">
  68        <peer-ref xmlns:rib="urn:opendaylight:params:xml:ns:yang:bgp-rib">/rib:bgp-rib/rib:rib[rib:id="bgp-example"]/rib:peer[rib:peer-id="bgp://10.25.1.9"]</peer-ref>
  69    </input>