blob: 6cc30e0d5795ce8e598190fb32edf1624a58a203 [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
Jay Vosburgh6f6652b2007-12-06 23:40:34 -0800557 layer2+3
558
559 This policy uses a combination of layer2 and layer3
560 protocol information to generate the hash.
561
562 Uses XOR of hardware MAC addresses and IP addresses to
563 generate the hash. The formula is
564
565 (((source IP XOR dest IP) AND 0xffff) XOR
566 ( source MAC XOR destination MAC ))
567 modulo slave count
568
569 This algorithm will place all traffic to a particular
570 network peer on the same slave. For non-IP traffic,
571 the formula is the same as for the layer2 transmit
572 hash policy.
573
574 This policy is intended to provide a more balanced
575 distribution of traffic than layer2 alone, especially
576 in environments where a layer3 gateway device is
577 required to reach most destinations.
578
579 This algorithm is 802.3ad complient.
580
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700581 layer3+4
582
583 This policy uses upper layer protocol information,
584 when available, to generate the hash. This allows for
585 traffic to a particular network peer to span multiple
586 slaves, although a single connection will not span
587 multiple slaves.
588
589 The formula for unfragmented TCP and UDP packets is
590
591 ((source port XOR dest port) XOR
592 ((source IP XOR dest IP) AND 0xffff)
593 modulo slave count
594
595 For fragmented TCP or UDP packets and all other IP
596 protocol traffic, the source and destination port
597 information is omitted. For non-IP traffic, the
598 formula is the same as for the layer2 transmit hash
599 policy.
600
601 This policy is intended to mimic the behavior of
602 certain switches, notably Cisco switches with PFC2 as
603 well as some Foundry and IBM products.
604
605 This algorithm is not fully 802.3ad compliant. A
606 single TCP or UDP conversation containing both
607 fragmented and unfragmented packets will see packets
608 striped across two interfaces. This may result in out
609 of order delivery. Most traffic types will not meet
610 this criteria, as TCP rarely fragments traffic, and
611 most UDP traffic is not involved in extended
612 conversations. Other implementations of 802.3ad may
613 or may not tolerate this noncompliance.
614
615 The default value is layer2. This option was added in bonding
Jay Vosburgh6f6652b2007-12-06 23:40:34 -0800616 version 2.6.3. In earlier versions of bonding, this parameter
617 does not exist, and the layer2 policy is the only policy. The
618 layer2+3 value was added for bonding version 3.2.2.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
620
6213. Configuring Bonding Devices
622==============================
623
Auke Kok6224e012006-06-08 11:15:35 -0700624 You can configure bonding using either your distro's network
625initialization scripts, or manually using either ifenslave or the
626sysfs interface. Distros generally use one of two packages for the
627network initialization scripts: initscripts or sysconfig. Recent
628versions of these packages have support for bonding, while older
629versions do not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
631 We will first describe the options for configuring bonding for
632distros using versions of initscripts and sysconfig with full or
633partial support for bonding, then provide information on enabling
634bonding without support from the network initialization scripts (i.e.,
635older versions of initscripts or sysconfig).
636
637 If you're unsure whether your distro uses sysconfig or
638initscripts, or don't know if it's new enough, have no fear.
639Determining this is fairly straightforward.
640
641 First, issue the command:
642
643$ rpm -qf /sbin/ifup
644
645 It will respond with a line of text starting with either
646"initscripts" or "sysconfig," followed by some numbers. This is the
647package that provides your network initialization scripts.
648
649 Next, to determine if your installation supports bonding,
650issue the command:
651
652$ grep ifenslave /sbin/ifup
653
654 If this returns any matches, then your initscripts or
655sysconfig has support for bonding.
656
Auke Kok6224e012006-06-08 11:15:35 -07006573.1 Configuration with Sysconfig Support
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658----------------------------------------
659
660 This section applies to distros using a version of sysconfig
661with bonding support, for example, SuSE Linux Enterprise Server 9.
662
663 SuSE SLES 9's networking configuration system does support
664bonding, however, at this writing, the YaST system configuration
Auke Kok6224e012006-06-08 11:15:35 -0700665front end does not provide any means to work with bonding devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666Bonding devices can be managed by hand, however, as follows.
667
668 First, if they have not already been configured, configure the
669slave devices. On SLES 9, this is most easily done by running the
670yast2 sysconfig configuration utility. The goal is for to create an
671ifcfg-id file for each slave device. The simplest way to accomplish
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700672this is to configure the devices for DHCP (this is only to get the
673file ifcfg-id file created; see below for some issues with DHCP). The
674name of the configuration file for each device will be of the form:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675
676ifcfg-id-xx:xx:xx:xx:xx:xx
677
678 Where the "xx" portion will be replaced with the digits from
679the device's permanent MAC address.
680
681 Once the set of ifcfg-id-xx:xx:xx:xx:xx:xx files has been
682created, it is necessary to edit the configuration files for the slave
683devices (the MAC addresses correspond to those of the slave devices).
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700684Before editing, the file will contain multiple lines, and will look
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685something like this:
686
687BOOTPROTO='dhcp'
688STARTMODE='on'
689USERCTL='no'
690UNIQUE='XNzu.WeZGOGF+4wE'
691_nm_name='bus-pci-0001:61:01.0'
692
693 Change the BOOTPROTO and STARTMODE lines to the following:
694
695BOOTPROTO='none'
696STARTMODE='off'
697
698 Do not alter the UNIQUE or _nm_name lines. Remove any other
699lines (USERCTL, etc).
700
701 Once the ifcfg-id-xx:xx:xx:xx:xx:xx files have been modified,
702it's time to create the configuration file for the bonding device
703itself. This file is named ifcfg-bondX, where X is the number of the
704bonding device to create, starting at 0. The first such file is
705ifcfg-bond0, the second is ifcfg-bond1, and so on. The sysconfig
706network configuration system will correctly start multiple instances
707of bonding.
708
709 The contents of the ifcfg-bondX file is as follows:
710
711BOOTPROTO="static"
712BROADCAST="10.0.2.255"
713IPADDR="10.0.2.10"
714NETMASK="255.255.0.0"
715NETWORK="10.0.2.0"
716REMOTE_IPADDR=""
717STARTMODE="onboot"
718BONDING_MASTER="yes"
719BONDING_MODULE_OPTS="mode=active-backup miimon=100"
720BONDING_SLAVE0="eth0"
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700721BONDING_SLAVE1="bus-pci-0000:06:08.1"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
723 Replace the sample BROADCAST, IPADDR, NETMASK and NETWORK
724values with the appropriate values for your network.
725
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 The STARTMODE specifies when the device is brought online.
727The possible values are:
728
729 onboot: The device is started at boot time. If you're not
730 sure, this is probably what you want.
731
732 manual: The device is started only when ifup is called
733 manually. Bonding devices may be configured this
734 way if you do not wish them to start automatically
735 at boot for some reason.
736
737 hotplug: The device is started by a hotplug event. This is not
738 a valid choice for a bonding device.
739
740 off or ignore: The device configuration is ignored.
741
742 The line BONDING_MASTER='yes' indicates that the device is a
743bonding master device. The only useful value is "yes."
744
745 The contents of BONDING_MODULE_OPTS are supplied to the
746instance of the bonding module for this device. Specify the options
747for the bonding mode, link monitoring, and so on here. Do not include
748the max_bonds bonding parameter; this will confuse the configuration
749system if you have multiple bonding devices.
750
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700751 Finally, supply one BONDING_SLAVEn="slave device" for each
752slave. where "n" is an increasing value, one for each slave. The
753"slave device" is either an interface name, e.g., "eth0", or a device
754specifier for the network device. The interface name is easier to
755find, but the ethN names are subject to change at boot time if, e.g.,
756a device early in the sequence has failed. The device specifiers
757(bus-pci-0000:06:08.1 in the example above) specify the physical
758network device, and will not change unless the device's bus location
759changes (for example, it is moved from one PCI slot to another). The
760example above uses one of each type for demonstration purposes; most
761configurations will choose one or the other for all slave devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
763 When all configuration files have been modified or created,
764networking must be restarted for the configuration changes to take
765effect. This can be accomplished via the following:
766
767# /etc/init.d/network restart
768
769 Note that the network control script (/sbin/ifdown) will
770remove the bonding module as part of the network shutdown processing,
771so it is not necessary to remove the module by hand if, e.g., the
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700772module parameters have changed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773
774 Also, at this writing, YaST/YaST2 will not manage bonding
775devices (they do not show bonding interfaces on its list of network
776devices). It is necessary to edit the configuration file by hand to
777change the bonding configuration.
778
779 Additional general options and details of the ifcfg file
780format can be found in an example ifcfg template file:
781
782/etc/sysconfig/network/ifcfg.template
783
784 Note that the template does not document the various BONDING_
785settings described above, but does describe many of the other options.
786
Auke Kok6224e012006-06-08 11:15:35 -07007873.1.1 Using DHCP with Sysconfig
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700788-------------------------------
789
790 Under sysconfig, configuring a device with BOOTPROTO='dhcp'
791will cause it to query DHCP for its IP address information. At this
792writing, this does not function for bonding devices; the scripts
793attempt to obtain the device address from DHCP prior to adding any of
794the slave devices. Without active slaves, the DHCP requests are not
795sent to the network.
796
Auke Kok6224e012006-06-08 11:15:35 -07007973.1.2 Configuring Multiple Bonds with Sysconfig
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700798-----------------------------------------------
799
800 The sysconfig network initialization system is capable of
801handling multiple bonding devices. All that is necessary is for each
802bonding instance to have an appropriately configured ifcfg-bondX file
803(as described above). Do not specify the "max_bonds" parameter to any
804instance of bonding, as this will confuse sysconfig. If you require
805multiple bonding devices with identical parameters, create multiple
806ifcfg-bondX files.
807
808 Because the sysconfig scripts supply the bonding module
809options in the ifcfg-bondX file, it is not necessary to add them to
810the system /etc/modules.conf or /etc/modprobe.conf configuration file.
811
Auke Kok6224e012006-06-08 11:15:35 -07008123.2 Configuration with Initscripts Support
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813------------------------------------------
814
815 This section applies to distros using a version of initscripts
816with bonding support, for example, Red Hat Linux 9 or Red Hat
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700817Enterprise Linux version 3 or 4. On these systems, the network
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818initialization scripts have some knowledge of bonding, and can be
819configured to control bonding devices.
820
821 These distros will not automatically load the network adapter
822driver unless the ethX device is configured with an IP address.
823Because of this constraint, users must manually configure a
824network-script file for all physical adapters that will be members of
825a bondX link. Network script files are located in the directory:
826
827/etc/sysconfig/network-scripts
828
829 The file name must be prefixed with "ifcfg-eth" and suffixed
830with the adapter's physical adapter number. For example, the script
831for eth0 would be named /etc/sysconfig/network-scripts/ifcfg-eth0.
832Place the following text in the file:
833
834DEVICE=eth0
835USERCTL=no
836ONBOOT=yes
837MASTER=bond0
838SLAVE=yes
839BOOTPROTO=none
840
841 The DEVICE= line will be different for every ethX device and
842must correspond with the name of the file, i.e., ifcfg-eth1 must have
843a device line of DEVICE=eth1. The setting of the MASTER= line will
844also depend on the final bonding interface name chosen for your bond.
845As with other network devices, these typically start at 0, and go up
846one for each device, i.e., the first bonding instance is bond0, the
847second is bond1, and so on.
848
849 Next, create a bond network script. The file name for this
850script will be /etc/sysconfig/network-scripts/ifcfg-bondX where X is
851the number of the bond. For bond0 the file is named "ifcfg-bond0",
852for bond1 it is named "ifcfg-bond1", and so on. Within that file,
853place the following text:
854
855DEVICE=bond0
856IPADDR=192.168.1.1
857NETMASK=255.255.255.0
858NETWORK=192.168.1.0
859BROADCAST=192.168.1.255
860ONBOOT=yes
861BOOTPROTO=none
862USERCTL=no
863
864 Be sure to change the networking specific lines (IPADDR,
865NETMASK, NETWORK and BROADCAST) to match your network configuration.
866
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700867 Finally, it is necessary to edit /etc/modules.conf (or
868/etc/modprobe.conf, depending upon your distro) to load the bonding
869module with your desired options when the bond0 interface is brought
870up. The following lines in /etc/modules.conf (or modprobe.conf) will
871load the bonding module, and select its options:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872
873alias bond0 bonding
874options bond0 mode=balance-alb miimon=100
875
876 Replace the sample parameters with the appropriate set of
877options for your configuration.
878
879 Finally run "/etc/rc.d/init.d/network restart" as root. This
880will restart the networking subsystem and your bond link should be now
881up and running.
882
Auke Kok6224e012006-06-08 11:15:35 -07008833.2.1 Using DHCP with Initscripts
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700884---------------------------------
885
886 Recent versions of initscripts (the version supplied with
887Fedora Core 3 and Red Hat Enterprise Linux 4 is reported to work) do
888have support for assigning IP information to bonding devices via DHCP.
889
890 To configure bonding for DHCP, configure it as described
891above, except replace the line "BOOTPROTO=none" with "BOOTPROTO=dhcp"
892and add a line consisting of "TYPE=Bonding". Note that the TYPE value
893is case sensitive.
894
Auke Kok6224e012006-06-08 11:15:35 -07008953.2.2 Configuring Multiple Bonds with Initscripts
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700896-------------------------------------------------
897
898 At this writing, the initscripts package does not directly
899support loading the bonding driver multiple times, so the process for
900doing so is the same as described in the "Configuring Multiple Bonds
901Manually" section, below.
902
903 NOTE: It has been observed that some Red Hat supplied kernels
John W. Linville4cac0182005-10-18 21:30:59 -0400904are apparently unable to rename modules at load time (the "-o bond1"
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700905part). Attempts to pass that option to modprobe will produce an
906"Operation not permitted" error. This has been reported on some
907Fedora Core kernels, and has been seen on RHEL 4 as well. On kernels
908exhibiting this problem, it will be impossible to configure multiple
909bonds with differing parameters.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910
Auke Kok6224e012006-06-08 11:15:35 -07009113.3 Configuring Bonding Manually with Ifenslave
912-----------------------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913
914 This section applies to distros whose network initialization
915scripts (the sysconfig or initscripts package) do not have specific
916knowledge of bonding. One such distro is SuSE Linux Enterprise Server
917version 8.
918
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700919 The general method for these systems is to place the bonding
920module parameters into /etc/modules.conf or /etc/modprobe.conf (as
921appropriate for the installed distro), then add modprobe and/or
922ifenslave commands to the system's global init script. The name of
923the global init script differs; for sysconfig, it is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924/etc/init.d/boot.local and for initscripts it is /etc/rc.d/rc.local.
925
926 For example, if you wanted to make a simple bond of two e100
927devices (presumed to be eth0 and eth1), and have it persist across
928reboots, edit the appropriate file (/etc/init.d/boot.local or
929/etc/rc.d/rc.local), and add the following:
930
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700931modprobe bonding mode=balance-alb miimon=100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932modprobe e100
933ifconfig bond0 192.168.1.1 netmask 255.255.255.0 up
934ifenslave bond0 eth0
935ifenslave bond0 eth1
936
937 Replace the example bonding module parameters and bond0
938network configuration (IP address, netmask, etc) with the appropriate
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700939values for your configuration.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
941 Unfortunately, this method will not provide support for the
942ifup and ifdown scripts on the bond devices. To reload the bonding
943configuration, it is necessary to run the initialization script, e.g.,
944
945# /etc/init.d/boot.local
946
947 or
948
949# /etc/rc.d/rc.local
950
951 It may be desirable in such a case to create a separate script
952which only initializes the bonding configuration, then call that
953separate script from within boot.local. This allows for bonding to be
954enabled without re-running the entire global init script.
955
956 To shut down the bonding devices, it is necessary to first
957mark the bonding device itself as being down, then remove the
958appropriate device driver modules. For our example above, you can do
959the following:
960
961# ifconfig bond0 down
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700962# rmmod bonding
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963# rmmod e100
964
965 Again, for convenience, it may be desirable to create a script
966with these commands.
967
968
Jay Vosburgh00354cf2005-07-21 12:18:02 -07009693.3.1 Configuring Multiple Bonds Manually
970-----------------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971
972 This section contains information on configuring multiple
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700973bonding devices with differing options for those systems whose network
974initialization scripts lack support for configuring multiple bonds.
975
976 If you require multiple bonding devices, but all with the same
977options, you may wish to use the "max_bonds" module parameter,
978documented above.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979
980 To create multiple bonding devices with differing options, it
Alexandra N. Kossovsky9198d222007-04-26 01:40:13 -0700981is necessary to use bonding parameters exported by sysfs, documented
982in the section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700984
Auke Kok6224e012006-06-08 11:15:35 -07009853.4 Configuring Bonding Manually via Sysfs
986------------------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987
Auke Kok6224e012006-06-08 11:15:35 -0700988 Starting with version 3.0, Channel Bonding may be configured
989via the sysfs interface. This interface allows dynamic configuration
990of all bonds in the system without unloading the module. It also
991allows for adding and removing bonds at runtime. Ifenslave is no
992longer required, though it is still supported.
993
994 Use of the sysfs interface allows you to use multiple bonds
995with different configurations without having to reload the module.
996It also allows you to use multiple, differently configured bonds when
997bonding is compiled into the kernel.
998
999 You must have the sysfs filesystem mounted to configure
1000bonding this way. The examples in this document assume that you
1001are using the standard mount point for sysfs, e.g. /sys. If your
1002sysfs filesystem is mounted elsewhere, you will need to adjust the
1003example paths accordingly.
1004
1005Creating and Destroying Bonds
1006-----------------------------
1007To add a new bond foo:
1008# echo +foo > /sys/class/net/bonding_masters
1009
1010To remove an existing bond bar:
1011# echo -bar > /sys/class/net/bonding_masters
1012
1013To show all existing bonds:
1014# cat /sys/class/net/bonding_masters
1015
1016NOTE: due to 4K size limitation of sysfs files, this list may be
1017truncated if you have more than a few hundred bonds. This is unlikely
1018to occur under normal operating conditions.
1019
1020Adding and Removing Slaves
1021--------------------------
1022 Interfaces may be enslaved to a bond using the file
1023/sys/class/net/<bond>/bonding/slaves. The semantics for this file
1024are the same as for the bonding_masters file.
1025
1026To enslave interface eth0 to bond bond0:
1027# ifconfig bond0 up
1028# echo +eth0 > /sys/class/net/bond0/bonding/slaves
1029
1030To free slave eth0 from bond bond0:
1031# echo -eth0 > /sys/class/net/bond0/bonding/slaves
1032
1033 NOTE: The bond must be up before slaves can be added. All
1034slaves are freed when the interface is brought down.
1035
1036 When an interface is enslaved to a bond, symlinks between the
1037two are created in the sysfs filesystem. In this case, you would get
1038/sys/class/net/bond0/slave_eth0 pointing to /sys/class/net/eth0, and
1039/sys/class/net/eth0/master pointing to /sys/class/net/bond0.
1040
1041 This means that you can tell quickly whether or not an
1042interface is enslaved by looking for the master symlink. Thus:
1043# echo -eth0 > /sys/class/net/eth0/master/bonding/slaves
1044will free eth0 from whatever bond it is enslaved to, regardless of
1045the name of the bond interface.
1046
1047Changing a Bond's Configuration
1048-------------------------------
1049 Each bond may be configured individually by manipulating the
1050files located in /sys/class/net/<bond name>/bonding
1051
1052 The names of these files correspond directly with the command-
Paolo Ornati670e9f32006-10-03 22:57:56 +02001053line parameters described elsewhere in this file, and, with the
Auke Kok6224e012006-06-08 11:15:35 -07001054exception of arp_ip_target, they accept the same values. To see the
1055current setting, simply cat the appropriate file.
1056
1057 A few examples will be given here; for specific usage
1058guidelines for each parameter, see the appropriate section in this
1059document.
1060
1061To configure bond0 for balance-alb mode:
1062# ifconfig bond0 down
1063# echo 6 > /sys/class/net/bond0/bonding/mode
1064 - or -
1065# echo balance-alb > /sys/class/net/bond0/bonding/mode
1066 NOTE: The bond interface must be down before the mode can be
1067changed.
1068
1069To enable MII monitoring on bond0 with a 1 second interval:
1070# echo 1000 > /sys/class/net/bond0/bonding/miimon
1071 NOTE: If ARP monitoring is enabled, it will disabled when MII
1072monitoring is enabled, and vice-versa.
1073
1074To add ARP targets:
1075# echo +192.168.0.100 > /sys/class/net/bond0/bonding/arp_ip_target
1076# echo +192.168.0.101 > /sys/class/net/bond0/bonding/arp_ip_target
1077 NOTE: up to 10 target addresses may be specified.
1078
1079To remove an ARP target:
1080# echo -192.168.0.100 > /sys/class/net/bond0/bonding/arp_ip_target
1081
1082Example Configuration
1083---------------------
1084 We begin with the same example that is shown in section 3.3,
1085executed with sysfs, and without using ifenslave.
1086
1087 To make a simple bond of two e100 devices (presumed to be eth0
1088and eth1), and have it persist across reboots, edit the appropriate
1089file (/etc/init.d/boot.local or /etc/rc.d/rc.local), and add the
1090following:
1091
1092modprobe bonding
1093modprobe e100
1094echo balance-alb > /sys/class/net/bond0/bonding/mode
1095ifconfig bond0 192.168.1.1 netmask 255.255.255.0 up
1096echo 100 > /sys/class/net/bond0/bonding/miimon
1097echo +eth0 > /sys/class/net/bond0/bonding/slaves
1098echo +eth1 > /sys/class/net/bond0/bonding/slaves
1099
1100 To add a second bond, with two e1000 interfaces in
1101active-backup mode, using ARP monitoring, add the following lines to
1102your init script:
1103
1104modprobe e1000
1105echo +bond1 > /sys/class/net/bonding_masters
1106echo active-backup > /sys/class/net/bond1/bonding/mode
1107ifconfig bond1 192.168.2.1 netmask 255.255.255.0 up
1108echo +192.168.2.100 /sys/class/net/bond1/bonding/arp_ip_target
1109echo 2000 > /sys/class/net/bond1/bonding/arp_interval
1110echo +eth2 > /sys/class/net/bond1/bonding/slaves
1111echo +eth3 > /sys/class/net/bond1/bonding/slaves
1112
1113
11144. Querying Bonding Configuration
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115=================================
1116
Auke Kok6224e012006-06-08 11:15:35 -070011174.1 Bonding Configuration
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118-------------------------
1119
1120 Each bonding device has a read-only file residing in the
1121/proc/net/bonding directory. The file contents include information
1122about the bonding configuration, options and state of each slave.
1123
1124 For example, the contents of /proc/net/bonding/bond0 after the
1125driver is loaded with parameters of mode=0 and miimon=1000 is
1126generally as follows:
1127
1128 Ethernet Channel Bonding Driver: 2.6.1 (October 29, 2004)
1129 Bonding Mode: load balancing (round-robin)
1130 Currently Active Slave: eth0
1131 MII Status: up
1132 MII Polling Interval (ms): 1000
1133 Up Delay (ms): 0
1134 Down Delay (ms): 0
1135
1136 Slave Interface: eth1
1137 MII Status: up
1138 Link Failure Count: 1
1139
1140 Slave Interface: eth0
1141 MII Status: up
1142 Link Failure Count: 1
1143
1144 The precise format and contents will change depending upon the
1145bonding configuration, state, and version of the bonding driver.
1146
Auke Kok6224e012006-06-08 11:15:35 -070011474.2 Network configuration
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148-------------------------
1149
1150 The network configuration can be inspected using the ifconfig
1151command. Bonding devices will have the MASTER flag set; Bonding slave
1152devices will have the SLAVE flag set. The ifconfig output does not
1153contain information on which slaves are associated with which masters.
1154
1155 In the example below, the bond0 interface is the master
1156(MASTER) while eth0 and eth1 are slaves (SLAVE). Notice all slaves of
1157bond0 have the same MAC address (HWaddr) as bond0 for all modes except
1158TLB and ALB that require a unique MAC address for each slave.
1159
1160# /sbin/ifconfig
1161bond0 Link encap:Ethernet HWaddr 00:C0:F0:1F:37:B4
1162 inet addr:XXX.XXX.XXX.YYY Bcast:XXX.XXX.XXX.255 Mask:255.255.252.0
1163 UP BROADCAST RUNNING MASTER MULTICAST MTU:1500 Metric:1
1164 RX packets:7224794 errors:0 dropped:0 overruns:0 frame:0
1165 TX packets:3286647 errors:1 dropped:0 overruns:1 carrier:0
1166 collisions:0 txqueuelen:0
1167
1168eth0 Link encap:Ethernet HWaddr 00:C0:F0:1F:37:B4
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169 UP BROADCAST RUNNING SLAVE MULTICAST MTU:1500 Metric:1
1170 RX packets:3573025 errors:0 dropped:0 overruns:0 frame:0
1171 TX packets:1643167 errors:1 dropped:0 overruns:1 carrier:0
1172 collisions:0 txqueuelen:100
1173 Interrupt:10 Base address:0x1080
1174
1175eth1 Link encap:Ethernet HWaddr 00:C0:F0:1F:37:B4
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 UP BROADCAST RUNNING SLAVE MULTICAST MTU:1500 Metric:1
1177 RX packets:3651769 errors:0 dropped:0 overruns:0 frame:0
1178 TX packets:1643480 errors:0 dropped:0 overruns:0 carrier:0
1179 collisions:0 txqueuelen:100
1180 Interrupt:9 Base address:0x1400
1181
Auke Kok6224e012006-06-08 11:15:35 -070011825. Switch Configuration
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183=======================
1184
1185 For this section, "switch" refers to whatever system the
1186bonded devices are directly connected to (i.e., where the other end of
1187the cable plugs into). This may be an actual dedicated switch device,
1188or it may be another regular system (e.g., another computer running
1189Linux),
1190
1191 The active-backup, balance-tlb and balance-alb modes do not
1192require any specific configuration of the switch.
1193
1194 The 802.3ad mode requires that the switch have the appropriate
1195ports configured as an 802.3ad aggregation. The precise method used
1196to configure this varies from switch to switch, but, for example, a
1197Cisco 3550 series switch requires that the appropriate ports first be
1198grouped together in a single etherchannel instance, then that
1199etherchannel is set to mode "lacp" to enable 802.3ad (instead of
1200standard EtherChannel).
1201
1202 The balance-rr, balance-xor and broadcast modes generally
1203require that the switch have the appropriate ports grouped together.
1204The nomenclature for such a group differs between switches, it may be
1205called an "etherchannel" (as in the Cisco example, above), a "trunk
1206group" or some other similar variation. For these modes, each switch
1207will also have its own configuration options for the switch's transmit
1208policy to the bond. Typical choices include XOR of either the MAC or
1209IP addresses. The transmit policy of the two peers does not need to
1210match. For these three modes, the bonding mode really selects a
1211transmit policy for an EtherChannel group; all three will interoperate
1212with another EtherChannel group.
1213
1214
Auke Kok6224e012006-06-08 11:15:35 -070012156. 802.1q VLAN Support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216======================
1217
1218 It is possible to configure VLAN devices over a bond interface
1219using the 8021q driver. However, only packets coming from the 8021q
1220driver and passing through bonding will be tagged by default. Self
1221generated packets, for example, bonding's learning packets or ARP
1222packets generated by either ALB mode or the ARP monitor mechanism, are
1223tagged internally by bonding itself. As a result, bonding must
1224"learn" the VLAN IDs configured above it, and use those IDs to tag
1225self generated packets.
1226
1227 For reasons of simplicity, and to support the use of adapters
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001228that can do VLAN hardware acceleration offloading, the bonding
1229interface declares itself as fully hardware offloading capable, it gets
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230the add_vid/kill_vid notifications to gather the necessary
1231information, and it propagates those actions to the slaves. In case
1232of mixed adapter types, hardware accelerated tagged packets that
1233should go through an adapter that is not offloading capable are
1234"un-accelerated" by the bonding driver so the VLAN tag sits in the
1235regular location.
1236
1237 VLAN interfaces *must* be added on top of a bonding interface
1238only after enslaving at least one slave. The bonding interface has a
1239hardware address of 00:00:00:00:00:00 until the first slave is added.
1240If the VLAN interface is created prior to the first enslavement, it
1241would pick up the all-zeroes hardware address. Once the first slave
1242is attached to the bond, the bond device itself will pick up the
1243slave's hardware address, which is then available for the VLAN device.
1244
1245 Also, be aware that a similar problem can occur if all slaves
1246are released from a bond that still has one or more VLAN interfaces on
1247top of it. When a new slave is added, the bonding interface will
1248obtain its hardware address from the first slave, which might not
1249match the hardware address of the VLAN interfaces (which was
1250ultimately copied from an earlier slave).
1251
1252 There are two methods to insure that the VLAN device operates
1253with the correct hardware address if all slaves are removed from a
1254bond interface:
1255
1256 1. Remove all VLAN interfaces then recreate them
1257
1258 2. Set the bonding interface's hardware address so that it
1259matches the hardware address of the VLAN interfaces.
1260
1261 Note that changing a VLAN interface's HW address would set the
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001262underlying device -- i.e. the bonding interface -- to promiscuous
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263mode, which might not be what you want.
1264
1265
Auke Kok6224e012006-06-08 11:15:35 -070012667. Link Monitoring
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267==================
1268
1269 The bonding driver at present supports two schemes for
1270monitoring a slave device's link state: the ARP monitor and the MII
1271monitor.
1272
1273 At the present time, due to implementation restrictions in the
1274bonding driver itself, it is not possible to enable both ARP and MII
1275monitoring simultaneously.
1276
Auke Kok6224e012006-06-08 11:15:35 -070012777.1 ARP Monitor Operation
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278-------------------------
1279
1280 The ARP monitor operates as its name suggests: it sends ARP
1281queries to one or more designated peer systems on the network, and
1282uses the response as an indication that the link is operating. This
1283gives some assurance that traffic is actually flowing to and from one
1284or more peers on the local network.
1285
1286 The ARP monitor relies on the device driver itself to verify
1287that traffic is flowing. In particular, the driver must keep up to
1288date the last receive time, dev->last_rx, and transmit start time,
1289dev->trans_start. If these are not updated by the driver, then the
1290ARP monitor will immediately fail any slaves using that driver, and
1291those slaves will stay down. If networking monitoring (tcpdump, etc)
1292shows the ARP requests and replies on the network, then it may be that
1293your device driver is not updating last_rx and trans_start.
1294
Auke Kok6224e012006-06-08 11:15:35 -070012957.2 Configuring Multiple ARP Targets
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296------------------------------------
1297
1298 While ARP monitoring can be done with just one target, it can
1299be useful in a High Availability setup to have several targets to
1300monitor. In the case of just one target, the target itself may go
1301down or have a problem making it unresponsive to ARP requests. Having
1302an additional target (or several) increases the reliability of the ARP
1303monitoring.
1304
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001305 Multiple ARP targets must be separated by commas as follows:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306
1307# example options for ARP monitoring with three targets
1308alias bond0 bonding
1309options bond0 arp_interval=60 arp_ip_target=192.168.0.1,192.168.0.3,192.168.0.9
1310
1311 For just a single target the options would resemble:
1312
1313# example options for ARP monitoring with one target
1314alias bond0 bonding
1315options bond0 arp_interval=60 arp_ip_target=192.168.0.100
1316
1317
Auke Kok6224e012006-06-08 11:15:35 -070013187.3 MII Monitor Operation
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319-------------------------
1320
1321 The MII monitor monitors only the carrier state of the local
1322network interface. It accomplishes this in one of three ways: by
1323depending upon the device driver to maintain its carrier state, by
1324querying the device's MII registers, or by making an ethtool query to
1325the device.
1326
1327 If the use_carrier module parameter is 1 (the default value),
1328then the MII monitor will rely on the driver for carrier state
1329information (via the netif_carrier subsystem). As explained in the
1330use_carrier parameter information, above, if the MII monitor fails to
1331detect carrier loss on the device (e.g., when the cable is physically
1332disconnected), it may be that the driver does not support
1333netif_carrier.
1334
1335 If use_carrier is 0, then the MII monitor will first query the
1336device's (via ioctl) MII registers and check the link state. If that
1337request fails (not just that it returns carrier down), then the MII
1338monitor will make an ethtool ETHOOL_GLINK request to attempt to obtain
1339the same information. If both methods fail (i.e., the driver either
1340does not support or had some error in processing both the MII register
1341and ethtool requests), then the MII monitor will assume the link is
1342up.
1343
Auke Kok6224e012006-06-08 11:15:35 -070013448. Potential Sources of Trouble
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345===============================
1346
Auke Kok6224e012006-06-08 11:15:35 -070013478.1 Adventures in Routing
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348-------------------------
1349
1350 When bonding is configured, it is important that the slave
Auke Kok6224e012006-06-08 11:15:35 -07001351devices not have routes that supersede routes of the master (or,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352generally, not have routes at all). For example, suppose the bonding
1353device bond0 has two slaves, eth0 and eth1, and the routing table is
1354as follows:
1355
1356Kernel IP routing table
1357Destination Gateway Genmask Flags MSS Window irtt Iface
135810.0.0.0 0.0.0.0 255.255.0.0 U 40 0 0 eth0
135910.0.0.0 0.0.0.0 255.255.0.0 U 40 0 0 eth1
136010.0.0.0 0.0.0.0 255.255.0.0 U 40 0 0 bond0
1361127.0.0.0 0.0.0.0 255.0.0.0 U 40 0 0 lo
1362
1363 This routing configuration will likely still update the
1364receive/transmit times in the driver (needed by the ARP monitor), but
1365may bypass the bonding driver (because outgoing traffic to, in this
1366case, another host on network 10 would use eth0 or eth1 before bond0).
1367
1368 The ARP monitor (and ARP itself) may become confused by this
1369configuration, because ARP requests (generated by the ARP monitor)
1370will be sent on one interface (bond0), but the corresponding reply
1371will arrive on a different interface (eth0). This reply looks to ARP
1372as an unsolicited ARP reply (because ARP matches replies on an
1373interface basis), and is discarded. The MII monitor is not affected
1374by the state of the routing table.
1375
1376 The solution here is simply to insure that slaves do not have
1377routes of their own, and if for some reason they must, those routes do
Auke Kok6224e012006-06-08 11:15:35 -07001378not supersede routes of their master. This should generally be the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379case, but unusual configurations or errant manual or automatic static
1380route additions may cause trouble.
1381
Auke Kok6224e012006-06-08 11:15:35 -070013828.2 Ethernet Device Renaming
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383----------------------------
1384
1385 On systems with network configuration scripts that do not
1386associate physical devices directly with network interface names (so
1387that the same physical device always has the same "ethX" name), it may
1388be necessary to add some special logic to either /etc/modules.conf or
1389/etc/modprobe.conf (depending upon which is installed on the system).
1390
1391 For example, given a modules.conf containing the following:
1392
1393alias bond0 bonding
1394options bond0 mode=some-mode miimon=50
1395alias eth0 tg3
1396alias eth1 tg3
1397alias eth2 e1000
1398alias eth3 e1000
1399
1400 If neither eth0 and eth1 are slaves to bond0, then when the
1401bond0 interface comes up, the devices may end up reordered. This
1402happens because bonding is loaded first, then its slave device's
1403drivers are loaded next. Since no other drivers have been loaded,
1404when the e1000 driver loads, it will receive eth0 and eth1 for its
1405devices, but the bonding configuration tries to enslave eth2 and eth3
1406(which may later be assigned to the tg3 devices).
1407
1408 Adding the following:
1409
1410add above bonding e1000 tg3
1411
1412 causes modprobe to load e1000 then tg3, in that order, when
1413bonding is loaded. This command is fully documented in the
1414modules.conf manual page.
1415
1416 On systems utilizing modprobe.conf (or modprobe.conf.local),
1417an equivalent problem can occur. In this case, the following can be
1418added to modprobe.conf (or modprobe.conf.local, as appropriate), as
1419follows (all on one line; it has been split here for clarity):
1420
1421install bonding /sbin/modprobe tg3; /sbin/modprobe e1000;
1422 /sbin/modprobe --ignore-install bonding
1423
1424 This will, when loading the bonding module, rather than
1425performing the normal action, instead execute the provided command.
1426This command loads the device drivers in the order needed, then calls
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001427modprobe with --ignore-install to cause the normal action to then take
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428place. Full documentation on this can be found in the modprobe.conf
1429and modprobe manual pages.
1430
Auke Kok6224e012006-06-08 11:15:35 -070014318.3. Painfully Slow Or No Failed Link Detection By Miimon
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432---------------------------------------------------------
1433
1434 By default, bonding enables the use_carrier option, which
1435instructs bonding to trust the driver to maintain carrier state.
1436
1437 As discussed in the options section, above, some drivers do
1438not support the netif_carrier_on/_off link state tracking system.
1439With use_carrier enabled, bonding will always see these links as up,
1440regardless of their actual state.
1441
1442 Additionally, other drivers do support netif_carrier, but do
1443not maintain it in real time, e.g., only polling the link state at
1444some fixed interval. In this case, miimon will detect failures, but
1445only after some long period of time has expired. If it appears that
1446miimon is very slow in detecting link failures, try specifying
1447use_carrier=0 to see if that improves the failure detection time. If
1448it does, then it may be that the driver checks the carrier state at a
1449fixed interval, but does not cache the MII register values (so the
1450use_carrier=0 method of querying the registers directly works). If
1451use_carrier=0 does not improve the failover, then the driver may cache
1452the registers, or the problem may be elsewhere.
1453
1454 Also, remember that miimon only checks for the device's
1455carrier state. It has no way to determine the state of devices on or
1456beyond other ports of a switch, or if a switch is refusing to pass
1457traffic while still maintaining carrier on.
1458
Auke Kok6224e012006-06-08 11:15:35 -070014599. SNMP agents
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460===============
1461
1462 If running SNMP agents, the bonding driver should be loaded
1463before any network drivers participating in a bond. This requirement
Tobias Klauserd533f672005-09-10 00:26:46 -07001464is due to the interface index (ipAdEntIfIndex) being associated to
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465the first interface found with a given IP address. That is, there is
1466only one ipAdEntIfIndex for each IP address. For example, if eth0 and
1467eth1 are slaves of bond0 and the driver for eth0 is loaded before the
1468bonding driver, the interface for the IP address will be associated
1469with the eth0 interface. This configuration is shown below, the IP
1470address 192.168.1.1 has an interface index of 2 which indexes to eth0
1471in the ifDescr table (ifDescr.2).
1472
1473 interfaces.ifTable.ifEntry.ifDescr.1 = lo
1474 interfaces.ifTable.ifEntry.ifDescr.2 = eth0
1475 interfaces.ifTable.ifEntry.ifDescr.3 = eth1
1476 interfaces.ifTable.ifEntry.ifDescr.4 = eth2
1477 interfaces.ifTable.ifEntry.ifDescr.5 = eth3
1478 interfaces.ifTable.ifEntry.ifDescr.6 = bond0
1479 ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.10.10.10.10 = 5
1480 ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.192.168.1.1 = 2
1481 ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.10.74.20.94 = 4
1482 ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.127.0.0.1 = 1
1483
1484 This problem is avoided by loading the bonding driver before
1485any network drivers participating in a bond. Below is an example of
1486loading the bonding driver first, the IP address 192.168.1.1 is
1487correctly associated with ifDescr.2.
1488
1489 interfaces.ifTable.ifEntry.ifDescr.1 = lo
1490 interfaces.ifTable.ifEntry.ifDescr.2 = bond0
1491 interfaces.ifTable.ifEntry.ifDescr.3 = eth0
1492 interfaces.ifTable.ifEntry.ifDescr.4 = eth1
1493 interfaces.ifTable.ifEntry.ifDescr.5 = eth2
1494 interfaces.ifTable.ifEntry.ifDescr.6 = eth3
1495 ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.10.10.10.10 = 6
1496 ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.192.168.1.1 = 2
1497 ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.10.74.20.94 = 5
1498 ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.127.0.0.1 = 1
1499
1500 While some distributions may not report the interface name in
1501ifDescr, the association between the IP address and IfIndex remains
1502and SNMP functions such as Interface_Scan_Next will report that
1503association.
1504
Auke Kok6224e012006-06-08 11:15:35 -0700150510. Promiscuous mode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506====================
1507
1508 When running network monitoring tools, e.g., tcpdump, it is
1509common to enable promiscuous mode on the device, so that all traffic
1510is seen (instead of seeing only traffic destined for the local host).
1511The bonding driver handles promiscuous mode changes to the bonding
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001512master device (e.g., bond0), and propagates the setting to the slave
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513devices.
1514
1515 For the balance-rr, balance-xor, broadcast, and 802.3ad modes,
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001516the promiscuous mode setting is propagated to all slaves.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517
1518 For the active-backup, balance-tlb and balance-alb modes, the
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001519promiscuous mode setting is propagated only to the active slave.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
1521 For balance-tlb mode, the active slave is the slave currently
1522receiving inbound traffic.
1523
1524 For balance-alb mode, the active slave is the slave used as a
1525"primary." This slave is used for mode-specific control traffic, for
1526sending to peers that are unassigned or if the load is unbalanced.
1527
1528 For the active-backup, balance-tlb and balance-alb modes, when
1529the active slave changes (e.g., due to a link failure), the
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001530promiscuous setting will be propagated to the new active slave.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531
Auke Kok6224e012006-06-08 11:15:35 -0700153211. Configuring Bonding for High Availability
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001533=============================================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534
1535 High Availability refers to configurations that provide
1536maximum network availability by having redundant or backup devices,
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001537links or switches between the host and the rest of the world. The
1538goal is to provide the maximum availability of network connectivity
1539(i.e., the network always works), even though other configurations
1540could provide higher throughput.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
Auke Kok6224e012006-06-08 11:15:35 -0700154211.1 High Availability in a Single Switch Topology
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543--------------------------------------------------
1544
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001545 If two hosts (or a host and a single switch) are directly
1546connected via multiple physical links, then there is no availability
1547penalty to optimizing for maximum bandwidth. In this case, there is
1548only one switch (or peer), so if it fails, there is no alternative
1549access to fail over to. Additionally, the bonding load balance modes
1550support link monitoring of their members, so if individual links fail,
1551the load will be rebalanced across the remaining devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001553 See Section 13, "Configuring Bonding for Maximum Throughput"
1554for information on configuring bonding with one peer device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555
Auke Kok6224e012006-06-08 11:15:35 -0700155611.2 High Availability in a Multiple Switch Topology
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557----------------------------------------------------
1558
1559 With multiple switches, the configuration of bonding and the
1560network changes dramatically. In multiple switch topologies, there is
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001561a trade off between network availability and usable bandwidth.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562
1563 Below is a sample network, configured to maximize the
1564availability of the network:
1565
1566 | |
1567 |port3 port3|
1568 +-----+----+ +-----+----+
1569 | |port2 ISL port2| |
1570 | switch A +--------------------------+ switch B |
1571 | | | |
1572 +-----+----+ +-----++---+
1573 |port1 port1|
1574 | +-------+ |
1575 +-------------+ host1 +---------------+
1576 eth0 +-------+ eth1
1577
1578 In this configuration, there is a link between the two
1579switches (ISL, or inter switch link), and multiple ports connecting to
1580the outside world ("port3" on each switch). There is no technical
1581reason that this could not be extended to a third switch.
1582
Auke Kok6224e012006-06-08 11:15:35 -0700158311.2.1 HA Bonding Mode Selection for Multiple Switch Topology
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001584-------------------------------------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001586 In a topology such as the example above, the active-backup and
1587broadcast modes are the only useful bonding modes when optimizing for
1588availability; the other modes require all links to terminate on the
1589same peer for them to behave rationally.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590
1591active-backup: This is generally the preferred mode, particularly if
1592 the switches have an ISL and play together well. If the
1593 network configuration is such that one switch is specifically
1594 a backup switch (e.g., has lower capacity, higher cost, etc),
1595 then the primary option can be used to insure that the
1596 preferred link is always used when it is available.
1597
1598broadcast: This mode is really a special purpose mode, and is suitable
1599 only for very specific needs. For example, if the two
1600 switches are not connected (no ISL), and the networks beyond
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001601 them are totally independent. In this case, if it is
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 necessary for some specific one-way traffic to reach both
1603 independent networks, then the broadcast mode may be suitable.
1604
Auke Kok6224e012006-06-08 11:15:35 -0700160511.2.2 HA Link Monitoring Selection for Multiple Switch Topology
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001606----------------------------------------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607
1608 The choice of link monitoring ultimately depends upon your
1609switch. If the switch can reliably fail ports in response to other
1610failures, then either the MII or ARP monitors should work. For
1611example, in the above example, if the "port3" link fails at the remote
1612end, the MII monitor has no direct means to detect this. The ARP
1613monitor could be configured with a target at the remote end of port3,
1614thus detecting that failure without switch support.
1615
1616 In general, however, in a multiple switch topology, the ARP
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001617monitor can provide a higher level of reliability in detecting end to
1618end connectivity failures (which may be caused by the failure of any
1619individual component to pass traffic for any reason). Additionally,
1620the ARP monitor should be configured with multiple targets (at least
1621one for each switch in the network). This will insure that,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622regardless of which switch is active, the ARP monitor has a suitable
1623target to query.
1624
1625
Auke Kok6224e012006-06-08 11:15:35 -0700162612. Configuring Bonding for Maximum Throughput
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001627==============================================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628
Auke Kok6224e012006-06-08 11:15:35 -0700162912.1 Maximizing Throughput in a Single Switch Topology
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001630------------------------------------------------------
1631
1632 In a single switch configuration, the best method to maximize
1633throughput depends upon the application and network environment. The
1634various load balancing modes each have strengths and weaknesses in
1635different environments, as detailed below.
1636
1637 For this discussion, we will break down the topologies into
1638two categories. Depending upon the destination of most traffic, we
1639categorize them into either "gatewayed" or "local" configurations.
1640
1641 In a gatewayed configuration, the "switch" is acting primarily
1642as a router, and the majority of traffic passes through this router to
1643other networks. An example would be the following:
1644
1645
1646 +----------+ +----------+
1647 | |eth0 port1| | to other networks
1648 | Host A +---------------------+ router +------------------->
1649 | +---------------------+ | Hosts B and C are out
1650 | |eth1 port2| | here somewhere
1651 +----------+ +----------+
1652
1653 The router may be a dedicated router device, or another host
1654acting as a gateway. For our discussion, the important point is that
1655the majority of traffic from Host A will pass through the router to
1656some other network before reaching its final destination.
1657
1658 In a gatewayed network configuration, although Host A may
1659communicate with many other systems, all of its traffic will be sent
1660and received via one other peer on the local network, the router.
1661
1662 Note that the case of two systems connected directly via
1663multiple physical links is, for purposes of configuring bonding, the
1664same as a gatewayed configuration. In that case, it happens that all
1665traffic is destined for the "gateway" itself, not some other network
1666beyond the gateway.
1667
1668 In a local configuration, the "switch" is acting primarily as
1669a switch, and the majority of traffic passes through this switch to
1670reach other stations on the same network. An example would be the
1671following:
1672
1673 +----------+ +----------+ +--------+
1674 | |eth0 port1| +-------+ Host B |
1675 | Host A +------------+ switch |port3 +--------+
1676 | +------------+ | +--------+
1677 | |eth1 port2| +------------------+ Host C |
1678 +----------+ +----------+port4 +--------+
1679
1680
1681 Again, the switch may be a dedicated switch device, or another
1682host acting as a gateway. For our discussion, the important point is
1683that the majority of traffic from Host A is destined for other hosts
1684on the same local network (Hosts B and C in the above example).
1685
1686 In summary, in a gatewayed configuration, traffic to and from
1687the bonded device will be to the same MAC level peer on the network
1688(the gateway itself, i.e., the router), regardless of its final
1689destination. In a local configuration, traffic flows directly to and
1690from the final destinations, thus, each destination (Host B, Host C)
1691will be addressed directly by their individual MAC addresses.
1692
1693 This distinction between a gatewayed and a local network
1694configuration is important because many of the load balancing modes
1695available use the MAC addresses of the local network source and
1696destination to make load balancing decisions. The behavior of each
1697mode is described below.
1698
1699
Auke Kok6224e012006-06-08 11:15:35 -0700170012.1.1 MT Bonding Mode Selection for Single Switch Topology
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001701-----------------------------------------------------------
1702
1703 This configuration is the easiest to set up and to understand,
1704although you will have to decide which bonding mode best suits your
1705needs. The trade offs for each mode are detailed below:
1706
1707balance-rr: This mode is the only mode that will permit a single
1708 TCP/IP connection to stripe traffic across multiple
1709 interfaces. It is therefore the only mode that will allow a
1710 single TCP/IP stream to utilize more than one interface's
1711 worth of throughput. This comes at a cost, however: the
1712 striping often results in peer systems receiving packets out
1713 of order, causing TCP/IP's congestion control system to kick
1714 in, often by retransmitting segments.
1715
1716 It is possible to adjust TCP/IP's congestion limits by
1717 altering the net.ipv4.tcp_reordering sysctl parameter. The
1718 usual default value is 3, and the maximum useful value is 127.
1719 For a four interface balance-rr bond, expect that a single
1720 TCP/IP stream will utilize no more than approximately 2.3
1721 interface's worth of throughput, even after adjusting
1722 tcp_reordering.
1723
1724 Note that this out of order delivery occurs when both the
1725 sending and receiving systems are utilizing a multiple
1726 interface bond. Consider a configuration in which a
1727 balance-rr bond feeds into a single higher capacity network
1728 channel (e.g., multiple 100Mb/sec ethernets feeding a single
1729 gigabit ethernet via an etherchannel capable switch). In this
1730 configuration, traffic sent from the multiple 100Mb devices to
1731 a destination connected to the gigabit device will not see
1732 packets out of order. However, traffic sent from the gigabit
1733 device to the multiple 100Mb devices may or may not see
1734 traffic out of order, depending upon the balance policy of the
1735 switch. Many switches do not support any modes that stripe
1736 traffic (instead choosing a port based upon IP or MAC level
1737 addresses); for those devices, traffic flowing from the
1738 gigabit device to the many 100Mb devices will only utilize one
1739 interface.
1740
1741 If you are utilizing protocols other than TCP/IP, UDP for
1742 example, and your application can tolerate out of order
1743 delivery, then this mode can allow for single stream datagram
1744 performance that scales near linearly as interfaces are added
1745 to the bond.
1746
1747 This mode requires the switch to have the appropriate ports
1748 configured for "etherchannel" or "trunking."
1749
1750active-backup: There is not much advantage in this network topology to
1751 the active-backup mode, as the inactive backup devices are all
1752 connected to the same peer as the primary. In this case, a
1753 load balancing mode (with link monitoring) will provide the
1754 same level of network availability, but with increased
1755 available bandwidth. On the plus side, active-backup mode
1756 does not require any configuration of the switch, so it may
1757 have value if the hardware available does not support any of
1758 the load balance modes.
1759
1760balance-xor: This mode will limit traffic such that packets destined
1761 for specific peers will always be sent over the same
1762 interface. Since the destination is determined by the MAC
1763 addresses involved, this mode works best in a "local" network
1764 configuration (as described above), with destinations all on
1765 the same local network. This mode is likely to be suboptimal
1766 if all your traffic is passed through a single router (i.e., a
1767 "gatewayed" network configuration, as described above).
1768
1769 As with balance-rr, the switch ports need to be configured for
1770 "etherchannel" or "trunking."
1771
1772broadcast: Like active-backup, there is not much advantage to this
1773 mode in this type of network topology.
1774
1775802.3ad: This mode can be a good choice for this type of network
1776 topology. The 802.3ad mode is an IEEE standard, so all peers
1777 that implement 802.3ad should interoperate well. The 802.3ad
1778 protocol includes automatic configuration of the aggregates,
1779 so minimal manual configuration of the switch is needed
1780 (typically only to designate that some set of devices is
1781 available for 802.3ad). The 802.3ad standard also mandates
1782 that frames be delivered in order (within certain limits), so
1783 in general single connections will not see misordering of
1784 packets. The 802.3ad mode does have some drawbacks: the
1785 standard mandates that all devices in the aggregate operate at
1786 the same speed and duplex. Also, as with all bonding load
1787 balance modes other than balance-rr, no single connection will
1788 be able to utilize more than a single interface's worth of
1789 bandwidth.
1790
1791 Additionally, the linux bonding 802.3ad implementation
1792 distributes traffic by peer (using an XOR of MAC addresses),
1793 so in a "gatewayed" configuration, all outgoing traffic will
1794 generally use the same device. Incoming traffic may also end
1795 up on a single device, but that is dependent upon the
1796 balancing policy of the peer's 8023.ad implementation. In a
1797 "local" configuration, traffic will be distributed across the
1798 devices in the bond.
1799
1800 Finally, the 802.3ad mode mandates the use of the MII monitor,
1801 therefore, the ARP monitor is not available in this mode.
1802
1803balance-tlb: The balance-tlb mode balances outgoing traffic by peer.
1804 Since the balancing is done according to MAC address, in a
1805 "gatewayed" configuration (as described above), this mode will
1806 send all traffic across a single device. However, in a
1807 "local" network configuration, this mode balances multiple
1808 local network peers across devices in a vaguely intelligent
1809 manner (not a simple XOR as in balance-xor or 802.3ad mode),
1810 so that mathematically unlucky MAC addresses (i.e., ones that
1811 XOR to the same value) will not all "bunch up" on a single
1812 interface.
1813
1814 Unlike 802.3ad, interfaces may be of differing speeds, and no
1815 special switch configuration is required. On the down side,
1816 in this mode all incoming traffic arrives over a single
1817 interface, this mode requires certain ethtool support in the
1818 network device driver of the slave interfaces, and the ARP
1819 monitor is not available.
1820
1821balance-alb: This mode is everything that balance-tlb is, and more.
1822 It has all of the features (and restrictions) of balance-tlb,
1823 and will also balance incoming traffic from local network
1824 peers (as described in the Bonding Module Options section,
1825 above).
1826
1827 The only additional down side to this mode is that the network
1828 device driver must support changing the hardware address while
1829 the device is open.
1830
Auke Kok6224e012006-06-08 11:15:35 -0700183112.1.2 MT Link Monitoring for Single Switch Topology
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001832----------------------------------------------------
1833
1834 The choice of link monitoring may largely depend upon which
1835mode you choose to use. The more advanced load balancing modes do not
1836support the use of the ARP monitor, and are thus restricted to using
1837the MII monitor (which does not provide as high a level of end to end
1838assurance as the ARP monitor).
1839
Auke Kok6224e012006-06-08 11:15:35 -0700184012.2 Maximum Throughput in a Multiple Switch Topology
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001841-----------------------------------------------------
1842
1843 Multiple switches may be utilized to optimize for throughput
1844when they are configured in parallel as part of an isolated network
1845between two or more systems, for example:
1846
1847 +-----------+
1848 | Host A |
1849 +-+---+---+-+
1850 | | |
1851 +--------+ | +---------+
1852 | | |
1853 +------+---+ +-----+----+ +-----+----+
1854 | Switch A | | Switch B | | Switch C |
1855 +------+---+ +-----+----+ +-----+----+
1856 | | |
1857 +--------+ | +---------+
1858 | | |
1859 +-+---+---+-+
1860 | Host B |
1861 +-----------+
1862
1863 In this configuration, the switches are isolated from one
1864another. One reason to employ a topology such as this is for an
1865isolated network with many hosts (a cluster configured for high
1866performance, for example), using multiple smaller switches can be more
1867cost effective than a single larger switch, e.g., on a network with 24
1868hosts, three 24 port switches can be significantly less expensive than
1869a single 72 port switch.
1870
1871 If access beyond the network is required, an individual host
1872can be equipped with an additional network device connected to an
1873external network; this host then additionally acts as a gateway.
1874
Auke Kok6224e012006-06-08 11:15:35 -0700187512.2.1 MT Bonding Mode Selection for Multiple Switch Topology
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001876-------------------------------------------------------------
1877
1878 In actual practice, the bonding mode typically employed in
1879configurations of this type is balance-rr. Historically, in this
1880network configuration, the usual caveats about out of order packet
1881delivery are mitigated by the use of network adapters that do not do
1882any kind of packet coalescing (via the use of NAPI, or because the
1883device itself does not generate interrupts until some number of
1884packets has arrived). When employed in this fashion, the balance-rr
1885mode allows individual connections between two hosts to effectively
1886utilize greater than one interface's bandwidth.
1887
Auke Kok6224e012006-06-08 11:15:35 -0700188812.2.2 MT Link Monitoring for Multiple Switch Topology
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001889------------------------------------------------------
1890
1891 Again, in actual practice, the MII monitor is most often used
1892in this configuration, as performance is given preference over
1893availability. The ARP monitor will function in this topology, but its
1894advantages over the MII monitor are mitigated by the volume of probes
1895needed as the number of systems involved grows (remember that each
1896host in the network is configured with bonding).
1897
Auke Kok6224e012006-06-08 11:15:35 -0700189813. Switch Behavior Issues
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001899==========================
1900
Auke Kok6224e012006-06-08 11:15:35 -0700190113.1 Link Establishment and Failover Delays
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001902-------------------------------------------
1903
1904 Some switches exhibit undesirable behavior with regard to the
1905timing of link up and down reporting by the switch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906
1907 First, when a link comes up, some switches may indicate that
1908the link is up (carrier available), but not pass traffic over the
1909interface for some period of time. This delay is typically due to
1910some type of autonegotiation or routing protocol, but may also occur
1911during switch initialization (e.g., during recovery after a switch
1912failure). If you find this to be a problem, specify an appropriate
1913value to the updelay bonding module option to delay the use of the
1914relevant interface(s).
1915
1916 Second, some switches may "bounce" the link state one or more
1917times while a link is changing state. This occurs most commonly while
1918the switch is initializing. Again, an appropriate updelay value may
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001919help.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920
1921 Note that when a bonding interface has no active links, the
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001922driver will immediately reuse the first link that goes up, even if the
1923updelay parameter has been specified (the updelay is ignored in this
1924case). If there are slave interfaces waiting for the updelay timeout
1925to expire, the interface that first went into that state will be
1926immediately reused. This reduces down time of the network if the
1927value of updelay has been overestimated, and since this occurs only in
1928cases with no connectivity, there is no additional penalty for
1929ignoring the updelay.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930
1931 In addition to the concerns about switch timings, if your
1932switches take a long time to go into backup mode, it may be desirable
1933to not activate a backup interface immediately after a link goes down.
1934Failover may be delayed via the downdelay bonding module option.
1935
Auke Kok6224e012006-06-08 11:15:35 -0700193613.2 Duplicated Incoming Packets
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001937--------------------------------
1938
1939 It is not uncommon to observe a short burst of duplicated
1940traffic when the bonding device is first used, or after it has been
1941idle for some period of time. This is most easily observed by issuing
1942a "ping" to some other host on the network, and noticing that the
1943output from ping flags duplicates (typically one per slave).
1944
1945 For example, on a bond in active-backup mode with five slaves
1946all connected to one switch, the output may appear as follows:
1947
1948# ping -n 10.0.4.2
1949PING 10.0.4.2 (10.0.4.2) from 10.0.3.10 : 56(84) bytes of data.
195064 bytes from 10.0.4.2: icmp_seq=1 ttl=64 time=13.7 ms
195164 bytes from 10.0.4.2: icmp_seq=1 ttl=64 time=13.8 ms (DUP!)
195264 bytes from 10.0.4.2: icmp_seq=1 ttl=64 time=13.8 ms (DUP!)
195364 bytes from 10.0.4.2: icmp_seq=1 ttl=64 time=13.8 ms (DUP!)
195464 bytes from 10.0.4.2: icmp_seq=1 ttl=64 time=13.8 ms (DUP!)
195564 bytes from 10.0.4.2: icmp_seq=2 ttl=64 time=0.216 ms
195664 bytes from 10.0.4.2: icmp_seq=3 ttl=64 time=0.267 ms
195764 bytes from 10.0.4.2: icmp_seq=4 ttl=64 time=0.222 ms
1958
1959 This is not due to an error in the bonding driver, rather, it
1960is a side effect of how many switches update their MAC forwarding
1961tables. Initially, the switch does not associate the MAC address in
1962the packet with a particular switch port, and so it may send the
1963traffic to all ports until its MAC forwarding table is updated. Since
1964the interfaces attached to the bond may occupy multiple ports on a
1965single switch, when the switch (temporarily) floods the traffic to all
1966ports, the bond device receives multiple copies of the same packet
1967(one per slave device).
1968
1969 The duplicated packet behavior is switch dependent, some
1970switches exhibit this, and some do not. On switches that display this
1971behavior, it can be induced by clearing the MAC forwarding table (on
1972most Cisco switches, the privileged command "clear mac address-table
1973dynamic" will accomplish this).
1974
Auke Kok6224e012006-06-08 11:15:35 -0700197514. Hardware Specific Considerations
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976====================================
1977
1978 This section contains additional information for configuring
1979bonding on specific hardware platforms, or for interfacing bonding
1980with particular switches or other devices.
1981
Auke Kok6224e012006-06-08 11:15:35 -0700198214.1 IBM BladeCenter
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983--------------------
1984
1985 This applies to the JS20 and similar systems.
1986
1987 On the JS20 blades, the bonding driver supports only
1988balance-rr, active-backup, balance-tlb and balance-alb modes. This is
1989largely due to the network topology inside the BladeCenter, detailed
1990below.
1991
1992JS20 network adapter information
1993--------------------------------
1994
1995 All JS20s come with two Broadcom Gigabit Ethernet ports
Jay Vosburgh00354cf2005-07-21 12:18:02 -07001996integrated on the planar (that's "motherboard" in IBM-speak). In the
1997BladeCenter chassis, the eth0 port of all JS20 blades is hard wired to
1998I/O Module #1; similarly, all eth1 ports are wired to I/O Module #2.
1999An add-on Broadcom daughter card can be installed on a JS20 to provide
2000two more Gigabit Ethernet ports. These ports, eth2 and eth3, are
2001wired to I/O Modules 3 and 4, respectively.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002
2003 Each I/O Module may contain either a switch or a passthrough
2004module (which allows ports to be directly connected to an external
2005switch). Some bonding modes require a specific BladeCenter internal
2006network topology in order to function; these are detailed below.
2007
2008 Additional BladeCenter-specific networking information can be
2009found in two IBM Redbooks (www.ibm.com/redbooks):
2010
2011"IBM eServer BladeCenter Networking Options"
2012"IBM eServer BladeCenter Layer 2-7 Network Switching"
2013
2014BladeCenter networking configuration
2015------------------------------------
2016
2017 Because a BladeCenter can be configured in a very large number
2018of ways, this discussion will be confined to describing basic
2019configurations.
2020
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002021 Normally, Ethernet Switch Modules (ESMs) are used in I/O
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022modules 1 and 2. In this configuration, the eth0 and eth1 ports of a
2023JS20 will be connected to different internal switches (in the
2024respective I/O modules).
2025
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002026 A passthrough module (OPM or CPM, optical or copper,
2027passthrough module) connects the I/O module directly to an external
2028switch. By using PMs in I/O module #1 and #2, the eth0 and eth1
2029interfaces of a JS20 can be redirected to the outside world and
2030connected to a common external switch.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002032 Depending upon the mix of ESMs and PMs, the network will
2033appear to bonding as either a single switch topology (all PMs) or as a
2034multiple switch topology (one or more ESMs, zero or more PMs). It is
2035also possible to connect ESMs together, resulting in a configuration
2036much like the example in "High Availability in a Multiple Switch
2037Topology," above.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002039Requirements for specific modes
2040-------------------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002042 The balance-rr mode requires the use of passthrough modules
2043for devices in the bond, all connected to an common external switch.
2044That switch must be configured for "etherchannel" or "trunking" on the
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045appropriate ports, as is usual for balance-rr.
2046
2047 The balance-alb and balance-tlb modes will function with
2048either switch modules or passthrough modules (or a mix). The only
2049specific requirement for these modes is that all network interfaces
2050must be able to reach all destinations for traffic sent over the
2051bonding device (i.e., the network must converge at some point outside
2052the BladeCenter).
2053
2054 The active-backup mode has no additional requirements.
2055
2056Link monitoring issues
2057----------------------
2058
2059 When an Ethernet Switch Module is in place, only the ARP
2060monitor will reliably detect link loss to an external switch. This is
2061nothing unusual, but examination of the BladeCenter cabinet would
2062suggest that the "external" network ports are the ethernet ports for
2063the system, when it fact there is a switch between these "external"
2064ports and the devices on the JS20 system itself. The MII monitor is
2065only able to detect link failures between the ESM and the JS20 system.
2066
2067 When a passthrough module is in place, the MII monitor does
2068detect failures to the "external" port, which is then directly
2069connected to the JS20 system.
2070
2071Other concerns
2072--------------
2073
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002074 The Serial Over LAN (SoL) link is established over the primary
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075ethernet (eth0) only, therefore, any loss of link to eth0 will result
2076in losing your SoL connection. It will not fail over with other
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002077network traffic, as the SoL system is beyond the control of the
2078bonding driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079
2080 It may be desirable to disable spanning tree on the switch
2081(either the internal Ethernet Switch Module, or an external switch) to
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002082avoid fail-over delay issues when using bonding.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083
2084
Auke Kok6224e012006-06-08 11:15:35 -0700208515. Frequently Asked Questions
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086==============================
2087
20881. Is it SMP safe?
2089
2090 Yes. The old 2.0.xx channel bonding patch was not SMP safe.
2091The new driver was designed to be SMP safe from the start.
2092
20932. What type of cards will work with it?
2094
2095 Any Ethernet type cards (you can even mix cards - a Intel
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002096EtherExpress PRO/100 and a 3com 3c905b, for example). For most modes,
2097devices need not be of the same speed.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098
20993. How many bonding devices can I have?
2100
2101 There is no limit.
2102
21034. How many slaves can a bonding device have?
2104
2105 This is limited only by the number of network interfaces Linux
2106supports and/or the number of network cards you can place in your
2107system.
2108
21095. What happens when a slave link dies?
2110
2111 If link monitoring is enabled, then the failing device will be
2112disabled. The active-backup mode will fail over to a backup link, and
2113other modes will ignore the failed link. The link will continue to be
2114monitored, and should it recover, it will rejoin the bond (in whatever
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002115manner is appropriate for the mode). See the sections on High
2116Availability and the documentation for each mode for additional
2117information.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118
2119 Link monitoring can be enabled via either the miimon or
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002120arp_interval parameters (described in the module parameters section,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121above). In general, miimon monitors the carrier state as sensed by
2122the underlying network device, and the arp monitor (arp_interval)
2123monitors connectivity to another host on the local network.
2124
2125 If no link monitoring is configured, the bonding driver will
2126be unable to detect link failures, and will assume that all links are
2127always available. This will likely result in lost packets, and a
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002128resulting degradation of performance. The precise performance loss
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129depends upon the bonding mode and network configuration.
2130
21316. Can bonding be used for High Availability?
2132
2133 Yes. See the section on High Availability for details.
2134
21357. Which switches/systems does it work with?
2136
2137 The full answer to this depends upon the desired mode.
2138
2139 In the basic balance modes (balance-rr and balance-xor), it
2140works with any system that supports etherchannel (also called
2141trunking). Most managed switches currently available have such
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002142support, and many unmanaged switches as well.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143
2144 The advanced balance modes (balance-tlb and balance-alb) do
2145not have special switch requirements, but do need device drivers that
2146support specific features (described in the appropriate section under
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002147module parameters, above).
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148
Auke Kok6224e012006-06-08 11:15:35 -07002149 In 802.3ad mode, it works with systems that support IEEE
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150802.3ad Dynamic Link Aggregation. Most managed and many unmanaged
2151switches currently available support 802.3ad.
2152
2153 The active-backup mode should work with any Layer-II switch.
2154
21558. Where does a bonding device get its MAC address from?
2156
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002157 If not explicitly configured (with ifconfig or ip link), the
2158MAC address of the bonding device is taken from its first slave
2159device. This MAC address is then passed to all following slaves and
Tobias Klauserd533f672005-09-10 00:26:46 -07002160remains persistent (even if the first slave is removed) until the
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002161bonding device is brought down or reconfigured.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162
2163 If you wish to change the MAC address, you can set it with
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002164ifconfig or ip link:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165
2166# ifconfig bond0 hw ether 00:11:22:33:44:55
2167
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002168# ip link set bond0 address 66:77:88:99:aa:bb
2169
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 The MAC address can be also changed by bringing down/up the
2171device and then changing its slaves (or their order):
2172
2173# ifconfig bond0 down ; modprobe -r bonding
2174# ifconfig bond0 .... up
2175# ifenslave bond0 eth...
2176
2177 This method will automatically take the address from the next
2178slave that is added.
2179
2180 To restore your slaves' MAC addresses, you need to detach them
2181from the bond (`ifenslave -d bond0 eth0'). The bonding driver will
2182then restore the MAC addresses that the slaves had before they were
2183enslaved.
2184
Jay Vosburgh00354cf2005-07-21 12:18:02 -0700218516. Resources and Links
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186=======================
2187
2188The latest version of the bonding driver can be found in the latest
2189version of the linux kernel, found on http://kernel.org
2190
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002191The latest version of this document can be found in either the latest
2192kernel source (named Documentation/networking/bonding.txt), or on the
2193bonding sourceforge site:
2194
2195http://www.sourceforge.net/projects/bonding
2196
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197Discussions regarding the bonding driver take place primarily on the
2198bonding-devel mailing list, hosted at sourceforge.net. If you have
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002199questions or problems, post them to the list. The list address is:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200
2201bonding-devel@lists.sourceforge.net
2202
Jay Vosburgh00354cf2005-07-21 12:18:02 -07002203 The administrative interface (to subscribe or unsubscribe) can
2204be found at:
2205
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206https://lists.sourceforge.net/lists/listinfo/bonding-devel
2207
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208Donald Becker's Ethernet Drivers and diag programs may be found at :
2209 - http://www.scyld.com/network/
2210
2211You will also find a lot of information regarding Ethernet, NWay, MII,
2212etc. at www.scyld.com.
2213
2214-- END --