doc/user/eigrpd.rst

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