Merge "Route reflector cluster id doc"
[docs.git] / docs / user-guide / bgpcep-guide / bgp / bgp-user-guide-running-bgp.rst
1 .. _bgp-user-guide-running-bgp:
2
3 Running BGP
4 ===========
5 This section explains how to install BGP plugin.
6
7 1. Install BGP feature - ``odl-bgpcep-bgp``.
8    Also, for sake of this sample, it is required to install RESTCONF.
9    In the Karaf console, type command:
10
11    .. code-block:: console
12
13       feature:install odl-restconf odl-bgpcep-bgp
14
15 2. The BGP plugin contains a default configuration, which is applied after the feature starts up.
16    One instance of BGP plugin is created (named *example-bgp-rib*), and its presence can be verified via REST:
17
18    **URL:** ``/restconf/operational/bgp-rib:bgp-rib``
19
20    **Method:** ``GET``
21
22    **Response Body:**
23
24    .. code-block:: xml
25
26       <bgp-rib xmlns="urn:opendaylight:params:xml:ns:yang:bgp-rib">
27          <rib>
28              <id>example-bgp-rib</id>
29              <loc-rib>
30              ....
31              </loc-rib>
32          </rib>
33       </bgp-rib>