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 .. index:: router eigrp (1-65535)
  69 .. clicmd:: router eigrp (1-65535)
  70
  71    The `router eigrp` command is necessary to enable EIGRP. To disable EIGRP,
  72    use the `no router eigrp (1-65535)` command. EIGRP must be enabled before
  73    carrying out any of the EIGRP commands.
  74
  75 .. index:: no router eigrp (1-65535)
  76 .. clicmd:: no router eigrp (1-65535)
  77
  78    Disable EIGRP.
  79
  80 .. index:: network NETWORK
  81 .. clicmd:: network NETWORK
  82
  83 .. index:: no network NETWORK
  84 .. clicmd:: no network NETWORK
  85
  86    Set the EIGRP enable interface by `network`. The interfaces which
  87    have addresses matching with `network` are enabled.
  88
  89    This group of commands either enables or disables EIGRP interfaces between
  90    certain numbers of a specified network address. For example, if the
  91    network for 10.0.0.0/24 is EIGRP enabled, this would result in all the
  92    addresses from 10.0.0.0 to 10.0.0.255 being enabled for EIGRP. The `no
  93    network` command will disable EIGRP for the specified network.
  94
  95    Below is very simple EIGRP configuration. Interface `eth0` and
  96    interface which address match to `10.0.0.0/8` are EIGRP enabled.
  97
  98    .. code-block:: frr
  99
 100       !
 101       router eigrp 1
 102        network 10.0.0.0/8
 103       !
 104
 105
 106 .. index:: passive-interface (IFNAME|default)
 107 .. clicmd:: passive-interface (IFNAME|default)
 108
 109 .. index:: no passive-interface IFNAME
 110 .. clicmd:: no passive-interface IFNAME
 111
 112    This command sets the specified interface to passive mode. On passive mode
 113    interface, all receiving packets are ignored and eigrpd does not send either
 114    multicast or unicast EIGRP packets except to EIGRP neighbors specified with
 115    `neighbor` command. The interface may be specified as `default` to make
 116    eigrpd default to passive on all interfaces.
 117
 118    The default is to be passive on all interfaces.
 119
 120 .. _how-to-announce-eigrp-route:
 121
 122 How to Announce EIGRP route
 123 ===========================
 124
 125 .. index:: redistribute kernel
 126 .. clicmd:: redistribute kernel
 127
 128 .. index:: redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
 129 .. clicmd:: redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
 130
 131 .. index:: no redistribute kernel
 132 .. clicmd:: no redistribute kernel
 133
 134    `redistribute kernel` redistributes routing information from kernel route
 135    entries into the EIGRP tables. `no redistribute kernel` disables the routes.
 136
 137 .. index:: redistribute static
 138 .. clicmd:: redistribute static
 139
 140 .. index:: redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
 141 .. clicmd:: redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
 142
 143 .. index:: no redistribute static
 144 .. clicmd:: no redistribute static
 145
 146    `redistribute static` redistributes routing information from static route
 147    entries into the EIGRP tables. `no redistribute static` disables the routes.
 148
 149 .. index:: redistribute connected
 150 .. clicmd:: redistribute connected
 151
 152 .. index:: redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
 153 .. clicmd:: redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
 154
 155 .. index:: no redistribute connected
 156 .. clicmd:: no redistribute connected
 157
 158    Redistribute connected routes into the EIGRP tables. `no redistribute
 159    connected` disables the connected routes in the EIGRP tables. This command
 160    redistribute connected of the interface which EIGRP disabled. The connected
 161    route on EIGRP enabled interface is announced by default.
 162
 163 .. index:: redistribute ospf
 164 .. clicmd:: redistribute ospf
 165
 166 .. index:: redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
 167 .. clicmd:: redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
 168
 169 .. index:: no redistribute ospf
 170 .. clicmd:: no redistribute ospf
 171
 172    `redistribute ospf` redistributes routing information from ospf route
 173    entries into the EIGRP tables. `no redistribute ospf` disables the routes.
 174
 175 .. index:: redistribute bgp
 176 .. clicmd:: redistribute bgp
 177
 178 .. index:: redistribute bgp metric  (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
 179 .. clicmd:: redistribute bgp metric  (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)
 180
 181 .. index:: no redistribute bgp
 182 .. clicmd:: no redistribute bgp
 183
 184    `redistribute bgp` redistributes routing information from bgp route entries
 185    into the EIGRP tables. `no redistribute bgp` disables the routes.
 186
 187 .. _show-eigrp-information:
 188
 189 Show EIGRP Information
 190 ======================
 191
 192 .. index:: show ip eigrp topology
 193 .. clicmd:: show ip eigrp topology
 194
 195    Display current EIGRP status.
 196
 197    ::
 198
 199       eigrpd> **show ip eigrp topology**
 200       # show ip eigrp topo
 201
 202       EIGRP Topology Table for AS(4)/ID(0.0.0.0)
 203
 204       Codes: P - Passive, A - Active, U - Update, Q - Query, R - Reply
 205              r - reply Status, s - sia Status
 206
 207       P  10.0.2.0/24, 1 successors, FD is 256256, serno: 0
 208              via Connected, enp0s3
 209
 210
 211 EIGRP Debug Commands
 212 ====================
 213
 214 Debug for EIGRP protocol.
 215
 216 .. index:: debug eigrp packets
 217 .. clicmd:: debug eigrp packets
 218
 219    Debug eigrp packets
 220
 221    ``debug eigrp`` will show EIGRP packets that are sent and received.
 222
 223 .. index:: debug eigrp transmit
 224 .. clicmd:: debug eigrp transmit
 225
 226    Debug eigrp transmit events
 227
 228    ``debug eigrp transmit`` will display detailed information about the EIGRP
 229    transmit events.
 230
 231 .. index:: show debugging eigrp
 232 .. clicmd:: show debugging eigrp
 233
 234    Display *eigrpd*'s debugging option.
 235
 236    ``show debugging eigrp`` will show all information currently set for eigrpd
 237    debug.
 238