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