1da566630831729f47734751ae4677a96e6f2f18
[linux-2.6.git] / Documentation / networking / bonding.txt
1
2                 Linux Ethernet Bonding Driver HOWTO
3
4                 Latest update: 24 April 2006
5
6 Initial release : Thomas Davis <tadavis at lbl.gov>
7 Corrections, HA extensions : 2000/10/03-15 :
8   - Willy Tarreau <willy at meta-x.org>
9   - Constantine Gavrilov <const-g at xpert.com>
10   - Chad N. Tindel <ctindel at ieee dot org>
11   - Janice Girouard <girouard at us dot ibm dot com>
12   - Jay Vosburgh <fubar at us dot ibm dot com>
13
14 Reorganized and updated Feb 2005 by Jay Vosburgh
15 Added Sysfs information: 2006/04/24
16   - Mitch Williams <mitch.a.williams at intel.com>
17
18 Introduction
19 ============
20
21         The Linux bonding driver provides a method for aggregating
22 multiple network interfaces into a single logical "bonded" interface.
23 The behavior of the bonded interfaces depends upon the mode; generally
24 speaking, modes provide either hot standby or load balancing services.
25 Additionally, link integrity monitoring may be performed.
26         
27         The bonding driver originally came from Donald Becker's
28 beowulf patches for kernel 2.0. It has changed quite a bit since, and
29 the original tools from extreme-linux and beowulf sites will not work
30 with this version of the driver.
31
32         For new versions of the driver, updated userspace tools, and
33 who to ask for help, please follow the links at the end of this file.
34
35 Table of Contents
36 =================
37
38 1. Bonding Driver Installation
39
40 2. Bonding Driver Options
41
42 3. Configuring Bonding Devices
43 3.1     Configuration with Sysconfig Support
44 3.1.1           Using DHCP with Sysconfig
45 3.1.2           Configuring Multiple Bonds with Sysconfig
46 3.2     Configuration with Initscripts Support
47 3.2.1           Using DHCP with Initscripts
48 3.2.2           Configuring Multiple Bonds with Initscripts
49 3.3     Configuring Bonding Manually with Ifenslave
50 3.3.1           Configuring Multiple Bonds Manually
51 3.4     Configuring Bonding Manually via Sysfs
52
53 4. Querying Bonding Configuration
54 4.1     Bonding Configuration
55 4.2     Network Configuration
56
57 5. Switch Configuration
58
59 6. 802.1q VLAN Support
60
61 7. Link Monitoring
62 7.1     ARP Monitor Operation
63 7.2     Configuring Multiple ARP Targets
64 7.3     MII Monitor Operation
65
66 8. Potential Trouble Sources
67 8.1     Adventures in Routing
68 8.2     Ethernet Device Renaming
69 8.3     Painfully Slow Or No Failed Link Detection By Miimon
70
71 9. SNMP agents
72
73 10. Promiscuous mode
74
75 11. Configuring Bonding for High Availability
76 11.1    High Availability in a Single Switch Topology
77 11.2    High Availability in a Multiple Switch Topology
78 11.2.1          HA Bonding Mode Selection for Multiple Switch Topology
79 11.2.2          HA Link Monitoring for Multiple Switch Topology
80
81 12. Configuring Bonding for Maximum Throughput
82 12.1    Maximum Throughput in a Single Switch Topology
83 12.1.1          MT Bonding Mode Selection for Single Switch Topology
84 12.1.2          MT Link Monitoring for Single Switch Topology
85 12.2    Maximum Throughput in a Multiple Switch Topology
86 12.2.1          MT Bonding Mode Selection for Multiple Switch Topology
87 12.2.2          MT Link Monitoring for Multiple Switch Topology
88
89 13. Switch Behavior Issues
90 13.1    Link Establishment and Failover Delays
91 13.2    Duplicated Incoming Packets
92
93 14. Hardware Specific Considerations
94 14.1    IBM BladeCenter
95
96 15. Frequently Asked Questions
97
98 16. Resources and Links
99
100
101 1. Bonding Driver Installation
102 ==============================
103
104         Most popular distro kernels ship with the bonding driver
105 already available as a module and the ifenslave user level control
106 program installed and ready for use. If your distro does not, or you
107 have need to compile bonding from source (e.g., configuring and
108 installing a mainline kernel from kernel.org), you'll need to perform
109 the following steps:
110
111 1.1 Configure and build the kernel with bonding
112 -----------------------------------------------
113
114         The current version of the bonding driver is available in the
115 drivers/net/bonding subdirectory of the most recent kernel source
116 (which is available on http://kernel.org).  Most users "rolling their
117 own" will want to use the most recent kernel from kernel.org.
118
119         Configure kernel with "make menuconfig" (or "make xconfig" or
120 "make config"), then select "Bonding driver support" in the "Network
121 device support" section.  It is recommended that you configure the
122 driver as module since it is currently the only way to pass parameters
123 to the driver or configure more than one bonding device.
124
125         Build and install the new kernel and modules, then continue
126 below to install ifenslave.
127
128 1.2 Install ifenslave Control Utility
129 -------------------------------------
130
131         The ifenslave user level control program is included in the
132 kernel source tree, in the file Documentation/networking/ifenslave.c.
133 It is generally recommended that you use the ifenslave that
134 corresponds to the kernel that you are using (either from the same
135 source tree or supplied with the distro), however, ifenslave
136 executables from older kernels should function (but features newer
137 than the ifenslave release are not supported).  Running an ifenslave
138 that is newer than the kernel is not supported, and may or may not
139 work.
140
141         To install ifenslave, do the following:
142
143 # gcc -Wall -O -I/usr/src/linux/include ifenslave.c -o ifenslave
144 # cp ifenslave /sbin/ifenslave
145
146         If your kernel source is not in "/usr/src/linux," then replace
147 "/usr/src/linux/include" in the above with the location of your kernel
148 source include directory.
149
150         You may wish to back up any existing /sbin/ifenslave, or, for
151 testing or informal use, tag the ifenslave to the kernel version
152 (e.g., name the ifenslave executable /sbin/ifenslave-2.6.10).
153
154 IMPORTANT NOTE:
155
156         If you omit the "-I" or specify an incorrect directory, you
157 may end up with an ifenslave that is incompatible with the kernel
158 you're trying to build it for.  Some distros (e.g., Red Hat from 7.1
159 onwards) do not have /usr/include/linux symbolically linked to the
160 default kernel source include directory.
161
162 SECOND IMPORTANT NOTE:
163         If you plan to configure bonding using sysfs, you do not need
164 to use ifenslave.
165
166 2. Bonding Driver Options
167 =========================
168
169         Options for the bonding driver are supplied as parameters to
170 the bonding module at load time.  They may be given as command line
171 arguments to the insmod or modprobe command, but are usually specified
172 in either the /etc/modules.conf or /etc/modprobe.conf configuration
173 file, or in a distro-specific configuration file (some of which are
174 detailed in the next section).
175
176         The available bonding driver parameters are listed below. If a
177 parameter is not specified the default value is used.  When initially
178 configuring a bond, it is recommended "tail -f /var/log/messages" be
179 run in a separate window to watch for bonding driver error messages.
180
181         It is critical that either the miimon or arp_interval and
182 arp_ip_target parameters be specified, otherwise serious network
183 degradation will occur during link failures.  Very few devices do not
184 support at least miimon, so there is really no reason not to use it.
185
186         Options with textual values will accept either the text name
187 or, for backwards compatibility, the option value.  E.g.,
188 "mode=802.3ad" and "mode=4" set the same mode.
189
190         The parameters are as follows:
191
192 arp_interval
193
194         Specifies the ARP link monitoring frequency in milliseconds.
195
196         The ARP monitor works by periodically checking the slave
197         devices to determine whether they have sent or received
198         traffic recently (the precise criteria depends upon the
199         bonding mode, and the state of the slave).  Regular traffic is
200         generated via ARP probes issued for the addresses specified by
201         the arp_ip_target option.
202
203         This behavior can be modified by the arp_validate option,
204         below.
205
206         If ARP monitoring is used in an etherchannel compatible mode
207         (modes 0 and 2), the switch should be configured in a mode
208         that evenly distributes packets across all links. If the
209         switch is configured to distribute the packets in an XOR
210         fashion, all replies from the ARP targets will be received on
211         the same link which could cause the other team members to
212         fail.  ARP monitoring should not be used in conjunction with
213         miimon.  A value of 0 disables ARP monitoring.  The default
214         value is 0.
215
216 arp_ip_target
217
218         Specifies the IP addresses to use as ARP monitoring peers when
219         arp_interval is > 0.  These are the targets of the ARP request
220         sent to determine the health of the link to the targets.
221         Specify these values in ddd.ddd.ddd.ddd format.  Multiple IP
222         addresses must be separated by a comma.  At least one IP
223         address must be given for ARP monitoring to function.  The
224         maximum number of targets that can be specified is 16.  The
225         default value is no IP addresses.
226
227 arp_validate
228
229         Specifies whether or not ARP probes and replies should be
230         validated in the active-backup mode.  This causes the ARP
231         monitor to examine the incoming ARP requests and replies, and
232         only consider a slave to be up if it is receiving the
233         appropriate ARP traffic.
234
235         Possible values are:
236
237         none or 0
238
239                 No validation is performed.  This is the default.
240
241         active or 1
242
243                 Validation is performed only for the active slave.
244
245         backup or 2
246
247                 Validation is performed only for backup slaves.
248
249         all or 3
250
251                 Validation is performed for all slaves.
252
253         For the active slave, the validation checks ARP replies to
254         confirm that they were generated by an arp_ip_target.  Since
255         backup slaves do not typically receive these replies, the
256         validation performed for backup slaves is on the ARP request
257         sent out via the active slave.  It is possible that some
258         switch or network configurations may result in situations
259         wherein the backup slaves do not receive the ARP requests; in
260         such a situation, validation of backup slaves must be
261         disabled.
262
263         This option is useful in network configurations in which
264         multiple bonding hosts are concurrently issuing ARPs to one or
265         more targets beyond a common switch.  Should the link between
266         the switch and target fail (but not the switch itself), the
267         probe traffic generated by the multiple bonding instances will
268         fool the standard ARP monitor into considering the links as
269         still up.  Use of the arp_validate option can resolve this, as
270         the ARP monitor will only consider ARP requests and replies
271         associated with its own instance of bonding.
272
273         This option was added in bonding version 3.1.0.
274
275 downdelay
276
277         Specifies the time, in milliseconds, to wait before disabling
278         a slave after a link failure has been detected.  This option
279         is only valid for the miimon link monitor.  The downdelay
280         value should be a multiple of the miimon value; if not, it
281         will be rounded down to the nearest multiple.  The default
282         value is 0.
283
284 lacp_rate
285
286         Option specifying the rate in which we'll ask our link partner
287         to transmit LACPDU packets in 802.3ad mode.  Possible values
288         are:
289
290         slow or 0
291                 Request partner to transmit LACPDUs every 30 seconds
292
293         fast or 1
294                 Request partner to transmit LACPDUs every 1 second
295
296         The default is slow.
297
298 max_bonds
299
300         Specifies the number of bonding devices to create for this
301         instance of the bonding driver.  E.g., if max_bonds is 3, and
302         the bonding driver is not already loaded, then bond0, bond1
303         and bond2 will be created.  The default value is 1.
304
305 miimon
306
307         Specifies the MII link monitoring frequency in milliseconds.
308         This determines how often the link state of each slave is
309         inspected for link failures.  A value of zero disables MII
310         link monitoring.  A value of 100 is a good starting point.
311         The use_carrier option, below, affects how the link state is
312         determined.  See the High Availability section for additional
313         information.  The default value is 0.
314
315 mode
316
317         Specifies one of the bonding policies. The default is
318         balance-rr (round robin).  Possible values are:
319
320         balance-rr or 0
321
322                 Round-robin policy: Transmit packets in sequential
323                 order from the first available slave through the
324                 last.  This mode provides load balancing and fault
325                 tolerance.
326
327         active-backup or 1
328
329                 Active-backup policy: Only one slave in the bond is
330                 active.  A different slave becomes active if, and only
331                 if, the active slave fails.  The bond's MAC address is
332                 externally visible on only one port (network adapter)
333                 to avoid confusing the switch.
334
335                 In bonding version 2.6.2 or later, when a failover
336                 occurs in active-backup mode, bonding will issue one
337                 or more gratuitous ARPs on the newly active slave.
338                 One gratuitous ARP is issued for the bonding master
339                 interface and each VLAN interfaces configured above
340                 it, provided that the interface has at least one IP
341                 address configured.  Gratuitous ARPs issued for VLAN
342                 interfaces are tagged with the appropriate VLAN id.
343
344                 This mode provides fault tolerance.  The primary
345                 option, documented below, affects the behavior of this
346                 mode.
347
348         balance-xor or 2
349
350                 XOR policy: Transmit based on the selected transmit
351                 hash policy.  The default policy is a simple [(source
352                 MAC address XOR'd with destination MAC address) modulo
353                 slave count].  Alternate transmit policies may be
354                 selected via the xmit_hash_policy option, described
355                 below.
356
357                 This mode provides load balancing and fault tolerance.
358
359         broadcast or 3
360
361                 Broadcast policy: transmits everything on all slave
362                 interfaces.  This mode provides fault tolerance.
363
364         802.3ad or 4
365
366                 IEEE 802.3ad Dynamic link aggregation.  Creates
367                 aggregation groups that share the same speed and
368                 duplex settings.  Utilizes all slaves in the active
369                 aggregator according to the 802.3ad specification.
370
371                 Slave selection for outgoing traffic is done according
372                 to the transmit hash policy, which may be changed from
373                 the default simple XOR policy via the xmit_hash_policy
374                 option, documented below.  Note that not all transmit
375                 policies may be 802.3ad compliant, particularly in
376                 regards to the packet mis-ordering requirements of
377                 section 43.2.4 of the 802.3ad standard.  Differing
378                 peer implementations will have varying tolerances for
379                 noncompliance.
380
381                 Prerequisites:
382
383                 1. Ethtool support in the base drivers for retrieving
384                 the speed and duplex of each slave.
385
386                 2. A switch that supports IEEE 802.3ad Dynamic link
387                 aggregation.
388
389                 Most switches will require some type of configuration
390                 to enable 802.3ad mode.
391
392         balance-tlb or 5
393
394                 Adaptive transmit load balancing: channel bonding that
395                 does not require any special switch support.  The
396                 outgoing traffic is distributed according to the
397                 current load (computed relative to the speed) on each
398                 slave.  Incoming traffic is received by the current
399                 slave.  If the receiving slave fails, another slave
400                 takes over the MAC address of the failed receiving
401                 slave.
402
403                 Prerequisite:
404
405                 Ethtool support in the base drivers for retrieving the
406                 speed of each slave.
407
408         balance-alb or 6
409
410                 Adaptive load balancing: includes balance-tlb plus
411                 receive load balancing (rlb) for IPV4 traffic, and
412                 does not require any special switch support.  The
413                 receive load balancing is achieved by ARP negotiation.
414                 The bonding driver intercepts the ARP Replies sent by
415                 the local system on their way out and overwrites the
416                 source hardware address with the unique hardware
417                 address of one of the slaves in the bond such that
418                 different peers use different hardware addresses for
419                 the server.
420
421                 Receive traffic from connections created by the server
422                 is also balanced.  When the local system sends an ARP
423                 Request the bonding driver copies and saves the peer's
424                 IP information from the ARP packet.  When the ARP
425                 Reply arrives from the peer, its hardware address is
426                 retrieved and the bonding driver initiates an ARP
427                 reply to this peer assigning it to one of the slaves
428                 in the bond.  A problematic outcome of using ARP
429                 negotiation for balancing is that each time that an
430                 ARP request is broadcast it uses the hardware address
431                 of the bond.  Hence, peers learn the hardware address
432                 of the bond and the balancing of receive traffic
433                 collapses to the current slave.  This is handled by
434                 sending updates (ARP Replies) to all the peers with
435                 their individually assigned hardware address such that
436                 the traffic is redistributed.  Receive traffic is also
437                 redistributed when a new slave is added to the bond
438                 and when an inactive slave is re-activated.  The
439                 receive load is distributed sequentially (round robin)
440                 among the group of highest speed slaves in the bond.
441
442                 When a link is reconnected or a new slave joins the
443                 bond the receive traffic is redistributed among all
444                 active slaves in the bond by initiating ARP Replies
445                 with the selected MAC address to each of the
446                 clients. The updelay parameter (detailed below) must
447                 be set to a value equal or greater than the switch's
448                 forwarding delay so that the ARP Replies sent to the
449                 peers will not be blocked by the switch.
450
451                 Prerequisites:
452
453                 1. Ethtool support in the base drivers for retrieving
454                 the speed of each slave.
455
456                 2. Base driver support for setting the hardware
457                 address of a device while it is open.  This is
458                 required so that there will always be one slave in the
459                 team using the bond hardware address (the
460                 curr_active_slave) while having a unique hardware
461                 address for each slave in the bond.  If the
462                 curr_active_slave fails its hardware address is
463                 swapped with the new curr_active_slave that was
464                 chosen.
465
466 primary
467
468         A string (eth0, eth2, etc) specifying which slave is the
469         primary device.  The specified device will always be the
470         active slave while it is available.  Only when the primary is
471         off-line will alternate devices be used.  This is useful when
472         one slave is preferred over another, e.g., when one slave has
473         higher throughput than another.
474
475         The primary option is only valid for active-backup mode.
476
477 updelay
478
479         Specifies the time, in milliseconds, to wait before enabling a
480         slave after a link recovery has been detected.  This option is
481         only valid for the miimon link monitor.  The updelay value
482         should be a multiple of the miimon value; if not, it will be
483         rounded down to the nearest multiple.  The default value is 0.
484
485 use_carrier
486
487         Specifies whether or not miimon should use MII or ETHTOOL
488         ioctls vs. netif_carrier_ok() to determine the link
489         status. The MII or ETHTOOL ioctls are less efficient and
490         utilize a deprecated calling sequence within the kernel.  The
491         netif_carrier_ok() relies on the device driver to maintain its
492         state with netif_carrier_on/off; at this writing, most, but
493         not all, device drivers support this facility.
494
495         If bonding insists that the link is up when it should not be,
496         it may be that your network device driver does not support
497         netif_carrier_on/off.  The default state for netif_carrier is
498         "carrier on," so if a driver does not support netif_carrier,
499         it will appear as if the link is always up.  In this case,
500         setting use_carrier to 0 will cause bonding to revert to the
501         MII / ETHTOOL ioctl method to determine the link state.
502
503         A value of 1 enables the use of netif_carrier_ok(), a value of
504         0 will use the deprecated MII / ETHTOOL ioctls.  The default
505         value is 1.
506
507 xmit_hash_policy
508
509         Selects the transmit hash policy to use for slave selection in
510         balance-xor and 802.3ad modes.  Possible values are:
511
512         layer2
513
514                 Uses XOR of hardware MAC addresses to generate the
515                 hash.  The formula is
516
517                 (source MAC XOR destination MAC) modulo slave count
518
519                 This algorithm will place all traffic to a particular
520                 network peer on the same slave.
521
522                 This algorithm is 802.3ad compliant.
523
524         layer3+4
525
526                 This policy uses upper layer protocol information,
527                 when available, to generate the hash.  This allows for
528                 traffic to a particular network peer to span multiple
529                 slaves, although a single connection will not span
530                 multiple slaves.
531
532                 The formula for unfragmented TCP and UDP packets is
533
534                 ((source port XOR dest port) XOR
535                          ((source IP XOR dest IP) AND 0xffff)
536                                 modulo slave count
537
538                 For fragmented TCP or UDP packets and all other IP
539                 protocol traffic, the source and destination port
540                 information is omitted.  For non-IP traffic, the
541                 formula is the same as for the layer2 transmit hash
542                 policy.
543
544                 This policy is intended to mimic the behavior of
545                 certain switches, notably Cisco switches with PFC2 as
546                 well as some Foundry and IBM products.
547
548                 This algorithm is not fully 802.3ad compliant.  A
549                 single TCP or UDP conversation containing both
550                 fragmented and unfragmented packets will see packets
551                 striped across two interfaces.  This may result in out
552                 of order delivery.  Most traffic types will not meet
553                 this criteria, as TCP rarely fragments traffic, and
554                 most UDP traffic is not involved in extended
555                 conversations.  Other implementations of 802.3ad may
556                 or may not tolerate this noncompliance.
557
558         The default value is layer2.  This option was added in bonding
559 version 2.6.3.  In earlier versions of bonding, this parameter does
560 not exist, and the layer2 policy is the only policy.
561
562
563 3. Configuring Bonding Devices
564 ==============================
565
566         You can configure bonding using either your distro's network
567 initialization scripts, or manually using either ifenslave or the
568 sysfs interface.  Distros generally use one of two packages for the
569 network initialization scripts: initscripts or sysconfig.  Recent
570 versions of these packages have support for bonding, while older
571 versions do not.
572
573         We will first describe the options for configuring bonding for
574 distros using versions of initscripts and sysconfig with full or
575 partial support for bonding, then provide information on enabling
576 bonding without support from the network initialization scripts (i.e.,
577 older versions of initscripts or sysconfig).
578
579         If you're unsure whether your distro uses sysconfig or
580 initscripts, or don't know if it's new enough, have no fear.
581 Determining this is fairly straightforward.
582
583         First, issue the command:
584
585 $ rpm -qf /sbin/ifup
586
587         It will respond with a line of text starting with either
588 "initscripts" or "sysconfig," followed by some numbers.  This is the
589 package that provides your network initialization scripts.
590
591         Next, to determine if your installation supports bonding,
592 issue the command:
593
594 $ grep ifenslave /sbin/ifup
595
596         If this returns any matches, then your initscripts or
597 sysconfig has support for bonding.
598
599 3.1 Configuration with Sysconfig Support
600 ----------------------------------------
601
602         This section applies to distros using a version of sysconfig
603 with bonding support, for example, SuSE Linux Enterprise Server 9.
604
605         SuSE SLES 9's networking configuration system does support
606 bonding, however, at this writing, the YaST system configuration
607 front end does not provide any means to work with bonding devices.
608 Bonding devices can be managed by hand, however, as follows.
609
610         First, if they have not already been configured, configure the
611 slave devices.  On SLES 9, this is most easily done by running the
612 yast2 sysconfig configuration utility.  The goal is for to create an
613 ifcfg-id file for each slave device.  The simplest way to accomplish
614 this is to configure the devices for DHCP (this is only to get the
615 file ifcfg-id file created; see below for some issues with DHCP).  The
616 name of the configuration file for each device will be of the form:
617
618 ifcfg-id-xx:xx:xx:xx:xx:xx
619
620         Where the "xx" portion will be replaced with the digits from
621 the device's permanent MAC address.
622
623         Once the set of ifcfg-id-xx:xx:xx:xx:xx:xx files has been
624 created, it is necessary to edit the configuration files for the slave
625 devices (the MAC addresses correspond to those of the slave devices).
626 Before editing, the file will contain multiple lines, and will look
627 something like this:
628
629 BOOTPROTO='dhcp'
630 STARTMODE='on'
631 USERCTL='no'
632 UNIQUE='XNzu.WeZGOGF+4wE'
633 _nm_name='bus-pci-0001:61:01.0'
634
635         Change the BOOTPROTO and STARTMODE lines to the following:
636
637 BOOTPROTO='none'
638 STARTMODE='off'
639
640         Do not alter the UNIQUE or _nm_name lines.  Remove any other
641 lines (USERCTL, etc).
642
643         Once the ifcfg-id-xx:xx:xx:xx:xx:xx files have been modified,
644 it's time to create the configuration file for the bonding device
645 itself.  This file is named ifcfg-bondX, where X is the number of the
646 bonding device to create, starting at 0.  The first such file is
647 ifcfg-bond0, the second is ifcfg-bond1, and so on.  The sysconfig
648 network configuration system will correctly start multiple instances
649 of bonding.
650
651         The contents of the ifcfg-bondX file is as follows:
652
653 BOOTPROTO="static"
654 BROADCAST="10.0.2.255"
655 IPADDR="10.0.2.10"
656 NETMASK="255.255.0.0"
657 NETWORK="10.0.2.0"
658 REMOTE_IPADDR=""
659 STARTMODE="onboot"
660 BONDING_MASTER="yes"
661 BONDING_MODULE_OPTS="mode=active-backup miimon=100"
662 BONDING_SLAVE0="eth0"
663 BONDING_SLAVE1="bus-pci-0000:06:08.1"
664
665         Replace the sample BROADCAST, IPADDR, NETMASK and NETWORK
666 values with the appropriate values for your network.
667
668         The STARTMODE specifies when the device is brought online.
669 The possible values are:
670
671         onboot:  The device is started at boot time.  If you're not
672                  sure, this is probably what you want.
673
674         manual:  The device is started only when ifup is called
675                  manually.  Bonding devices may be configured this
676                  way if you do not wish them to start automatically
677                  at boot for some reason.
678
679         hotplug: The device is started by a hotplug event.  This is not
680                  a valid choice for a bonding device.
681
682         off or ignore: The device configuration is ignored.
683
684         The line BONDING_MASTER='yes' indicates that the device is a
685 bonding master device.  The only useful value is "yes."
686
687         The contents of BONDING_MODULE_OPTS are supplied to the
688 instance of the bonding module for this device.  Specify the options
689 for the bonding mode, link monitoring, and so on here.  Do not include
690 the max_bonds bonding parameter; this will confuse the configuration
691 system if you have multiple bonding devices.
692
693         Finally, supply one BONDING_SLAVEn="slave device" for each
694 slave.  where "n" is an increasing value, one for each slave.  The
695 "slave device" is either an interface name, e.g., "eth0", or a device
696 specifier for the network device.  The interface name is easier to
697 find, but the ethN names are subject to change at boot time if, e.g.,
698 a device early in the sequence has failed.  The device specifiers
699 (bus-pci-0000:06:08.1 in the example above) specify the physical
700 network device, and will not change unless the device's bus location
701 changes (for example, it is moved from one PCI slot to another).  The
702 example above uses one of each type for demonstration purposes; most
703 configurations will choose one or the other for all slave devices.
704
705         When all configuration files have been modified or created,
706 networking must be restarted for the configuration changes to take
707 effect.  This can be accomplished via the following:
708
709 # /etc/init.d/network restart
710
711         Note that the network control script (/sbin/ifdown) will
712 remove the bonding module as part of the network shutdown processing,
713 so it is not necessary to remove the module by hand if, e.g., the
714 module parameters have changed.
715
716         Also, at this writing, YaST/YaST2 will not manage bonding
717 devices (they do not show bonding interfaces on its list of network
718 devices).  It is necessary to edit the configuration file by hand to
719 change the bonding configuration.
720
721         Additional general options and details of the ifcfg file
722 format can be found in an example ifcfg template file:
723
724 /etc/sysconfig/network/ifcfg.template
725
726         Note that the template does not document the various BONDING_
727 settings described above, but does describe many of the other options.
728
729 3.1.1 Using DHCP with Sysconfig
730 -------------------------------
731
732         Under sysconfig, configuring a device with BOOTPROTO='dhcp'
733 will cause it to query DHCP for its IP address information.  At this
734 writing, this does not function for bonding devices; the scripts
735 attempt to obtain the device address from DHCP prior to adding any of
736 the slave devices.  Without active slaves, the DHCP requests are not
737 sent to the network.
738
739 3.1.2 Configuring Multiple Bonds with Sysconfig
740 -----------------------------------------------
741
742         The sysconfig network initialization system is capable of
743 handling multiple bonding devices.  All that is necessary is for each
744 bonding instance to have an appropriately configured ifcfg-bondX file
745 (as described above).  Do not specify the "max_bonds" parameter to any
746 instance of bonding, as this will confuse sysconfig.  If you require
747 multiple bonding devices with identical parameters, create multiple
748 ifcfg-bondX files.
749
750         Because the sysconfig scripts supply the bonding module
751 options in the ifcfg-bondX file, it is not necessary to add them to
752 the system /etc/modules.conf or /etc/modprobe.conf configuration file.
753
754 3.2 Configuration with Initscripts Support
755 ------------------------------------------
756
757         This section applies to distros using a version of initscripts
758 with bonding support, for example, Red Hat Linux 9 or Red Hat
759 Enterprise Linux version 3 or 4.  On these systems, the network
760 initialization scripts have some knowledge of bonding, and can be
761 configured to control bonding devices.
762
763         These distros will not automatically load the network adapter
764 driver unless the ethX device is configured with an IP address.
765 Because of this constraint, users must manually configure a
766 network-script file for all physical adapters that will be members of
767 a bondX link.  Network script files are located in the directory:
768
769 /etc/sysconfig/network-scripts
770
771         The file name must be prefixed with "ifcfg-eth" and suffixed
772 with the adapter's physical adapter number.  For example, the script
773 for eth0 would be named /etc/sysconfig/network-scripts/ifcfg-eth0.
774 Place the following text in the file:
775
776 DEVICE=eth0
777 USERCTL=no
778 ONBOOT=yes
779 MASTER=bond0
780 SLAVE=yes
781 BOOTPROTO=none
782
783         The DEVICE= line will be different for every ethX device and
784 must correspond with the name of the file, i.e., ifcfg-eth1 must have
785 a device line of DEVICE=eth1.  The setting of the MASTER= line will
786 also depend on the final bonding interface name chosen for your bond.
787 As with other network devices, these typically start at 0, and go up
788 one for each device, i.e., the first bonding instance is bond0, the
789 second is bond1, and so on.
790
791         Next, create a bond network script.  The file name for this
792 script will be /etc/sysconfig/network-scripts/ifcfg-bondX where X is
793 the number of the bond.  For bond0 the file is named "ifcfg-bond0",
794 for bond1 it is named "ifcfg-bond1", and so on.  Within that file,
795 place the following text:
796
797 DEVICE=bond0
798 IPADDR=192.168.1.1
799 NETMASK=255.255.255.0
800 NETWORK=192.168.1.0
801 BROADCAST=192.168.1.255
802 ONBOOT=yes
803 BOOTPROTO=none
804 USERCTL=no
805
806         Be sure to change the networking specific lines (IPADDR,
807 NETMASK, NETWORK and BROADCAST) to match your network configuration.
808
809         Finally, it is necessary to edit /etc/modules.conf (or
810 /etc/modprobe.conf, depending upon your distro) to load the bonding
811 module with your desired options when the bond0 interface is brought
812 up.  The following lines in /etc/modules.conf (or modprobe.conf) will
813 load the bonding module, and select its options:
814
815 alias bond0 bonding
816 options bond0 mode=balance-alb miimon=100
817
818         Replace the sample parameters with the appropriate set of
819 options for your configuration.
820
821         Finally run "/etc/rc.d/init.d/network restart" as root.  This
822 will restart the networking subsystem and your bond link should be now
823 up and running.
824
825 3.2.1 Using DHCP with Initscripts
826 ---------------------------------
827
828         Recent versions of initscripts (the version supplied with
829 Fedora Core 3 and Red Hat Enterprise Linux 4 is reported to work) do
830 have support for assigning IP information to bonding devices via DHCP.
831
832         To configure bonding for DHCP, configure it as described
833 above, except replace the line "BOOTPROTO=none" with "BOOTPROTO=dhcp"
834 and add a line consisting of "TYPE=Bonding".  Note that the TYPE value
835 is case sensitive.
836
837 3.2.2 Configuring Multiple Bonds with Initscripts
838 -------------------------------------------------
839
840         At this writing, the initscripts package does not directly
841 support loading the bonding driver multiple times, so the process for
842 doing so is the same as described in the "Configuring Multiple Bonds
843 Manually" section, below.
844
845         NOTE: It has been observed that some Red Hat supplied kernels
846 are apparently unable to rename modules at load time (the "-o bond1"
847 part).  Attempts to pass that option to modprobe will produce an
848 "Operation not permitted" error.  This has been reported on some
849 Fedora Core kernels, and has been seen on RHEL 4 as well.  On kernels
850 exhibiting this problem, it will be impossible to configure multiple
851 bonds with differing parameters.
852
853 3.3 Configuring Bonding Manually with Ifenslave
854 -----------------------------------------------
855
856         This section applies to distros whose network initialization
857 scripts (the sysconfig or initscripts package) do not have specific
858 knowledge of bonding.  One such distro is SuSE Linux Enterprise Server
859 version 8.
860
861         The general method for these systems is to place the bonding
862 module parameters into /etc/modules.conf or /etc/modprobe.conf (as
863 appropriate for the installed distro), then add modprobe and/or
864 ifenslave commands to the system's global init script.  The name of
865 the global init script differs; for sysconfig, it is
866 /etc/init.d/boot.local and for initscripts it is /etc/rc.d/rc.local.
867
868         For example, if you wanted to make a simple bond of two e100
869 devices (presumed to be eth0 and eth1), and have it persist across
870 reboots, edit the appropriate file (/etc/init.d/boot.local or
871 /etc/rc.d/rc.local), and add the following:
872
873 modprobe bonding mode=balance-alb miimon=100
874 modprobe e100
875 ifconfig bond0 192.168.1.1 netmask 255.255.255.0 up
876 ifenslave bond0 eth0
877 ifenslave bond0 eth1
878
879         Replace the example bonding module parameters and bond0
880 network configuration (IP address, netmask, etc) with the appropriate
881 values for your configuration.
882
883         Unfortunately, this method will not provide support for the
884 ifup and ifdown scripts on the bond devices.  To reload the bonding
885 configuration, it is necessary to run the initialization script, e.g.,
886
887 # /etc/init.d/boot.local
888
889         or
890
891 # /etc/rc.d/rc.local
892
893         It may be desirable in such a case to create a separate script
894 which only initializes the bonding configuration, then call that
895 separate script from within boot.local.  This allows for bonding to be
896 enabled without re-running the entire global init script.
897
898         To shut down the bonding devices, it is necessary to first
899 mark the bonding device itself as being down, then remove the
900 appropriate device driver modules.  For our example above, you can do
901 the following:
902
903 # ifconfig bond0 down
904 # rmmod bonding
905 # rmmod e100
906
907         Again, for convenience, it may be desirable to create a script
908 with these commands.
909
910
911 3.3.1 Configuring Multiple Bonds Manually
912 -----------------------------------------
913
914         This section contains information on configuring multiple
915 bonding devices with differing options for those systems whose network
916 initialization scripts lack support for configuring multiple bonds.
917
918         If you require multiple bonding devices, but all with the same
919 options, you may wish to use the "max_bonds" module parameter,
920 documented above.
921
922         To create multiple bonding devices with differing options, it
923 is necessary to use bonding parameters exported by sysfs, documented
924 in the section below.
925
926
927 3.4 Configuring Bonding Manually via Sysfs
928 ------------------------------------------
929
930         Starting with version 3.0, Channel Bonding may be configured
931 via the sysfs interface.  This interface allows dynamic configuration
932 of all bonds in the system without unloading the module.  It also
933 allows for adding and removing bonds at runtime.  Ifenslave is no
934 longer required, though it is still supported.
935
936         Use of the sysfs interface allows you to use multiple bonds
937 with different configurations without having to reload the module.
938 It also allows you to use multiple, differently configured bonds when
939 bonding is compiled into the kernel.
940
941         You must have the sysfs filesystem mounted to configure
942 bonding this way.  The examples in this document assume that you
943 are using the standard mount point for sysfs, e.g. /sys.  If your
944 sysfs filesystem is mounted elsewhere, you will need to adjust the
945 example paths accordingly.
946
947 Creating and Destroying Bonds
948 -----------------------------
949 To add a new bond foo:
950 # echo +foo > /sys/class/net/bonding_masters
951
952 To remove an existing bond bar:
953 # echo -bar > /sys/class/net/bonding_masters
954
955 To show all existing bonds:
956 # cat /sys/class/net/bonding_masters
957
958 NOTE: due to 4K size limitation of sysfs files, this list may be
959 truncated if you have more than a few hundred bonds.  This is unlikely
960 to occur under normal operating conditions.
961
962 Adding and Removing Slaves
963 --------------------------
964         Interfaces may be enslaved to a bond using the file
965 /sys/class/net/<bond>/bonding/slaves.  The semantics for this file
966 are the same as for the bonding_masters file.
967
968 To enslave interface eth0 to bond bond0:
969 # ifconfig bond0 up
970 # echo +eth0 > /sys/class/net/bond0/bonding/slaves
971
972 To free slave eth0 from bond bond0:
973 # echo -eth0 > /sys/class/net/bond0/bonding/slaves
974
975         NOTE: The bond must be up before slaves can be added.  All
976 slaves are freed when the interface is brought down.
977
978         When an interface is enslaved to a bond, symlinks between the
979 two are created in the sysfs filesystem.  In this case, you would get
980 /sys/class/net/bond0/slave_eth0 pointing to /sys/class/net/eth0, and
981 /sys/class/net/eth0/master pointing to /sys/class/net/bond0.
982
983         This means that you can tell quickly whether or not an
984 interface is enslaved by looking for the master symlink.  Thus:
985 # echo -eth0 > /sys/class/net/eth0/master/bonding/slaves
986 will free eth0 from whatever bond it is enslaved to, regardless of
987 the name of the bond interface.
988
989 Changing a Bond's Configuration
990 -------------------------------
991         Each bond may be configured individually by manipulating the
992 files located in /sys/class/net/<bond name>/bonding
993
994         The names of these files correspond directly with the command-
995 line parameters described elsewhere in this file, and, with the
996 exception of arp_ip_target, they accept the same values.  To see the
997 current setting, simply cat the appropriate file.
998
999         A few examples will be given here; for specific usage
1000 guidelines for each parameter, see the appropriate section in this
1001 document.
1002
1003 To configure bond0 for balance-alb mode:
1004 # ifconfig bond0 down
1005 # echo 6 > /sys/class/net/bond0/bonding/mode
1006  - or -
1007 # echo balance-alb > /sys/class/net/bond0/bonding/mode
1008         NOTE: The bond interface must be down before the mode can be
1009 changed.
1010
1011 To enable MII monitoring on bond0 with a 1 second interval:
1012 # echo 1000 > /sys/class/net/bond0/bonding/miimon
1013         NOTE: If ARP monitoring is enabled, it will disabled when MII
1014 monitoring is enabled, and vice-versa.
1015
1016 To add ARP targets:
1017 # echo +192.168.0.100 > /sys/class/net/bond0/bonding/arp_ip_target
1018 # echo +192.168.0.101 > /sys/class/net/bond0/bonding/arp_ip_target
1019         NOTE:  up to 10 target addresses may be specified.
1020
1021 To remove an ARP target:
1022 # echo -192.168.0.100 > /sys/class/net/bond0/bonding/arp_ip_target
1023
1024 Example Configuration
1025 ---------------------
1026         We begin with the same example that is shown in section 3.3,
1027 executed with sysfs, and without using ifenslave.
1028
1029         To make a simple bond of two e100 devices (presumed to be eth0
1030 and eth1), and have it persist across reboots, edit the appropriate
1031 file (/etc/init.d/boot.local or /etc/rc.d/rc.local), and add the
1032 following:
1033
1034 modprobe bonding
1035 modprobe e100
1036 echo balance-alb > /sys/class/net/bond0/bonding/mode
1037 ifconfig bond0 192.168.1.1 netmask 255.255.255.0 up
1038 echo 100 > /sys/class/net/bond0/bonding/miimon
1039 echo +eth0 > /sys/class/net/bond0/bonding/slaves
1040 echo +eth1 > /sys/class/net/bond0/bonding/slaves
1041
1042         To add a second bond, with two e1000 interfaces in
1043 active-backup mode, using ARP monitoring, add the following lines to
1044 your init script:
1045
1046 modprobe e1000
1047 echo +bond1 > /sys/class/net/bonding_masters
1048 echo active-backup > /sys/class/net/bond1/bonding/mode
1049 ifconfig bond1 192.168.2.1 netmask 255.255.255.0 up
1050 echo +192.168.2.100 /sys/class/net/bond1/bonding/arp_ip_target
1051 echo 2000 > /sys/class/net/bond1/bonding/arp_interval
1052 echo +eth2 > /sys/class/net/bond1/bonding/slaves
1053 echo +eth3 > /sys/class/net/bond1/bonding/slaves
1054
1055
1056 4. Querying Bonding Configuration 
1057 =================================
1058
1059 4.1 Bonding Configuration
1060 -------------------------
1061
1062         Each bonding device has a read-only file residing in the
1063 /proc/net/bonding directory.  The file contents include information
1064 about the bonding configuration, options and state of each slave.
1065
1066         For example, the contents of /proc/net/bonding/bond0 after the
1067 driver is loaded with parameters of mode=0 and miimon=1000 is
1068 generally as follows:
1069
1070         Ethernet Channel Bonding Driver: 2.6.1 (October 29, 2004)
1071         Bonding Mode: load balancing (round-robin)
1072         Currently Active Slave: eth0
1073         MII Status: up
1074         MII Polling Interval (ms): 1000
1075         Up Delay (ms): 0
1076         Down Delay (ms): 0
1077
1078         Slave Interface: eth1
1079         MII Status: up
1080         Link Failure Count: 1
1081
1082         Slave Interface: eth0
1083         MII Status: up
1084         Link Failure Count: 1
1085
1086         The precise format and contents will change depending upon the
1087 bonding configuration, state, and version of the bonding driver.
1088
1089 4.2 Network configuration
1090 -------------------------
1091
1092         The network configuration can be inspected using the ifconfig
1093 command.  Bonding devices will have the MASTER flag set; Bonding slave
1094 devices will have the SLAVE flag set.  The ifconfig output does not
1095 contain information on which slaves are associated with which masters.
1096
1097         In the example below, the bond0 interface is the master
1098 (MASTER) while eth0 and eth1 are slaves (SLAVE). Notice all slaves of
1099 bond0 have the same MAC address (HWaddr) as bond0 for all modes except
1100 TLB and ALB that require a unique MAC address for each slave.
1101
1102 # /sbin/ifconfig
1103 bond0     Link encap:Ethernet  HWaddr 00:C0:F0:1F:37:B4
1104           inet addr:XXX.XXX.XXX.YYY  Bcast:XXX.XXX.XXX.255  Mask:255.255.252.0
1105           UP BROADCAST RUNNING MASTER MULTICAST  MTU:1500  Metric:1
1106           RX packets:7224794 errors:0 dropped:0 overruns:0 frame:0
1107           TX packets:3286647 errors:1 dropped:0 overruns:1 carrier:0
1108           collisions:0 txqueuelen:0
1109
1110 eth0      Link encap:Ethernet  HWaddr 00:C0:F0:1F:37:B4
1111           UP BROADCAST RUNNING SLAVE MULTICAST  MTU:1500  Metric:1
1112           RX packets:3573025 errors:0 dropped:0 overruns:0 frame:0
1113           TX packets:1643167 errors:1 dropped:0 overruns:1 carrier:0
1114           collisions:0 txqueuelen:100
1115           Interrupt:10 Base address:0x1080
1116
1117 eth1      Link encap:Ethernet  HWaddr 00:C0:F0:1F:37:B4
1118           UP BROADCAST RUNNING SLAVE MULTICAST  MTU:1500  Metric:1
1119           RX packets:3651769 errors:0 dropped:0 overruns:0 frame:0
1120           TX packets:1643480 errors:0 dropped:0 overruns:0 carrier:0
1121           collisions:0 txqueuelen:100
1122           Interrupt:9 Base address:0x1400
1123
1124 5. Switch Configuration
1125 =======================
1126
1127         For this section, "switch" refers to whatever system the
1128 bonded devices are directly connected to (i.e., where the other end of
1129 the cable plugs into).  This may be an actual dedicated switch device,
1130 or it may be another regular system (e.g., another computer running
1131 Linux),
1132
1133         The active-backup, balance-tlb and balance-alb modes do not
1134 require any specific configuration of the switch.
1135
1136         The 802.3ad mode requires that the switch have the appropriate
1137 ports configured as an 802.3ad aggregation.  The precise method used
1138 to configure this varies from switch to switch, but, for example, a
1139 Cisco 3550 series switch requires that the appropriate ports first be
1140 grouped together in a single etherchannel instance, then that
1141 etherchannel is set to mode "lacp" to enable 802.3ad (instead of
1142 standard EtherChannel).
1143
1144         The balance-rr, balance-xor and broadcast modes generally
1145 require that the switch have the appropriate ports grouped together.
1146 The nomenclature for such a group differs between switches, it may be
1147 called an "etherchannel" (as in the Cisco example, above), a "trunk
1148 group" or some other similar variation.  For these modes, each switch
1149 will also have its own configuration options for the switch's transmit
1150 policy to the bond.  Typical choices include XOR of either the MAC or
1151 IP addresses.  The transmit policy of the two peers does not need to
1152 match.  For these three modes, the bonding mode really selects a
1153 transmit policy for an EtherChannel group; all three will interoperate
1154 with another EtherChannel group.
1155
1156
1157 6. 802.1q VLAN Support
1158 ======================
1159
1160         It is possible to configure VLAN devices over a bond interface
1161 using the 8021q driver.  However, only packets coming from the 8021q
1162 driver and passing through bonding will be tagged by default.  Self
1163 generated packets, for example, bonding's learning packets or ARP
1164 packets generated by either ALB mode or the ARP monitor mechanism, are
1165 tagged internally by bonding itself.  As a result, bonding must
1166 "learn" the VLAN IDs configured above it, and use those IDs to tag
1167 self generated packets.
1168
1169         For reasons of simplicity, and to support the use of adapters
1170 that can do VLAN hardware acceleration offloading, the bonding
1171 interface declares itself as fully hardware offloading capable, it gets
1172 the add_vid/kill_vid notifications to gather the necessary
1173 information, and it propagates those actions to the slaves.  In case
1174 of mixed adapter types, hardware accelerated tagged packets that
1175 should go through an adapter that is not offloading capable are
1176 "un-accelerated" by the bonding driver so the VLAN tag sits in the
1177 regular location.
1178
1179         VLAN interfaces *must* be added on top of a bonding interface
1180 only after enslaving at least one slave.  The bonding interface has a
1181 hardware address of 00:00:00:00:00:00 until the first slave is added.
1182 If the VLAN interface is created prior to the first enslavement, it
1183 would pick up the all-zeroes hardware address.  Once the first slave
1184 is attached to the bond, the bond device itself will pick up the
1185 slave's hardware address, which is then available for the VLAN device.
1186
1187         Also, be aware that a similar problem can occur if all slaves
1188 are released from a bond that still has one or more VLAN interfaces on
1189 top of it.  When a new slave is added, the bonding interface will
1190 obtain its hardware address from the first slave, which might not
1191 match the hardware address of the VLAN interfaces (which was
1192 ultimately copied from an earlier slave).
1193
1194         There are two methods to insure that the VLAN device operates
1195 with the correct hardware address if all slaves are removed from a
1196 bond interface:
1197
1198         1. Remove all VLAN interfaces then recreate them
1199
1200         2. Set the bonding interface's hardware address so that it
1201 matches the hardware address of the VLAN interfaces.
1202
1203         Note that changing a VLAN interface's HW address would set the
1204 underlying device -- i.e. the bonding interface -- to promiscuous
1205 mode, which might not be what you want.
1206
1207
1208 7. Link Monitoring
1209 ==================
1210
1211         The bonding driver at present supports two schemes for
1212 monitoring a slave device's link state: the ARP monitor and the MII
1213 monitor.
1214
1215         At the present time, due to implementation restrictions in the
1216 bonding driver itself, it is not possible to enable both ARP and MII
1217 monitoring simultaneously.
1218
1219 7.1 ARP Monitor Operation
1220 -------------------------
1221
1222         The ARP monitor operates as its name suggests: it sends ARP
1223 queries to one or more designated peer systems on the network, and
1224 uses the response as an indication that the link is operating.  This
1225 gives some assurance that traffic is actually flowing to and from one
1226 or more peers on the local network.
1227
1228         The ARP monitor relies on the device driver itself to verify
1229 that traffic is flowing.  In particular, the driver must keep up to
1230 date the last receive time, dev->last_rx, and transmit start time,
1231 dev->trans_start.  If these are not updated by the driver, then the
1232 ARP monitor will immediately fail any slaves using that driver, and
1233 those slaves will stay down.  If networking monitoring (tcpdump, etc)
1234 shows the ARP requests and replies on the network, then it may be that
1235 your device driver is not updating last_rx and trans_start.
1236
1237 7.2 Configuring Multiple ARP Targets
1238 ------------------------------------
1239
1240         While ARP monitoring can be done with just one target, it can
1241 be useful in a High Availability setup to have several targets to
1242 monitor.  In the case of just one target, the target itself may go
1243 down or have a problem making it unresponsive to ARP requests.  Having
1244 an additional target (or several) increases the reliability of the ARP
1245 monitoring.
1246
1247         Multiple ARP targets must be separated by commas as follows:
1248
1249 # example options for ARP monitoring with three targets
1250 alias bond0 bonding
1251 options bond0 arp_interval=60 arp_ip_target=192.168.0.1,192.168.0.3,192.168.0.9
1252
1253         For just a single target the options would resemble:
1254
1255 # example options for ARP monitoring with one target
1256 alias bond0 bonding
1257 options bond0 arp_interval=60 arp_ip_target=192.168.0.100
1258
1259
1260 7.3 MII Monitor Operation
1261 -------------------------
1262
1263         The MII monitor monitors only the carrier state of the local
1264 network interface.  It accomplishes this in one of three ways: by
1265 depending upon the device driver to maintain its carrier state, by
1266 querying the device's MII registers, or by making an ethtool query to
1267 the device.
1268
1269         If the use_carrier module parameter is 1 (the default value),
1270 then the MII monitor will rely on the driver for carrier state
1271 information (via the netif_carrier subsystem).  As explained in the
1272 use_carrier parameter information, above, if the MII monitor fails to
1273 detect carrier loss on the device (e.g., when the cable is physically
1274 disconnected), it may be that the driver does not support
1275 netif_carrier.
1276
1277         If use_carrier is 0, then the MII monitor will first query the
1278 device's (via ioctl) MII registers and check the link state.  If that
1279 request fails (not just that it returns carrier down), then the MII
1280 monitor will make an ethtool ETHOOL_GLINK request to attempt to obtain
1281 the same information.  If both methods fail (i.e., the driver either
1282 does not support or had some error in processing both the MII register
1283 and ethtool requests), then the MII monitor will assume the link is
1284 up.
1285
1286 8. Potential Sources of Trouble
1287 ===============================
1288
1289 8.1 Adventures in Routing
1290 -------------------------
1291
1292         When bonding is configured, it is important that the slave
1293 devices not have routes that supersede routes of the master (or,
1294 generally, not have routes at all).  For example, suppose the bonding
1295 device bond0 has two slaves, eth0 and eth1, and the routing table is
1296 as follows:
1297
1298 Kernel IP routing table
1299 Destination     Gateway         Genmask         Flags   MSS Window  irtt Iface
1300 10.0.0.0        0.0.0.0         255.255.0.0     U        40 0          0 eth0
1301 10.0.0.0        0.0.0.0         255.255.0.0     U        40 0          0 eth1
1302 10.0.0.0        0.0.0.0         255.255.0.0     U        40 0          0 bond0
1303 127.0.0.0       0.0.0.0         255.0.0.0       U        40 0          0 lo
1304
1305         This routing configuration will likely still update the
1306 receive/transmit times in the driver (needed by the ARP monitor), but
1307 may bypass the bonding driver (because outgoing traffic to, in this
1308 case, another host on network 10 would use eth0 or eth1 before bond0).
1309
1310         The ARP monitor (and ARP itself) may become confused by this
1311 configuration, because ARP requests (generated by the ARP monitor)
1312 will be sent on one interface (bond0), but the corresponding reply
1313 will arrive on a different interface (eth0).  This reply looks to ARP
1314 as an unsolicited ARP reply (because ARP matches replies on an
1315 interface basis), and is discarded.  The MII monitor is not affected
1316 by the state of the routing table.
1317
1318         The solution here is simply to insure that slaves do not have
1319 routes of their own, and if for some reason they must, those routes do
1320 not supersede routes of their master.  This should generally be the
1321 case, but unusual configurations or errant manual or automatic static
1322 route additions may cause trouble.
1323
1324 8.2 Ethernet Device Renaming
1325 ----------------------------
1326
1327         On systems with network configuration scripts that do not
1328 associate physical devices directly with network interface names (so
1329 that the same physical device always has the same "ethX" name), it may
1330 be necessary to add some special logic to either /etc/modules.conf or
1331 /etc/modprobe.conf (depending upon which is installed on the system).
1332
1333         For example, given a modules.conf containing the following:
1334
1335 alias bond0 bonding
1336 options bond0 mode=some-mode miimon=50
1337 alias eth0 tg3
1338 alias eth1 tg3
1339 alias eth2 e1000
1340 alias eth3 e1000
1341
1342         If neither eth0 and eth1 are slaves to bond0, then when the
1343 bond0 interface comes up, the devices may end up reordered.  This
1344 happens because bonding is loaded first, then its slave device's
1345 drivers are loaded next.  Since no other drivers have been loaded,
1346 when the e1000 driver loads, it will receive eth0 and eth1 for its
1347 devices, but the bonding configuration tries to enslave eth2 and eth3
1348 (which may later be assigned to the tg3 devices).
1349
1350         Adding the following:
1351
1352 add above bonding e1000 tg3
1353
1354         causes modprobe to load e1000 then tg3, in that order, when
1355 bonding is loaded.  This command is fully documented in the
1356 modules.conf manual page.
1357
1358         On systems utilizing modprobe.conf (or modprobe.conf.local),
1359 an equivalent problem can occur.  In this case, the following can be
1360 added to modprobe.conf (or modprobe.conf.local, as appropriate), as
1361 follows (all on one line; it has been split here for clarity):
1362
1363 install bonding /sbin/modprobe tg3; /sbin/modprobe e1000;
1364         /sbin/modprobe --ignore-install bonding
1365
1366         This will, when loading the bonding module, rather than
1367 performing the normal action, instead execute the provided command.
1368 This command loads the device drivers in the order needed, then calls
1369 modprobe with --ignore-install to cause the normal action to then take
1370 place.  Full documentation on this can be found in the modprobe.conf
1371 and modprobe manual pages.
1372
1373 8.3. Painfully Slow Or No Failed Link Detection By Miimon
1374 ---------------------------------------------------------
1375
1376         By default, bonding enables the use_carrier option, which
1377 instructs bonding to trust the driver to maintain carrier state.
1378
1379         As discussed in the options section, above, some drivers do
1380 not support the netif_carrier_on/_off link state tracking system.
1381 With use_carrier enabled, bonding will always see these links as up,
1382 regardless of their actual state.
1383
1384         Additionally, other drivers do support netif_carrier, but do
1385 not maintain it in real time, e.g., only polling the link state at
1386 some fixed interval.  In this case, miimon will detect failures, but
1387 only after some long period of time has expired.  If it appears that
1388 miimon is very slow in detecting link failures, try specifying
1389 use_carrier=0 to see if that improves the failure detection time.  If
1390 it does, then it may be that the driver checks the carrier state at a
1391 fixed interval, but does not cache the MII register values (so the
1392 use_carrier=0 method of querying the registers directly works).  If
1393 use_carrier=0 does not improve the failover, then the driver may cache
1394 the registers, or the problem may be elsewhere.
1395
1396         Also, remember that miimon only checks for the device's
1397 carrier state.  It has no way to determine the state of devices on or
1398 beyond other ports of a switch, or if a switch is refusing to pass
1399 traffic while still maintaining carrier on.
1400
1401 9. SNMP agents
1402 ===============
1403
1404         If running SNMP agents, the bonding driver should be loaded
1405 before any network drivers participating in a bond.  This requirement
1406 is due to the interface index (ipAdEntIfIndex) being associated to
1407 the first interface found with a given IP address.  That is, there is
1408 only one ipAdEntIfIndex for each IP address.  For example, if eth0 and
1409 eth1 are slaves of bond0 and the driver for eth0 is loaded before the
1410 bonding driver, the interface for the IP address will be associated
1411 with the eth0 interface.  This configuration is shown below, the IP
1412 address 192.168.1.1 has an interface index of 2 which indexes to eth0
1413 in the ifDescr table (ifDescr.2).
1414
1415      interfaces.ifTable.ifEntry.ifDescr.1 = lo
1416      interfaces.ifTable.ifEntry.ifDescr.2 = eth0
1417      interfaces.ifTable.ifEntry.ifDescr.3 = eth1
1418      interfaces.ifTable.ifEntry.ifDescr.4 = eth2
1419      interfaces.ifTable.ifEntry.ifDescr.5 = eth3
1420      interfaces.ifTable.ifEntry.ifDescr.6 = bond0
1421      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.10.10.10.10 = 5
1422      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.192.168.1.1 = 2
1423      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.10.74.20.94 = 4
1424      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.127.0.0.1 = 1
1425
1426         This problem is avoided by loading the bonding driver before
1427 any network drivers participating in a bond.  Below is an example of
1428 loading the bonding driver first, the IP address 192.168.1.1 is
1429 correctly associated with ifDescr.2.
1430
1431      interfaces.ifTable.ifEntry.ifDescr.1 = lo
1432      interfaces.ifTable.ifEntry.ifDescr.2 = bond0
1433      interfaces.ifTable.ifEntry.ifDescr.3 = eth0
1434      interfaces.ifTable.ifEntry.ifDescr.4 = eth1
1435      interfaces.ifTable.ifEntry.ifDescr.5 = eth2
1436      interfaces.ifTable.ifEntry.ifDescr.6 = eth3
1437      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.10.10.10.10 = 6
1438      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.192.168.1.1 = 2
1439      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.10.74.20.94 = 5
1440      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.127.0.0.1 = 1
1441
1442         While some distributions may not report the interface name in
1443 ifDescr, the association between the IP address and IfIndex remains
1444 and SNMP functions such as Interface_Scan_Next will report that
1445 association.
1446
1447 10. Promiscuous mode
1448 ====================
1449
1450         When running network monitoring tools, e.g., tcpdump, it is
1451 common to enable promiscuous mode on the device, so that all traffic
1452 is seen (instead of seeing only traffic destined for the local host).
1453 The bonding driver handles promiscuous mode changes to the bonding
1454 master device (e.g., bond0), and propagates the setting to the slave
1455 devices.
1456
1457         For the balance-rr, balance-xor, broadcast, and 802.3ad modes,
1458 the promiscuous mode setting is propagated to all slaves.
1459
1460         For the active-backup, balance-tlb and balance-alb modes, the
1461 promiscuous mode setting is propagated only to the active slave.
1462
1463         For balance-tlb mode, the active slave is the slave currently
1464 receiving inbound traffic.
1465
1466         For balance-alb mode, the active slave is the slave used as a
1467 "primary."  This slave is used for mode-specific control traffic, for
1468 sending to peers that are unassigned or if the load is unbalanced.
1469
1470         For the active-backup, balance-tlb and balance-alb modes, when
1471 the active slave changes (e.g., due to a link failure), the
1472 promiscuous setting will be propagated to the new active slave.
1473
1474 11. Configuring Bonding for High Availability
1475 =============================================
1476
1477         High Availability refers to configurations that provide
1478 maximum network availability by having redundant or backup devices,
1479 links or switches between the host and the rest of the world.  The
1480 goal is to provide the maximum availability of network connectivity
1481 (i.e., the network always works), even though other configurations
1482 could provide higher throughput.
1483
1484 11.1 High Availability in a Single Switch Topology
1485 --------------------------------------------------
1486
1487         If two hosts (or a host and a single switch) are directly
1488 connected via multiple physical links, then there is no availability
1489 penalty to optimizing for maximum bandwidth.  In this case, there is
1490 only one switch (or peer), so if it fails, there is no alternative
1491 access to fail over to.  Additionally, the bonding load balance modes
1492 support link monitoring of their members, so if individual links fail,
1493 the load will be rebalanced across the remaining devices.
1494
1495         See Section 13, "Configuring Bonding for Maximum Throughput"
1496 for information on configuring bonding with one peer device.
1497
1498 11.2 High Availability in a Multiple Switch Topology
1499 ----------------------------------------------------
1500
1501         With multiple switches, the configuration of bonding and the
1502 network changes dramatically.  In multiple switch topologies, there is
1503 a trade off between network availability and usable bandwidth.
1504
1505         Below is a sample network, configured to maximize the
1506 availability of the network:
1507
1508                 |                                     |
1509                 |port3                           port3|
1510           +-----+----+                          +-----+----+
1511           |          |port2       ISL      port2|          |
1512           | switch A +--------------------------+ switch B |
1513           |          |                          |          |
1514           +-----+----+                          +-----++---+
1515                 |port1                           port1|
1516                 |             +-------+               |
1517                 +-------------+ host1 +---------------+
1518                          eth0 +-------+ eth1
1519
1520         In this configuration, there is a link between the two
1521 switches (ISL, or inter switch link), and multiple ports connecting to
1522 the outside world ("port3" on each switch).  There is no technical
1523 reason that this could not be extended to a third switch.
1524
1525 11.2.1 HA Bonding Mode Selection for Multiple Switch Topology
1526 -------------------------------------------------------------
1527
1528         In a topology such as the example above, the active-backup and
1529 broadcast modes are the only useful bonding modes when optimizing for
1530 availability; the other modes require all links to terminate on the
1531 same peer for them to behave rationally.
1532
1533 active-backup: This is generally the preferred mode, particularly if
1534         the switches have an ISL and play together well.  If the
1535         network configuration is such that one switch is specifically
1536         a backup switch (e.g., has lower capacity, higher cost, etc),
1537         then the primary option can be used to insure that the
1538         preferred link is always used when it is available.
1539
1540 broadcast: This mode is really a special purpose mode, and is suitable
1541         only for very specific needs.  For example, if the two
1542         switches are not connected (no ISL), and the networks beyond
1543         them are totally independent.  In this case, if it is
1544         necessary for some specific one-way traffic to reach both
1545         independent networks, then the broadcast mode may be suitable.
1546
1547 11.2.2 HA Link Monitoring Selection for Multiple Switch Topology
1548 ----------------------------------------------------------------
1549
1550         The choice of link monitoring ultimately depends upon your
1551 switch.  If the switch can reliably fail ports in response to other
1552 failures, then either the MII or ARP monitors should work.  For
1553 example, in the above example, if the "port3" link fails at the remote
1554 end, the MII monitor has no direct means to detect this.  The ARP
1555 monitor could be configured with a target at the remote end of port3,
1556 thus detecting that failure without switch support.
1557
1558         In general, however, in a multiple switch topology, the ARP
1559 monitor can provide a higher level of reliability in detecting end to
1560 end connectivity failures (which may be caused by the failure of any
1561 individual component to pass traffic for any reason).  Additionally,
1562 the ARP monitor should be configured with multiple targets (at least
1563 one for each switch in the network).  This will insure that,
1564 regardless of which switch is active, the ARP monitor has a suitable
1565 target to query.
1566
1567
1568 12. Configuring Bonding for Maximum Throughput
1569 ==============================================
1570
1571 12.1 Maximizing Throughput in a Single Switch Topology
1572 ------------------------------------------------------
1573
1574         In a single switch configuration, the best method to maximize
1575 throughput depends upon the application and network environment.  The
1576 various load balancing modes each have strengths and weaknesses in
1577 different environments, as detailed below.
1578
1579         For this discussion, we will break down the topologies into
1580 two categories.  Depending upon the destination of most traffic, we
1581 categorize them into either "gatewayed" or "local" configurations.
1582
1583         In a gatewayed configuration, the "switch" is acting primarily
1584 as a router, and the majority of traffic passes through this router to
1585 other networks.  An example would be the following:
1586
1587
1588      +----------+                     +----------+
1589      |          |eth0            port1|          | to other networks
1590      | Host A   +---------------------+ router   +------------------->
1591      |          +---------------------+          | Hosts B and C are out
1592      |          |eth1            port2|          | here somewhere
1593      +----------+                     +----------+
1594
1595         The router may be a dedicated router device, or another host
1596 acting as a gateway.  For our discussion, the important point is that
1597 the majority of traffic from Host A will pass through the router to
1598 some other network before reaching its final destination.
1599
1600         In a gatewayed network configuration, although Host A may
1601 communicate with many other systems, all of its traffic will be sent
1602 and received via one other peer on the local network, the router.
1603
1604         Note that the case of two systems connected directly via
1605 multiple physical links is, for purposes of configuring bonding, the
1606 same as a gatewayed configuration.  In that case, it happens that all
1607 traffic is destined for the "gateway" itself, not some other network
1608 beyond the gateway.
1609
1610         In a local configuration, the "switch" is acting primarily as
1611 a switch, and the majority of traffic passes through this switch to
1612 reach other stations on the same network.  An example would be the
1613 following:
1614
1615     +----------+            +----------+       +--------+
1616     |          |eth0   port1|          +-------+ Host B |
1617     |  Host A  +------------+  switch  |port3  +--------+
1618     |          +------------+          |                  +--------+
1619     |          |eth1   port2|          +------------------+ Host C |
1620     +----------+            +----------+port4             +--------+
1621
1622
1623         Again, the switch may be a dedicated switch device, or another
1624 host acting as a gateway.  For our discussion, the important point is
1625 that the majority of traffic from Host A is destined for other hosts
1626 on the same local network (Hosts B and C in the above example).
1627
1628         In summary, in a gatewayed configuration, traffic to and from
1629 the bonded device will be to the same MAC level peer on the network
1630 (the gateway itself, i.e., the router), regardless of its final
1631 destination.  In a local configuration, traffic flows directly to and
1632 from the final destinations, thus, each destination (Host B, Host C)
1633 will be addressed directly by their individual MAC addresses.
1634
1635         This distinction between a gatewayed and a local network
1636 configuration is important because many of the load balancing modes
1637 available use the MAC addresses of the local network source and
1638 destination to make load balancing decisions.  The behavior of each
1639 mode is described below.
1640
1641
1642 12.1.1 MT Bonding Mode Selection for Single Switch Topology
1643 -----------------------------------------------------------
1644
1645         This configuration is the easiest to set up and to understand,
1646 although you will have to decide which bonding mode best suits your
1647 needs.  The trade offs for each mode are detailed below:
1648
1649 balance-rr: This mode is the only mode that will permit a single
1650         TCP/IP connection to stripe traffic across multiple
1651         interfaces. It is therefore the only mode that will allow a
1652         single TCP/IP stream to utilize more than one interface's
1653         worth of throughput.  This comes at a cost, however: the
1654         striping often results in peer systems receiving packets out
1655         of order, causing TCP/IP's congestion control system to kick
1656         in, often by retransmitting segments.
1657
1658         It is possible to adjust TCP/IP's congestion limits by
1659         altering the net.ipv4.tcp_reordering sysctl parameter.  The
1660         usual default value is 3, and the maximum useful value is 127.
1661         For a four interface balance-rr bond, expect that a single
1662         TCP/IP stream will utilize no more than approximately 2.3
1663         interface's worth of throughput, even after adjusting
1664         tcp_reordering.
1665
1666         Note that this out of order delivery occurs when both the
1667         sending and receiving systems are utilizing a multiple
1668         interface bond.  Consider a configuration in which a
1669         balance-rr bond feeds into a single higher capacity network
1670         channel (e.g., multiple 100Mb/sec ethernets feeding a single
1671         gigabit ethernet via an etherchannel capable switch).  In this
1672         configuration, traffic sent from the multiple 100Mb devices to
1673         a destination connected to the gigabit device will not see
1674         packets out of order.  However, traffic sent from the gigabit
1675         device to the multiple 100Mb devices may or may not see
1676         traffic out of order, depending upon the balance policy of the
1677         switch.  Many switches do not support any modes that stripe
1678         traffic (instead choosing a port based upon IP or MAC level
1679         addresses); for those devices, traffic flowing from the
1680         gigabit device to the many 100Mb devices will only utilize one
1681         interface.
1682
1683         If you are utilizing protocols other than TCP/IP, UDP for
1684         example, and your application can tolerate out of order
1685         delivery, then this mode can allow for single stream datagram
1686         performance that scales near linearly as interfaces are added
1687         to the bond.
1688
1689         This mode requires the switch to have the appropriate ports
1690         configured for "etherchannel" or "trunking."
1691
1692 active-backup: There is not much advantage in this network topology to
1693         the active-backup mode, as the inactive backup devices are all
1694         connected to the same peer as the primary.  In this case, a
1695         load balancing mode (with link monitoring) will provide the
1696         same level of network availability, but with increased
1697         available bandwidth.  On the plus side, active-backup mode
1698         does not require any configuration of the switch, so it may
1699         have value if the hardware available does not support any of
1700         the load balance modes.
1701
1702 balance-xor: This mode will limit traffic such that packets destined
1703         for specific peers will always be sent over the same
1704         interface.  Since the destination is determined by the MAC
1705         addresses involved, this mode works best in a "local" network
1706         configuration (as described above), with destinations all on
1707         the same local network.  This mode is likely to be suboptimal
1708         if all your traffic is passed through a single router (i.e., a
1709         "gatewayed" network configuration, as described above).
1710
1711         As with balance-rr, the switch ports need to be configured for
1712         "etherchannel" or "trunking."
1713
1714 broadcast: Like active-backup, there is not much advantage to this
1715         mode in this type of network topology.
1716
1717 802.3ad: This mode can be a good choice for this type of network
1718         topology.  The 802.3ad mode is an IEEE standard, so all peers
1719         that implement 802.3ad should interoperate well.  The 802.3ad
1720         protocol includes automatic configuration of the aggregates,
1721         so minimal manual configuration of the switch is needed
1722         (typically only to designate that some set of devices is
1723         available for 802.3ad).  The 802.3ad standard also mandates
1724         that frames be delivered in order (within certain limits), so
1725         in general single connections will not see misordering of
1726         packets.  The 802.3ad mode does have some drawbacks: the
1727         standard mandates that all devices in the aggregate operate at
1728         the same speed and duplex.  Also, as with all bonding load
1729         balance modes other than balance-rr, no single connection will
1730         be able to utilize more than a single interface's worth of
1731         bandwidth.  
1732
1733         Additionally, the linux bonding 802.3ad implementation
1734         distributes traffic by peer (using an XOR of MAC addresses),
1735         so in a "gatewayed" configuration, all outgoing traffic will
1736         generally use the same device.  Incoming traffic may also end
1737         up on a single device, but that is dependent upon the
1738         balancing policy of the peer's 8023.ad implementation.  In a
1739         "local" configuration, traffic will be distributed across the
1740         devices in the bond.
1741
1742         Finally, the 802.3ad mode mandates the use of the MII monitor,
1743         therefore, the ARP monitor is not available in this mode.
1744
1745 balance-tlb: The balance-tlb mode balances outgoing traffic by peer.
1746         Since the balancing is done according to MAC address, in a
1747         "gatewayed" configuration (as described above), this mode will
1748         send all traffic across a single device.  However, in a
1749         "local" network configuration, this mode balances multiple
1750         local network peers across devices in a vaguely intelligent
1751         manner (not a simple XOR as in balance-xor or 802.3ad mode),
1752         so that mathematically unlucky MAC addresses (i.e., ones that
1753         XOR to the same value) will not all "bunch up" on a single
1754         interface.
1755
1756         Unlike 802.3ad, interfaces may be of differing speeds, and no
1757         special switch configuration is required.  On the down side,
1758         in this mode all incoming traffic arrives over a single
1759         interface, this mode requires certain ethtool support in the
1760         network device driver of the slave interfaces, and the ARP
1761         monitor is not available.
1762
1763 balance-alb: This mode is everything that balance-tlb is, and more.
1764         It has all of the features (and restrictions) of balance-tlb,
1765         and will also balance incoming traffic from local network
1766         peers (as described in the Bonding Module Options section,
1767         above).
1768
1769         The only additional down side to this mode is that the network
1770         device driver must support changing the hardware address while
1771         the device is open.
1772
1773 12.1.2 MT Link Monitoring for Single Switch Topology
1774 ----------------------------------------------------
1775
1776         The choice of link monitoring may largely depend upon which
1777 mode you choose to use.  The more advanced load balancing modes do not
1778 support the use of the ARP monitor, and are thus restricted to using
1779 the MII monitor (which does not provide as high a level of end to end
1780 assurance as the ARP monitor).
1781
1782 12.2 Maximum Throughput in a Multiple Switch Topology
1783 -----------------------------------------------------
1784
1785         Multiple switches may be utilized to optimize for throughput
1786 when they are configured in parallel as part of an isolated network
1787 between two or more systems, for example:
1788
1789                        +-----------+
1790                        |  Host A   | 
1791                        +-+---+---+-+
1792                          |   |   |
1793                 +--------+   |   +---------+
1794                 |            |             |
1795          +------+---+  +-----+----+  +-----+----+
1796          | Switch A |  | Switch B |  | Switch C |
1797          +------+---+  +-----+----+  +-----+----+
1798                 |            |             |
1799                 +--------+   |   +---------+
1800                          |   |   |
1801                        +-+---+---+-+
1802                        |  Host B   | 
1803                        +-----------+
1804
1805         In this configuration, the switches are isolated from one
1806 another.  One reason to employ a topology such as this is for an
1807 isolated network with many hosts (a cluster configured for high
1808 performance, for example), using multiple smaller switches can be more
1809 cost effective than a single larger switch, e.g., on a network with 24
1810 hosts, three 24 port switches can be significantly less expensive than
1811 a single 72 port switch.
1812
1813         If access beyond the network is required, an individual host
1814 can be equipped with an additional network device connected to an
1815 external network; this host then additionally acts as a gateway.
1816
1817 12.2.1 MT Bonding Mode Selection for Multiple Switch Topology
1818 -------------------------------------------------------------
1819
1820         In actual practice, the bonding mode typically employed in
1821 configurations of this type is balance-rr.  Historically, in this
1822 network configuration, the usual caveats about out of order packet
1823 delivery are mitigated by the use of network adapters that do not do
1824 any kind of packet coalescing (via the use of NAPI, or because the
1825 device itself does not generate interrupts until some number of
1826 packets has arrived).  When employed in this fashion, the balance-rr
1827 mode allows individual connections between two hosts to effectively
1828 utilize greater than one interface's bandwidth.
1829
1830 12.2.2 MT Link Monitoring for Multiple Switch Topology
1831 ------------------------------------------------------
1832
1833         Again, in actual practice, the MII monitor is most often used
1834 in this configuration, as performance is given preference over
1835 availability.  The ARP monitor will function in this topology, but its
1836 advantages over the MII monitor are mitigated by the volume of probes
1837 needed as the number of systems involved grows (remember that each
1838 host in the network is configured with bonding).
1839
1840 13. Switch Behavior Issues
1841 ==========================
1842
1843 13.1 Link Establishment and Failover Delays
1844 -------------------------------------------
1845
1846         Some switches exhibit undesirable behavior with regard to the
1847 timing of link up and down reporting by the switch.
1848
1849         First, when a link comes up, some switches may indicate that
1850 the link is up (carrier available), but not pass traffic over the
1851 interface for some period of time.  This delay is typically due to
1852 some type of autonegotiation or routing protocol, but may also occur
1853 during switch initialization (e.g., during recovery after a switch
1854 failure).  If you find this to be a problem, specify an appropriate
1855 value to the updelay bonding module option to delay the use of the
1856 relevant interface(s).
1857
1858         Second, some switches may "bounce" the link state one or more
1859 times while a link is changing state.  This occurs most commonly while
1860 the switch is initializing.  Again, an appropriate updelay value may
1861 help.
1862
1863         Note that when a bonding interface has no active links, the
1864 driver will immediately reuse the first link that goes up, even if the
1865 updelay parameter has been specified (the updelay is ignored in this
1866 case).  If there are slave interfaces waiting for the updelay timeout
1867 to expire, the interface that first went into that state will be
1868 immediately reused.  This reduces down time of the network if the
1869 value of updelay has been overestimated, and since this occurs only in
1870 cases with no connectivity, there is no additional penalty for
1871 ignoring the updelay.
1872
1873         In addition to the concerns about switch timings, if your
1874 switches take a long time to go into backup mode, it may be desirable
1875 to not activate a backup interface immediately after a link goes down.
1876 Failover may be delayed via the downdelay bonding module option.
1877
1878 13.2 Duplicated Incoming Packets
1879 --------------------------------
1880
1881         It is not uncommon to observe a short burst of duplicated
1882 traffic when the bonding device is first used, or after it has been
1883 idle for some period of time.  This is most easily observed by issuing
1884 a "ping" to some other host on the network, and noticing that the
1885 output from ping flags duplicates (typically one per slave).
1886
1887         For example, on a bond in active-backup mode with five slaves
1888 all connected to one switch, the output may appear as follows:
1889
1890 # ping -n 10.0.4.2
1891 PING 10.0.4.2 (10.0.4.2) from 10.0.3.10 : 56(84) bytes of data.
1892 64 bytes from 10.0.4.2: icmp_seq=1 ttl=64 time=13.7 ms
1893 64 bytes from 10.0.4.2: icmp_seq=1 ttl=64 time=13.8 ms (DUP!)
1894 64 bytes from 10.0.4.2: icmp_seq=1 ttl=64 time=13.8 ms (DUP!)
1895 64 bytes from 10.0.4.2: icmp_seq=1 ttl=64 time=13.8 ms (DUP!)
1896 64 bytes from 10.0.4.2: icmp_seq=1 ttl=64 time=13.8 ms (DUP!)
1897 64 bytes from 10.0.4.2: icmp_seq=2 ttl=64 time=0.216 ms
1898 64 bytes from 10.0.4.2: icmp_seq=3 ttl=64 time=0.267 ms
1899 64 bytes from 10.0.4.2: icmp_seq=4 ttl=64 time=0.222 ms
1900
1901         This is not due to an error in the bonding driver, rather, it
1902 is a side effect of how many switches update their MAC forwarding
1903 tables.  Initially, the switch does not associate the MAC address in
1904 the packet with a particular switch port, and so it may send the
1905 traffic to all ports until its MAC forwarding table is updated.  Since
1906 the interfaces attached to the bond may occupy multiple ports on a
1907 single switch, when the switch (temporarily) floods the traffic to all
1908 ports, the bond device receives multiple copies of the same packet
1909 (one per slave device).
1910
1911         The duplicated packet behavior is switch dependent, some
1912 switches exhibit this, and some do not.  On switches that display this
1913 behavior, it can be induced by clearing the MAC forwarding table (on
1914 most Cisco switches, the privileged command "clear mac address-table
1915 dynamic" will accomplish this).
1916
1917 14. Hardware Specific Considerations
1918 ====================================
1919
1920         This section contains additional information for configuring
1921 bonding on specific hardware platforms, or for interfacing bonding
1922 with particular switches or other devices.
1923
1924 14.1 IBM BladeCenter
1925 --------------------
1926
1927         This applies to the JS20 and similar systems.
1928
1929         On the JS20 blades, the bonding driver supports only
1930 balance-rr, active-backup, balance-tlb and balance-alb modes.  This is
1931 largely due to the network topology inside the BladeCenter, detailed
1932 below.
1933
1934 JS20 network adapter information
1935 --------------------------------
1936
1937         All JS20s come with two Broadcom Gigabit Ethernet ports
1938 integrated on the planar (that's "motherboard" in IBM-speak).  In the
1939 BladeCenter chassis, the eth0 port of all JS20 blades is hard wired to
1940 I/O Module #1; similarly, all eth1 ports are wired to I/O Module #2.
1941 An add-on Broadcom daughter card can be installed on a JS20 to provide
1942 two more Gigabit Ethernet ports.  These ports, eth2 and eth3, are
1943 wired to I/O Modules 3 and 4, respectively.
1944
1945         Each I/O Module may contain either a switch or a passthrough
1946 module (which allows ports to be directly connected to an external
1947 switch).  Some bonding modes require a specific BladeCenter internal
1948 network topology in order to function; these are detailed below.
1949
1950         Additional BladeCenter-specific networking information can be
1951 found in two IBM Redbooks (www.ibm.com/redbooks):
1952
1953 "IBM eServer BladeCenter Networking Options"
1954 "IBM eServer BladeCenter Layer 2-7 Network Switching"
1955
1956 BladeCenter networking configuration
1957 ------------------------------------
1958
1959         Because a BladeCenter can be configured in a very large number
1960 of ways, this discussion will be confined to describing basic
1961 configurations.
1962
1963         Normally, Ethernet Switch Modules (ESMs) are used in I/O
1964 modules 1 and 2.  In this configuration, the eth0 and eth1 ports of a
1965 JS20 will be connected to different internal switches (in the
1966 respective I/O modules).
1967
1968         A passthrough module (OPM or CPM, optical or copper,
1969 passthrough module) connects the I/O module directly to an external
1970 switch.  By using PMs in I/O module #1 and #2, the eth0 and eth1
1971 interfaces of a JS20 can be redirected to the outside world and
1972 connected to a common external switch.
1973
1974         Depending upon the mix of ESMs and PMs, the network will
1975 appear to bonding as either a single switch topology (all PMs) or as a
1976 multiple switch topology (one or more ESMs, zero or more PMs).  It is
1977 also possible to connect ESMs together, resulting in a configuration
1978 much like the example in "High Availability in a Multiple Switch
1979 Topology," above.
1980
1981 Requirements for specific modes
1982 -------------------------------
1983
1984         The balance-rr mode requires the use of passthrough modules
1985 for devices in the bond, all connected to an common external switch.
1986 That switch must be configured for "etherchannel" or "trunking" on the
1987 appropriate ports, as is usual for balance-rr.
1988
1989         The balance-alb and balance-tlb modes will function with
1990 either switch modules or passthrough modules (or a mix).  The only
1991 specific requirement for these modes is that all network interfaces
1992 must be able to reach all destinations for traffic sent over the
1993 bonding device (i.e., the network must converge at some point outside
1994 the BladeCenter).
1995
1996         The active-backup mode has no additional requirements.
1997
1998 Link monitoring issues
1999 ----------------------
2000
2001         When an Ethernet Switch Module is in place, only the ARP
2002 monitor will reliably detect link loss to an external switch.  This is
2003 nothing unusual, but examination of the BladeCenter cabinet would
2004 suggest that the "external" network ports are the ethernet ports for
2005 the system, when it fact there is a switch between these "external"
2006 ports and the devices on the JS20 system itself.  The MII monitor is
2007 only able to detect link failures between the ESM and the JS20 system.
2008
2009         When a passthrough module is in place, the MII monitor does
2010 detect failures to the "external" port, which is then directly
2011 connected to the JS20 system.
2012
2013 Other concerns
2014 --------------
2015
2016         The Serial Over LAN (SoL) link is established over the primary
2017 ethernet (eth0) only, therefore, any loss of link to eth0 will result
2018 in losing your SoL connection.  It will not fail over with other
2019 network traffic, as the SoL system is beyond the control of the
2020 bonding driver.
2021
2022         It may be desirable to disable spanning tree on the switch
2023 (either the internal Ethernet Switch Module, or an external switch) to
2024 avoid fail-over delay issues when using bonding.
2025
2026         
2027 15. Frequently Asked Questions
2028 ==============================
2029
2030 1.  Is it SMP safe?
2031
2032         Yes. The old 2.0.xx channel bonding patch was not SMP safe.
2033 The new driver was designed to be SMP safe from the start.
2034
2035 2.  What type of cards will work with it?
2036
2037         Any Ethernet type cards (you can even mix cards - a Intel
2038 EtherExpress PRO/100 and a 3com 3c905b, for example).  For most modes,
2039 devices need not be of the same speed.
2040
2041 3.  How many bonding devices can I have?
2042
2043         There is no limit.
2044
2045 4.  How many slaves can a bonding device have?
2046
2047         This is limited only by the number of network interfaces Linux
2048 supports and/or the number of network cards you can place in your
2049 system.
2050
2051 5.  What happens when a slave link dies?
2052
2053         If link monitoring is enabled, then the failing device will be
2054 disabled.  The active-backup mode will fail over to a backup link, and
2055 other modes will ignore the failed link.  The link will continue to be
2056 monitored, and should it recover, it will rejoin the bond (in whatever
2057 manner is appropriate for the mode). See the sections on High
2058 Availability and the documentation for each mode for additional
2059 information.
2060         
2061         Link monitoring can be enabled via either the miimon or
2062 arp_interval parameters (described in the module parameters section,
2063 above).  In general, miimon monitors the carrier state as sensed by
2064 the underlying network device, and the arp monitor (arp_interval)
2065 monitors connectivity to another host on the local network.
2066
2067         If no link monitoring is configured, the bonding driver will
2068 be unable to detect link failures, and will assume that all links are
2069 always available.  This will likely result in lost packets, and a
2070 resulting degradation of performance.  The precise performance loss
2071 depends upon the bonding mode and network configuration.
2072
2073 6.  Can bonding be used for High Availability?
2074
2075         Yes.  See the section on High Availability for details.
2076
2077 7.  Which switches/systems does it work with?
2078
2079         The full answer to this depends upon the desired mode.
2080
2081         In the basic balance modes (balance-rr and balance-xor), it
2082 works with any system that supports etherchannel (also called
2083 trunking).  Most managed switches currently available have such
2084 support, and many unmanaged switches as well.
2085
2086         The advanced balance modes (balance-tlb and balance-alb) do
2087 not have special switch requirements, but do need device drivers that
2088 support specific features (described in the appropriate section under
2089 module parameters, above).
2090
2091         In 802.3ad mode, it works with systems that support IEEE
2092 802.3ad Dynamic Link Aggregation.  Most managed and many unmanaged
2093 switches currently available support 802.3ad.
2094
2095         The active-backup mode should work with any Layer-II switch.
2096
2097 8.  Where does a bonding device get its MAC address from?
2098
2099         If not explicitly configured (with ifconfig or ip link), the
2100 MAC address of the bonding device is taken from its first slave
2101 device.  This MAC address is then passed to all following slaves and
2102 remains persistent (even if the first slave is removed) until the
2103 bonding device is brought down or reconfigured.
2104
2105         If you wish to change the MAC address, you can set it with
2106 ifconfig or ip link:
2107
2108 # ifconfig bond0 hw ether 00:11:22:33:44:55
2109
2110 # ip link set bond0 address 66:77:88:99:aa:bb
2111
2112         The MAC address can be also changed by bringing down/up the
2113 device and then changing its slaves (or their order):
2114
2115 # ifconfig bond0 down ; modprobe -r bonding
2116 # ifconfig bond0 .... up
2117 # ifenslave bond0 eth...
2118
2119         This method will automatically take the address from the next
2120 slave that is added.
2121
2122         To restore your slaves' MAC addresses, you need to detach them
2123 from the bond (`ifenslave -d bond0 eth0'). The bonding driver will
2124 then restore the MAC addresses that the slaves had before they were
2125 enslaved.
2126
2127 16. Resources and Links
2128 =======================
2129
2130 The latest version of the bonding driver can be found in the latest
2131 version of the linux kernel, found on http://kernel.org
2132
2133 The latest version of this document can be found in either the latest
2134 kernel source (named Documentation/networking/bonding.txt), or on the
2135 bonding sourceforge site:
2136
2137 http://www.sourceforge.net/projects/bonding
2138
2139 Discussions regarding the bonding driver take place primarily on the
2140 bonding-devel mailing list, hosted at sourceforge.net.  If you have
2141 questions or problems, post them to the list.  The list address is:
2142
2143 bonding-devel@lists.sourceforge.net
2144
2145         The administrative interface (to subscribe or unsubscribe) can
2146 be found at:
2147
2148 https://lists.sourceforge.net/lists/listinfo/bonding-devel
2149
2150 Donald Becker's Ethernet Drivers and diag programs may be found at :
2151  - http://www.scyld.com/network/
2152
2153 You will also find a lot of information regarding Ethernet, NWay, MII,
2154 etc. at www.scyld.com.
2155
2156 -- END --