Fix ll graceful-restart-config
[bgpcep.git] / docs / bgp / bgp-user-guide-long-lived-graceful-restart-capability.rst
1 .. _bgp-user-guide-long-lived-graceful-restart-capability:
2
3 Long-Lived Graceful Restart Capability
4 ======================================
5 The Long-Lived Graceful Restart Capability is extension to Graceful Restart that provides tools to retain stale routes for longer time upon session failure.
6 New capability is advertised in OPEN message in conjunction with Graceful Restart Capability, which contains list of supported families and their stale timer.
7 After session failure and Graceful Restart timer expire routing information is retained for value of Long-Lived Stale Timer.
8
9 .. contents:: Contents
10    :depth: 2
11    :local:
12
13 Configuration
14 ^^^^^^^^^^^^^
15 Long-Live Graceful Restart is enabled and configured per family in *ll-graceful-restart* section of *neighbor* or *peer-group* family configuration.
16
17 **URL:** ``/restconf/config/openconfig-network-instance:network-instances/network-instance/global-bgp/openconfig-network-instance:protocols/protocol/openconfig-policy-types:BGP/bgp-example/bgp/neighbors/neighbor/192.0.2.1/afi-safis/afi-safi/openconfig-bgp-types:IPV4%2DUNICAST/graceful-restart``
18
19 or
20
21 **URL:** ``/restconf/config/openconfig-network-instance:network-instances/network-instance/global-bgp/openconfig-network-instance:protocols/protocol/openconfig-policy-types:BGP/bgp-example/bgp/peer-groups/peer-group/external-neighbors/afi-safis/afi-safi/openconfig-bgp-types:IPV4%2DUNICAST/graceful-restart``
22
23 **Method:** ``PUT``
24
25 **Content-Type:** ``application/xml``
26
27 **Request Body:**
28
29 .. code-block:: xml
30    :linenos:
31    :emphasize-lines: 3,6
32
33    <graceful-restart xmlns="urn:opendaylight:params:xml:ns:yang:bgp:openconfig-extensions">
34       <config>
35          <enable>true</enable>
36          <ll-graceful-restart xmlns="urn:opendaylight:params:xml:ns:yang:bgp:ll-graceful-restart">
37              <config>
38                  <long-lived-stale-time>180</long-lived-stale-time>
39              </config>
40          </ll-graceful-restart>
41        </config>
42    </graceful-restart>
43
44 @line 3: if Graceful Restart support is disabled for family only procedures for Long-Lived Graceful Restart applies
45
46 @line 6: value of Long-Lived Stale timer in seconds
47
48 References
49 ^^^^^^^^^^
50 * `Support for Long-lived BGP Graceful Restart <https://tools.ietf.org/html/draft-uttaro-idr-bgp-persistence-04>`_