doc/user/eigrpd.rst

   1 .. _eigrp:
   2
   3 *****
   4 EIGRP
   5 *****
   6
   7 .. glossary::
   8
   9    DUAL
  10       The *Diffusing Update ALgorithm*, a :term:`Bellman-Ford` based routing
  11       algorithm used by EIGRP.
  12
  13 EIGRP -- Routing Information Protocol is widely deployed interior gateway
  14 routing protocol. EIGRP was developed in the 1990's. EIGRP is a
  15 :term:`distance-vector` protocol and is based on the :term:`DUAL` algorithms.
  16 As a distance-vector protocol, the EIGRP router send updates to its
  17 neighbors as networks change, thus allowing the convergence to a
  18 known topology.
  19
  20 *eigrpd* supports EIGRP as described in RFC7868
  21
  22 .. _starting-and-stopping-eigrpd:
  23
  24 Starting and Stopping eigrpd
  25 ============================
  26
  27 The default configuration file name of *eigrpd*'s is :file:`eigrpd.conf`. When
  28 invocation *eigrpd* searches directory |INSTALL_PREFIX_ETC|. If
  29 :file:`eigrpd.conf` is not there next search current directory. If an
  30 integrated config is specified configuration is written into :file:`frr.conf`.
  31
  32 The EIGRP protocol requires interface information maintained by *zebra* daemon.
  33 So running *zebra* is mandatory to run *eigrpd*. Thus minimum sequence for
  34 running EIGRP is:
  35
  36 ::
  37
  38   # zebra -d
  39   # eigrpd -d
  40
  41
  42 Please note that *zebra* must be invoked before *eigrpd*.
  43
  44 To stop *eigrpd*, please use ::
  45    kill `cat /var/run/eigrpd.pid`
  46
  47 Certain signals have special meanings to *eigrpd*.
  48
  49 +------------------+-----------------------------------------------------------+
  50 | Signal           | Meaning                                                   |
  51 +==================+===========================================================+
  52 | SIGHUP & SIGUSR1 | Rotate the log file                                       |
  53 +------------------+-----------------------------------------------------------+
  54 | SIGINT & SIGTERM | Sweep all installed EIGRP routes and gracefully terminate |
  55 +------------------+-----------------------------------------------------------+
  56
  57
  58 *eigrpd* invocation options. Common options that can be specified
  59 (:ref:`common-invocation-options`).
  60
  61 .. program:: eigrpd
  62
  63 .. _eigrp-configuration:
  64
  65 EIGRP Configuration
  66 ===================
  67
  68 .. clicmd:: router eigrp (1-65535) [vrf NAME]
  69
  70    The `router eigrp` command is necessary to enable EIGRP. To disable EIGRP,
  71    use the `no router eigrp (1-65535)` command. EIGRP must be enabled before
  72    carrying out any of the EIGRP commands.  Specify vrf NAME if you want
  73    eigrp to work within the specified vrf.
  74
  75 .. clicmd:: network NETWORK
  76
  77    Set the EIGRP enable interface by `network`. The interfaces which
  78    have addresses matching with `network` are enabled.
  79
  80    This group of commands either enables or disables EIGRP interfaces between
  81    certain numbers of a specified network address. For example, if the
  82    network for 10.0.0.0/24 is EIGRP enabled, this would result in all the
  83    addresses from 10.0.0.0 to 10.0.0.255 being enabled for EIGRP. The `no
  84    network` command will disable EIGRP for the specified network.
  85
  86    Below is very simple EIGRP configuration. Interface `eth0` and
  87    interface which address match to `10.0.0.0/8` are EIGRP enabled.
  88
  89    .. code-block:: frr
  90
  91       !
  92       router eigrp 1
  93        network 10.0.0.0/8
  94       !
  95
  96
  97 .. clicmd:: passive-interface (IFNAME|default)
  98
  99
 100    This command sets the specified interface to passive mode. On passive mode
 101    interface, all receiving packets are ignored and eigrpd does not send either
 102    multicast or unicast EIGRP packets except to EIGRP neighbors specified with
 103    `neighbor` command. The interface may be specified as `default` to make
 104    eigrpd default to passive on all interfaces.
 105
 106    The default is to be passive on all interfaces.
 107
 108 .. _how-to-announce-eigrp-route:
 109
 110 How to Announce EIGRP route
 111 ===========================
 112
 113 Redistribute routes into EIGRP:
 114
 115 .. clicmd:: redistribute <babel|bgp|connected|isis|kernel|openfabric|ospf|rip|sharp|static|table> [metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)]
 116
 117    The ``redistribute`` family of commands imports routing information from
 118    other sources into EIGRP's tables. Redistribution may be disabled with the
 119    ``no`` form of the commands.
 120
 121    Note that connected routes on interfaces EIGRP is enabled on are announced
 122    by default.
 123
 124    Optionally, various EIGRP metrics may be specified. These metrics will be
 125    applied to the imported routes.
 126
 127
 128 .. _show-eigrp-information:
 129
 130 Show EIGRP Information
 131 ======================
 132
 133 .. clicmd:: show ip eigrp [vrf NAME] topology
 134
 135    Display current EIGRP status.
 136
 137    ::
 138
 139       eigrpd> **show ip eigrp topology**
 140       # show ip eigrp topo
 141
 142       EIGRP Topology Table for AS(4)/ID(0.0.0.0)
 143
 144       Codes: P - Passive, A - Active, U - Update, Q - Query, R - Reply
 145              r - reply Status, s - sia Status
 146
 147       P  10.0.2.0/24, 1 successors, FD is 256256, serno: 0
 148              via Connected, enp0s3
 149
 150 .. clicmd:: show ip eigrp [vrf NAME] interface
 151
 152    Display the list of interfaces associated with a particular eigrp
 153    instance.
 154
 155 .. clicmd:: show ip eigrp [vrf NAME] neighbor
 156
 157    Display the list of neighbors that have been established within
 158    a particular eigrp instance.
 159
 160 EIGRP Debug Commands
 161 ====================
 162
 163 Debug for EIGRP protocol.
 164
 165 .. clicmd:: debug eigrp packets
 166
 167    Debug eigrp packets
 168
 169    ``debug eigrp`` will show EIGRP packets that are sent and received.
 170
 171 .. clicmd:: debug eigrp transmit
 172
 173    Debug eigrp transmit events
 174
 175    ``debug eigrp transmit`` will display detailed information about the EIGRP
 176    transmit events.
 177
 178 .. clicmd:: show debugging eigrp
 179
 180    Display *eigrpd*'s debugging option.
 181
 182    ``show debugging eigrp`` will show all information currently set for eigrpd
 183    debug.
 184
 185
 186 Sample configuration
 187 ====================
 188
 189 .. code-block:: frr
 190
 191    hostname eigrpd
 192    password zebra
 193    enable password please-set-at-here
 194    !
 195    router eigrp 4453
 196      network 192.168.1.0/24
 197    !
 198    log stdout
 199