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