bonding: fix ad_actor_system option setting to default
[platform/kernel/linux-rpi.git] / Documentation / networking / bonding.rst
1 .. SPDX-License-Identifier: GPL-2.0
2
3 ===================================
4 Linux Ethernet Bonding Driver HOWTO
5 ===================================
6
7 Latest update: 27 April 2011
8
9 Initial release: Thomas Davis <tadavis at lbl.gov>
10
11 Corrections, HA extensions: 2000/10/03-15:
12
13   - Willy Tarreau <willy at meta-x.org>
14   - Constantine Gavrilov <const-g at xpert.com>
15   - Chad N. Tindel <ctindel at ieee dot org>
16   - Janice Girouard <girouard at us dot ibm dot com>
17   - Jay Vosburgh <fubar at us dot ibm dot com>
18
19 Reorganized and updated Feb 2005 by Jay Vosburgh
20 Added Sysfs information: 2006/04/24
21
22   - Mitch Williams <mitch.a.williams at intel.com>
23
24 Introduction
25 ============
26
27 The Linux bonding driver provides a method for aggregating
28 multiple network interfaces into a single logical "bonded" interface.
29 The behavior of the bonded interfaces depends upon the mode; generally
30 speaking, modes provide either hot standby or load balancing services.
31 Additionally, link integrity monitoring may be performed.
32
33 The bonding driver originally came from Donald Becker's
34 beowulf patches for kernel 2.0. It has changed quite a bit since, and
35 the original tools from extreme-linux and beowulf sites will not work
36 with this version of the driver.
37
38 For new versions of the driver, updated userspace tools, and
39 who to ask for help, please follow the links at the end of this file.
40
41 .. Table of Contents
42
43    1. Bonding Driver Installation
44
45    2. Bonding Driver Options
46
47    3. Configuring Bonding Devices
48    3.1  Configuration with Sysconfig Support
49    3.1.1                Using DHCP with Sysconfig
50    3.1.2                Configuring Multiple Bonds with Sysconfig
51    3.2  Configuration with Initscripts Support
52    3.2.1                Using DHCP with Initscripts
53    3.2.2                Configuring Multiple Bonds with Initscripts
54    3.3  Configuring Bonding Manually with Ifenslave
55    3.3.1                Configuring Multiple Bonds Manually
56    3.4  Configuring Bonding Manually via Sysfs
57    3.5  Configuration with Interfaces Support
58    3.6  Overriding Configuration for Special Cases
59    3.7 Configuring LACP for 802.3ad mode in a more secure way
60
61    4. Querying Bonding Configuration
62    4.1  Bonding Configuration
63    4.2  Network Configuration
64
65    5. Switch Configuration
66
67    6. 802.1q VLAN Support
68
69    7. Link Monitoring
70    7.1  ARP Monitor Operation
71    7.2  Configuring Multiple ARP Targets
72    7.3  MII Monitor Operation
73
74    8. Potential Trouble Sources
75    8.1  Adventures in Routing
76    8.2  Ethernet Device Renaming
77    8.3  Painfully Slow Or No Failed Link Detection By Miimon
78
79    9. SNMP agents
80
81    10. Promiscuous mode
82
83    11. Configuring Bonding for High Availability
84    11.1 High Availability in a Single Switch Topology
85    11.2 High Availability in a Multiple Switch Topology
86    11.2.1               HA Bonding Mode Selection for Multiple Switch Topology
87    11.2.2               HA Link Monitoring for Multiple Switch Topology
88
89    12. Configuring Bonding for Maximum Throughput
90    12.1 Maximum Throughput in a Single Switch Topology
91    12.1.1               MT Bonding Mode Selection for Single Switch Topology
92    12.1.2               MT Link Monitoring for Single Switch Topology
93    12.2 Maximum Throughput in a Multiple Switch Topology
94    12.2.1               MT Bonding Mode Selection for Multiple Switch Topology
95    12.2.2               MT Link Monitoring for Multiple Switch Topology
96
97    13. Switch Behavior Issues
98    13.1 Link Establishment and Failover Delays
99    13.2 Duplicated Incoming Packets
100
101    14. Hardware Specific Considerations
102    14.1 IBM BladeCenter
103
104    15. Frequently Asked Questions
105
106    16. Resources and Links
107
108
109 1. Bonding Driver Installation
110 ==============================
111
112 Most popular distro kernels ship with the bonding driver
113 already available as a module. If your distro does not, or you
114 have need to compile bonding from source (e.g., configuring and
115 installing a mainline kernel from kernel.org), you'll need to perform
116 the following steps:
117
118 1.1 Configure and build the kernel with bonding
119 -----------------------------------------------
120
121 The current version of the bonding driver is available in the
122 drivers/net/bonding subdirectory of the most recent kernel source
123 (which is available on http://kernel.org).  Most users "rolling their
124 own" will want to use the most recent kernel from kernel.org.
125
126 Configure kernel with "make menuconfig" (or "make xconfig" or
127 "make config"), then select "Bonding driver support" in the "Network
128 device support" section.  It is recommended that you configure the
129 driver as module since it is currently the only way to pass parameters
130 to the driver or configure more than one bonding device.
131
132 Build and install the new kernel and modules.
133
134 1.2 Bonding Control Utility
135 ---------------------------
136
137 It is recommended to configure bonding via iproute2 (netlink)
138 or sysfs, the old ifenslave control utility is obsolete.
139
140 2. Bonding Driver Options
141 =========================
142
143 Options for the bonding driver are supplied as parameters to the
144 bonding module at load time, or are specified via sysfs.
145
146 Module options may be given as command line arguments to the
147 insmod or modprobe command, but are usually specified in either the
148 ``/etc/modprobe.d/*.conf`` configuration files, or in a distro-specific
149 configuration file (some of which are detailed in the next section).
150
151 Details on bonding support for sysfs is provided in the
152 "Configuring Bonding Manually via Sysfs" section, below.
153
154 The available bonding driver parameters are listed below. If a
155 parameter is not specified the default value is used.  When initially
156 configuring a bond, it is recommended "tail -f /var/log/messages" be
157 run in a separate window to watch for bonding driver error messages.
158
159 It is critical that either the miimon or arp_interval and
160 arp_ip_target parameters be specified, otherwise serious network
161 degradation will occur during link failures.  Very few devices do not
162 support at least miimon, so there is really no reason not to use it.
163
164 Options with textual values will accept either the text name
165 or, for backwards compatibility, the option value.  E.g.,
166 "mode=802.3ad" and "mode=4" set the same mode.
167
168 The parameters are as follows:
169
170 active_slave
171
172         Specifies the new active slave for modes that support it
173         (active-backup, balance-alb and balance-tlb).  Possible values
174         are the name of any currently enslaved interface, or an empty
175         string.  If a name is given, the slave and its link must be up in order
176         to be selected as the new active slave.  If an empty string is
177         specified, the current active slave is cleared, and a new active
178         slave is selected automatically.
179
180         Note that this is only available through the sysfs interface. No module
181         parameter by this name exists.
182
183         The normal value of this option is the name of the currently
184         active slave, or the empty string if there is no active slave or
185         the current mode does not use an active slave.
186
187 ad_actor_sys_prio
188
189         In an AD system, this specifies the system priority. The allowed range
190         is 1 - 65535. If the value is not specified, it takes 65535 as the
191         default value.
192
193         This parameter has effect only in 802.3ad mode and is available through
194         SysFs interface.
195
196 ad_actor_system
197
198         In an AD system, this specifies the mac-address for the actor in
199         protocol packet exchanges (LACPDUs). The value cannot be a multicast
200         address. If the all-zeroes MAC is specified, bonding will internally
201         use the MAC of the bond itself. It is preferred to have the
202         local-admin bit set for this mac but driver does not enforce it. If
203         the value is not given then system defaults to using the masters'
204         mac address as actors' system address.
205
206         This parameter has effect only in 802.3ad mode and is available through
207         SysFs interface.
208
209 ad_select
210
211         Specifies the 802.3ad aggregation selection logic to use.  The
212         possible values and their effects are:
213
214         stable or 0
215
216                 The active aggregator is chosen by largest aggregate
217                 bandwidth.
218
219                 Reselection of the active aggregator occurs only when all
220                 slaves of the active aggregator are down or the active
221                 aggregator has no slaves.
222
223                 This is the default value.
224
225         bandwidth or 1
226
227                 The active aggregator is chosen by largest aggregate
228                 bandwidth.  Reselection occurs if:
229
230                 - A slave is added to or removed from the bond
231
232                 - Any slave's link state changes
233
234                 - Any slave's 802.3ad association state changes
235
236                 - The bond's administrative state changes to up
237
238         count or 2
239
240                 The active aggregator is chosen by the largest number of
241                 ports (slaves).  Reselection occurs as described under the
242                 "bandwidth" setting, above.
243
244         The bandwidth and count selection policies permit failover of
245         802.3ad aggregations when partial failure of the active aggregator
246         occurs.  This keeps the aggregator with the highest availability
247         (either in bandwidth or in number of ports) active at all times.
248
249         This option was added in bonding version 3.4.0.
250
251 ad_user_port_key
252
253         In an AD system, the port-key has three parts as shown below -
254
255            =====  ============
256            Bits   Use
257            =====  ============
258            00     Duplex
259            01-05  Speed
260            06-15  User-defined
261            =====  ============
262
263         This defines the upper 10 bits of the port key. The values can be
264         from 0 - 1023. If not given, the system defaults to 0.
265
266         This parameter has effect only in 802.3ad mode and is available through
267         SysFs interface.
268
269 all_slaves_active
270
271         Specifies that duplicate frames (received on inactive ports) should be
272         dropped (0) or delivered (1).
273
274         Normally, bonding will drop duplicate frames (received on inactive
275         ports), which is desirable for most users. But there are some times
276         it is nice to allow duplicate frames to be delivered.
277
278         The default value is 0 (drop duplicate frames received on inactive
279         ports).
280
281 arp_interval
282
283         Specifies the ARP link monitoring frequency in milliseconds.
284
285         The ARP monitor works by periodically checking the slave
286         devices to determine whether they have sent or received
287         traffic recently (the precise criteria depends upon the
288         bonding mode, and the state of the slave).  Regular traffic is
289         generated via ARP probes issued for the addresses specified by
290         the arp_ip_target option.
291
292         This behavior can be modified by the arp_validate option,
293         below.
294
295         If ARP monitoring is used in an etherchannel compatible mode
296         (modes 0 and 2), the switch should be configured in a mode
297         that evenly distributes packets across all links. If the
298         switch is configured to distribute the packets in an XOR
299         fashion, all replies from the ARP targets will be received on
300         the same link which could cause the other team members to
301         fail.  ARP monitoring should not be used in conjunction with
302         miimon.  A value of 0 disables ARP monitoring.  The default
303         value is 0.
304
305 arp_ip_target
306
307         Specifies the IP addresses to use as ARP monitoring peers when
308         arp_interval is > 0.  These are the targets of the ARP request
309         sent to determine the health of the link to the targets.
310         Specify these values in ddd.ddd.ddd.ddd format.  Multiple IP
311         addresses must be separated by a comma.  At least one IP
312         address must be given for ARP monitoring to function.  The
313         maximum number of targets that can be specified is 16.  The
314         default value is no IP addresses.
315
316 arp_validate
317
318         Specifies whether or not ARP probes and replies should be
319         validated in any mode that supports arp monitoring, or whether
320         non-ARP traffic should be filtered (disregarded) for link
321         monitoring purposes.
322
323         Possible values are:
324
325         none or 0
326
327                 No validation or filtering is performed.
328
329         active or 1
330
331                 Validation is performed only for the active slave.
332
333         backup or 2
334
335                 Validation is performed only for backup slaves.
336
337         all or 3
338
339                 Validation is performed for all slaves.
340
341         filter or 4
342
343                 Filtering is applied to all slaves. No validation is
344                 performed.
345
346         filter_active or 5
347
348                 Filtering is applied to all slaves, validation is performed
349                 only for the active slave.
350
351         filter_backup or 6
352
353                 Filtering is applied to all slaves, validation is performed
354                 only for backup slaves.
355
356         Validation:
357
358         Enabling validation causes the ARP monitor to examine the incoming
359         ARP requests and replies, and only consider a slave to be up if it
360         is receiving the appropriate ARP traffic.
361
362         For an active slave, the validation checks ARP replies to confirm
363         that they were generated by an arp_ip_target.  Since backup slaves
364         do not typically receive these replies, the validation performed
365         for backup slaves is on the broadcast ARP request sent out via the
366         active slave.  It is possible that some switch or network
367         configurations may result in situations wherein the backup slaves
368         do not receive the ARP requests; in such a situation, validation
369         of backup slaves must be disabled.
370
371         The validation of ARP requests on backup slaves is mainly helping
372         bonding to decide which slaves are more likely to work in case of
373         the active slave failure, it doesn't really guarantee that the
374         backup slave will work if it's selected as the next active slave.
375
376         Validation is useful in network configurations in which multiple
377         bonding hosts are concurrently issuing ARPs to one or more targets
378         beyond a common switch.  Should the link between the switch and
379         target fail (but not the switch itself), the probe traffic
380         generated by the multiple bonding instances will fool the standard
381         ARP monitor into considering the links as still up.  Use of
382         validation can resolve this, as the ARP monitor will only consider
383         ARP requests and replies associated with its own instance of
384         bonding.
385
386         Filtering:
387
388         Enabling filtering causes the ARP monitor to only use incoming ARP
389         packets for link availability purposes.  Arriving packets that are
390         not ARPs are delivered normally, but do not count when determining
391         if a slave is available.
392
393         Filtering operates by only considering the reception of ARP
394         packets (any ARP packet, regardless of source or destination) when
395         determining if a slave has received traffic for link availability
396         purposes.
397
398         Filtering is useful in network configurations in which significant
399         levels of third party broadcast traffic would fool the standard
400         ARP monitor into considering the links as still up.  Use of
401         filtering can resolve this, as only ARP traffic is considered for
402         link availability purposes.
403
404         This option was added in bonding version 3.1.0.
405
406 arp_all_targets
407
408         Specifies the quantity of arp_ip_targets that must be reachable
409         in order for the ARP monitor to consider a slave as being up.
410         This option affects only active-backup mode for slaves with
411         arp_validation enabled.
412
413         Possible values are:
414
415         any or 0
416
417                 consider the slave up only when any of the arp_ip_targets
418                 is reachable
419
420         all or 1
421
422                 consider the slave up only when all of the arp_ip_targets
423                 are reachable
424
425 downdelay
426
427         Specifies the time, in milliseconds, to wait before disabling
428         a slave after a link failure has been detected.  This option
429         is only valid for the miimon link monitor.  The downdelay
430         value should be a multiple of the miimon value; if not, it
431         will be rounded down to the nearest multiple.  The default
432         value is 0.
433
434 fail_over_mac
435
436         Specifies whether active-backup mode should set all slaves to
437         the same MAC address at enslavement (the traditional
438         behavior), or, when enabled, perform special handling of the
439         bond's MAC address in accordance with the selected policy.
440
441         Possible values are:
442
443         none or 0
444
445                 This setting disables fail_over_mac, and causes
446                 bonding to set all slaves of an active-backup bond to
447                 the same MAC address at enslavement time.  This is the
448                 default.
449
450         active or 1
451
452                 The "active" fail_over_mac policy indicates that the
453                 MAC address of the bond should always be the MAC
454                 address of the currently active slave.  The MAC
455                 address of the slaves is not changed; instead, the MAC
456                 address of the bond changes during a failover.
457
458                 This policy is useful for devices that cannot ever
459                 alter their MAC address, or for devices that refuse
460                 incoming broadcasts with their own source MAC (which
461                 interferes with the ARP monitor).
462
463                 The down side of this policy is that every device on
464                 the network must be updated via gratuitous ARP,
465                 vs. just updating a switch or set of switches (which
466                 often takes place for any traffic, not just ARP
467                 traffic, if the switch snoops incoming traffic to
468                 update its tables) for the traditional method.  If the
469                 gratuitous ARP is lost, communication may be
470                 disrupted.
471
472                 When this policy is used in conjunction with the mii
473                 monitor, devices which assert link up prior to being
474                 able to actually transmit and receive are particularly
475                 susceptible to loss of the gratuitous ARP, and an
476                 appropriate updelay setting may be required.
477
478         follow or 2
479
480                 The "follow" fail_over_mac policy causes the MAC
481                 address of the bond to be selected normally (normally
482                 the MAC address of the first slave added to the bond).
483                 However, the second and subsequent slaves are not set
484                 to this MAC address while they are in a backup role; a
485                 slave is programmed with the bond's MAC address at
486                 failover time (and the formerly active slave receives
487                 the newly active slave's MAC address).
488
489                 This policy is useful for multiport devices that
490                 either become confused or incur a performance penalty
491                 when multiple ports are programmed with the same MAC
492                 address.
493
494
495         The default policy is none, unless the first slave cannot
496         change its MAC address, in which case the active policy is
497         selected by default.
498
499         This option may be modified via sysfs only when no slaves are
500         present in the bond.
501
502         This option was added in bonding version 3.2.0.  The "follow"
503         policy was added in bonding version 3.3.0.
504
505 lacp_active
506         Option specifying whether to send LACPDU frames periodically.
507
508         off or 0
509                 LACPDU frames acts as "speak when spoken to".
510
511         on or 1
512                 LACPDU frames are sent along the configured links
513                 periodically. See lacp_rate for more details.
514
515         The default is on.
516
517 lacp_rate
518
519         Option specifying the rate in which we'll ask our link partner
520         to transmit LACPDU packets in 802.3ad mode.  Possible values
521         are:
522
523         slow or 0
524                 Request partner to transmit LACPDUs every 30 seconds
525
526         fast or 1
527                 Request partner to transmit LACPDUs every 1 second
528
529         The default is slow.
530
531 max_bonds
532
533         Specifies the number of bonding devices to create for this
534         instance of the bonding driver.  E.g., if max_bonds is 3, and
535         the bonding driver is not already loaded, then bond0, bond1
536         and bond2 will be created.  The default value is 1.  Specifying
537         a value of 0 will load bonding, but will not create any devices.
538
539 miimon
540
541         Specifies the MII link monitoring frequency in milliseconds.
542         This determines how often the link state of each slave is
543         inspected for link failures.  A value of zero disables MII
544         link monitoring.  A value of 100 is a good starting point.
545         The use_carrier option, below, affects how the link state is
546         determined.  See the High Availability section for additional
547         information.  The default value is 0.
548
549 min_links
550
551         Specifies the minimum number of links that must be active before
552         asserting carrier. It is similar to the Cisco EtherChannel min-links
553         feature. This allows setting the minimum number of member ports that
554         must be up (link-up state) before marking the bond device as up
555         (carrier on). This is useful for situations where higher level services
556         such as clustering want to ensure a minimum number of low bandwidth
557         links are active before switchover. This option only affect 802.3ad
558         mode.
559
560         The default value is 0. This will cause carrier to be asserted (for
561         802.3ad mode) whenever there is an active aggregator, regardless of the
562         number of available links in that aggregator. Note that, because an
563         aggregator cannot be active without at least one available link,
564         setting this option to 0 or to 1 has the exact same effect.
565
566 mode
567
568         Specifies one of the bonding policies. The default is
569         balance-rr (round robin).  Possible values are:
570
571         balance-rr or 0
572
573                 Round-robin policy: Transmit packets in sequential
574                 order from the first available slave through the
575                 last.  This mode provides load balancing and fault
576                 tolerance.
577
578         active-backup or 1
579
580                 Active-backup policy: Only one slave in the bond is
581                 active.  A different slave becomes active if, and only
582                 if, the active slave fails.  The bond's MAC address is
583                 externally visible on only one port (network adapter)
584                 to avoid confusing the switch.
585
586                 In bonding version 2.6.2 or later, when a failover
587                 occurs in active-backup mode, bonding will issue one
588                 or more gratuitous ARPs on the newly active slave.
589                 One gratuitous ARP is issued for the bonding master
590                 interface and each VLAN interfaces configured above
591                 it, provided that the interface has at least one IP
592                 address configured.  Gratuitous ARPs issued for VLAN
593                 interfaces are tagged with the appropriate VLAN id.
594
595                 This mode provides fault tolerance.  The primary
596                 option, documented below, affects the behavior of this
597                 mode.
598
599         balance-xor or 2
600
601                 XOR policy: Transmit based on the selected transmit
602                 hash policy.  The default policy is a simple [(source
603                 MAC address XOR'd with destination MAC address XOR
604                 packet type ID) modulo slave count].  Alternate transmit
605                 policies may be selected via the xmit_hash_policy option,
606                 described below.
607
608                 This mode provides load balancing and fault tolerance.
609
610         broadcast or 3
611
612                 Broadcast policy: transmits everything on all slave
613                 interfaces.  This mode provides fault tolerance.
614
615         802.3ad or 4
616
617                 IEEE 802.3ad Dynamic link aggregation.  Creates
618                 aggregation groups that share the same speed and
619                 duplex settings.  Utilizes all slaves in the active
620                 aggregator according to the 802.3ad specification.
621
622                 Slave selection for outgoing traffic is done according
623                 to the transmit hash policy, which may be changed from
624                 the default simple XOR policy via the xmit_hash_policy
625                 option, documented below.  Note that not all transmit
626                 policies may be 802.3ad compliant, particularly in
627                 regards to the packet mis-ordering requirements of
628                 section 43.2.4 of the 802.3ad standard.  Differing
629                 peer implementations will have varying tolerances for
630                 noncompliance.
631
632                 Prerequisites:
633
634                 1. Ethtool support in the base drivers for retrieving
635                 the speed and duplex of each slave.
636
637                 2. A switch that supports IEEE 802.3ad Dynamic link
638                 aggregation.
639
640                 Most switches will require some type of configuration
641                 to enable 802.3ad mode.
642
643         balance-tlb or 5
644
645                 Adaptive transmit load balancing: channel bonding that
646                 does not require any special switch support.
647
648                 In tlb_dynamic_lb=1 mode; the outgoing traffic is
649                 distributed according to the current load (computed
650                 relative to the speed) on each slave.
651
652                 In tlb_dynamic_lb=0 mode; the load balancing based on
653                 current load is disabled and the load is distributed
654                 only using the hash distribution.
655
656                 Incoming traffic is received by the current slave.
657                 If the receiving slave fails, another slave takes over
658                 the MAC address of the failed receiving slave.
659
660                 Prerequisite:
661
662                 Ethtool support in the base drivers for retrieving the
663                 speed of each slave.
664
665         balance-alb or 6
666
667                 Adaptive load balancing: includes balance-tlb plus
668                 receive load balancing (rlb) for IPV4 traffic, and
669                 does not require any special switch support.  The
670                 receive load balancing is achieved by ARP negotiation.
671                 The bonding driver intercepts the ARP Replies sent by
672                 the local system on their way out and overwrites the
673                 source hardware address with the unique hardware
674                 address of one of the slaves in the bond such that
675                 different peers use different hardware addresses for
676                 the server.
677
678                 Receive traffic from connections created by the server
679                 is also balanced.  When the local system sends an ARP
680                 Request the bonding driver copies and saves the peer's
681                 IP information from the ARP packet.  When the ARP
682                 Reply arrives from the peer, its hardware address is
683                 retrieved and the bonding driver initiates an ARP
684                 reply to this peer assigning it to one of the slaves
685                 in the bond.  A problematic outcome of using ARP
686                 negotiation for balancing is that each time that an
687                 ARP request is broadcast it uses the hardware address
688                 of the bond.  Hence, peers learn the hardware address
689                 of the bond and the balancing of receive traffic
690                 collapses to the current slave.  This is handled by
691                 sending updates (ARP Replies) to all the peers with
692                 their individually assigned hardware address such that
693                 the traffic is redistributed.  Receive traffic is also
694                 redistributed when a new slave is added to the bond
695                 and when an inactive slave is re-activated.  The
696                 receive load is distributed sequentially (round robin)
697                 among the group of highest speed slaves in the bond.
698
699                 When a link is reconnected or a new slave joins the
700                 bond the receive traffic is redistributed among all
701                 active slaves in the bond by initiating ARP Replies
702                 with the selected MAC address to each of the
703                 clients. The updelay parameter (detailed below) must
704                 be set to a value equal or greater than the switch's
705                 forwarding delay so that the ARP Replies sent to the
706                 peers will not be blocked by the switch.
707
708                 Prerequisites:
709
710                 1. Ethtool support in the base drivers for retrieving
711                 the speed of each slave.
712
713                 2. Base driver support for setting the hardware
714                 address of a device while it is open.  This is
715                 required so that there will always be one slave in the
716                 team using the bond hardware address (the
717                 curr_active_slave) while having a unique hardware
718                 address for each slave in the bond.  If the
719                 curr_active_slave fails its hardware address is
720                 swapped with the new curr_active_slave that was
721                 chosen.
722
723 num_grat_arp,
724 num_unsol_na
725
726         Specify the number of peer notifications (gratuitous ARPs and
727         unsolicited IPv6 Neighbor Advertisements) to be issued after a
728         failover event.  As soon as the link is up on the new slave
729         (possibly immediately) a peer notification is sent on the
730         bonding device and each VLAN sub-device. This is repeated at
731         the rate specified by peer_notif_delay if the number is
732         greater than 1.
733
734         The valid range is 0 - 255; the default value is 1.  These options
735         affect only the active-backup mode.  These options were added for
736         bonding versions 3.3.0 and 3.4.0 respectively.
737
738         From Linux 3.0 and bonding version 3.7.1, these notifications
739         are generated by the ipv4 and ipv6 code and the numbers of
740         repetitions cannot be set independently.
741
742 packets_per_slave
743
744         Specify the number of packets to transmit through a slave before
745         moving to the next one. When set to 0 then a slave is chosen at
746         random.
747
748         The valid range is 0 - 65535; the default value is 1. This option
749         has effect only in balance-rr mode.
750
751 peer_notif_delay
752
753         Specify the delay, in milliseconds, between each peer
754         notification (gratuitous ARP and unsolicited IPv6 Neighbor
755         Advertisement) when they are issued after a failover event.
756         This delay should be a multiple of the link monitor interval
757         (arp_interval or miimon, whichever is active). The default
758         value is 0 which means to match the value of the link monitor
759         interval.
760
761 primary
762
763         A string (eth0, eth2, etc) specifying which slave is the
764         primary device.  The specified device will always be the
765         active slave while it is available.  Only when the primary is
766         off-line will alternate devices be used.  This is useful when
767         one slave is preferred over another, e.g., when one slave has
768         higher throughput than another.
769
770         The primary option is only valid for active-backup(1),
771         balance-tlb (5) and balance-alb (6) mode.
772
773 primary_reselect
774
775         Specifies the reselection policy for the primary slave.  This
776         affects how the primary slave is chosen to become the active slave
777         when failure of the active slave or recovery of the primary slave
778         occurs.  This option is designed to prevent flip-flopping between
779         the primary slave and other slaves.  Possible values are:
780
781         always or 0 (default)
782
783                 The primary slave becomes the active slave whenever it
784                 comes back up.
785
786         better or 1
787
788                 The primary slave becomes the active slave when it comes
789                 back up, if the speed and duplex of the primary slave is
790                 better than the speed and duplex of the current active
791                 slave.
792
793         failure or 2
794
795                 The primary slave becomes the active slave only if the
796                 current active slave fails and the primary slave is up.
797
798         The primary_reselect setting is ignored in two cases:
799
800                 If no slaves are active, the first slave to recover is
801                 made the active slave.
802
803                 When initially enslaved, the primary slave is always made
804                 the active slave.
805
806         Changing the primary_reselect policy via sysfs will cause an
807         immediate selection of the best active slave according to the new
808         policy.  This may or may not result in a change of the active
809         slave, depending upon the circumstances.
810
811         This option was added for bonding version 3.6.0.
812
813 tlb_dynamic_lb
814
815         Specifies if dynamic shuffling of flows is enabled in tlb
816         mode. The value has no effect on any other modes.
817
818         The default behavior of tlb mode is to shuffle active flows across
819         slaves based on the load in that interval. This gives nice lb
820         characteristics but can cause packet reordering. If re-ordering is
821         a concern use this variable to disable flow shuffling and rely on
822         load balancing provided solely by the hash distribution.
823         xmit-hash-policy can be used to select the appropriate hashing for
824         the setup.
825
826         The sysfs entry can be used to change the setting per bond device
827         and the initial value is derived from the module parameter. The
828         sysfs entry is allowed to be changed only if the bond device is
829         down.
830
831         The default value is "1" that enables flow shuffling while value "0"
832         disables it. This option was added in bonding driver 3.7.1
833
834
835 updelay
836
837         Specifies the time, in milliseconds, to wait before enabling a
838         slave after a link recovery has been detected.  This option is
839         only valid for the miimon link monitor.  The updelay value
840         should be a multiple of the miimon value; if not, it will be
841         rounded down to the nearest multiple.  The default value is 0.
842
843 use_carrier
844
845         Specifies whether or not miimon should use MII or ETHTOOL
846         ioctls vs. netif_carrier_ok() to determine the link
847         status. The MII or ETHTOOL ioctls are less efficient and
848         utilize a deprecated calling sequence within the kernel.  The
849         netif_carrier_ok() relies on the device driver to maintain its
850         state with netif_carrier_on/off; at this writing, most, but
851         not all, device drivers support this facility.
852
853         If bonding insists that the link is up when it should not be,
854         it may be that your network device driver does not support
855         netif_carrier_on/off.  The default state for netif_carrier is
856         "carrier on," so if a driver does not support netif_carrier,
857         it will appear as if the link is always up.  In this case,
858         setting use_carrier to 0 will cause bonding to revert to the
859         MII / ETHTOOL ioctl method to determine the link state.
860
861         A value of 1 enables the use of netif_carrier_ok(), a value of
862         0 will use the deprecated MII / ETHTOOL ioctls.  The default
863         value is 1.
864
865 xmit_hash_policy
866
867         Selects the transmit hash policy to use for slave selection in
868         balance-xor, 802.3ad, and tlb modes.  Possible values are:
869
870         layer2
871
872                 Uses XOR of hardware MAC addresses and packet type ID
873                 field to generate the hash. The formula is
874
875                 hash = source MAC XOR destination MAC XOR packet type ID
876                 slave number = hash modulo slave count
877
878                 This algorithm will place all traffic to a particular
879                 network peer on the same slave.
880
881                 This algorithm is 802.3ad compliant.
882
883         layer2+3
884
885                 This policy uses a combination of layer2 and layer3
886                 protocol information to generate the hash.
887
888                 Uses XOR of hardware MAC addresses and IP addresses to
889                 generate the hash.  The formula is
890
891                 hash = source MAC XOR destination MAC XOR packet type ID
892                 hash = hash XOR source IP XOR destination IP
893                 hash = hash XOR (hash RSHIFT 16)
894                 hash = hash XOR (hash RSHIFT 8)
895                 And then hash is reduced modulo slave count.
896
897                 If the protocol is IPv6 then the source and destination
898                 addresses are first hashed using ipv6_addr_hash.
899
900                 This algorithm will place all traffic to a particular
901                 network peer on the same slave.  For non-IP traffic,
902                 the formula is the same as for the layer2 transmit
903                 hash policy.
904
905                 This policy is intended to provide a more balanced
906                 distribution of traffic than layer2 alone, especially
907                 in environments where a layer3 gateway device is
908                 required to reach most destinations.
909
910                 This algorithm is 802.3ad compliant.
911
912         layer3+4
913
914                 This policy uses upper layer protocol information,
915                 when available, to generate the hash.  This allows for
916                 traffic to a particular network peer to span multiple
917                 slaves, although a single connection will not span
918                 multiple slaves.
919
920                 The formula for unfragmented TCP and UDP packets is
921
922                 hash = source port, destination port (as in the header)
923                 hash = hash XOR source IP XOR destination IP
924                 hash = hash XOR (hash RSHIFT 16)
925                 hash = hash XOR (hash RSHIFT 8)
926                 And then hash is reduced modulo slave count.
927
928                 If the protocol is IPv6 then the source and destination
929                 addresses are first hashed using ipv6_addr_hash.
930
931                 For fragmented TCP or UDP packets and all other IPv4 and
932                 IPv6 protocol traffic, the source and destination port
933                 information is omitted.  For non-IP traffic, the
934                 formula is the same as for the layer2 transmit hash
935                 policy.
936
937                 This algorithm is not fully 802.3ad compliant.  A
938                 single TCP or UDP conversation containing both
939                 fragmented and unfragmented packets will see packets
940                 striped across two interfaces.  This may result in out
941                 of order delivery.  Most traffic types will not meet
942                 this criteria, as TCP rarely fragments traffic, and
943                 most UDP traffic is not involved in extended
944                 conversations.  Other implementations of 802.3ad may
945                 or may not tolerate this noncompliance.
946
947         encap2+3
948
949                 This policy uses the same formula as layer2+3 but it
950                 relies on skb_flow_dissect to obtain the header fields
951                 which might result in the use of inner headers if an
952                 encapsulation protocol is used. For example this will
953                 improve the performance for tunnel users because the
954                 packets will be distributed according to the encapsulated
955                 flows.
956
957         encap3+4
958
959                 This policy uses the same formula as layer3+4 but it
960                 relies on skb_flow_dissect to obtain the header fields
961                 which might result in the use of inner headers if an
962                 encapsulation protocol is used. For example this will
963                 improve the performance for tunnel users because the
964                 packets will be distributed according to the encapsulated
965                 flows.
966
967         vlan+srcmac
968
969                 This policy uses a very rudimentary vlan ID and source mac
970                 hash to load-balance traffic per-vlan, with failover
971                 should one leg fail. The intended use case is for a bond
972                 shared by multiple virtual machines, all configured to
973                 use their own vlan, to give lacp-like functionality
974                 without requiring lacp-capable switching hardware.
975
976                 The formula for the hash is simply
977
978                 hash = (vlan ID) XOR (source MAC vendor) XOR (source MAC dev)
979
980         The default value is layer2.  This option was added in bonding
981         version 2.6.3.  In earlier versions of bonding, this parameter
982         does not exist, and the layer2 policy is the only policy.  The
983         layer2+3 value was added for bonding version 3.2.2.
984
985 resend_igmp
986
987         Specifies the number of IGMP membership reports to be issued after
988         a failover event. One membership report is issued immediately after
989         the failover, subsequent packets are sent in each 200ms interval.
990
991         The valid range is 0 - 255; the default value is 1. A value of 0
992         prevents the IGMP membership report from being issued in response
993         to the failover event.
994
995         This option is useful for bonding modes balance-rr (0), active-backup
996         (1), balance-tlb (5) and balance-alb (6), in which a failover can
997         switch the IGMP traffic from one slave to another.  Therefore a fresh
998         IGMP report must be issued to cause the switch to forward the incoming
999         IGMP traffic over the newly selected slave.
1000
1001         This option was added for bonding version 3.7.0.
1002
1003 lp_interval
1004
1005         Specifies the number of seconds between instances where the bonding
1006         driver sends learning packets to each slaves peer switch.
1007
1008         The valid range is 1 - 0x7fffffff; the default value is 1. This Option
1009         has effect only in balance-tlb and balance-alb modes.
1010
1011 3. Configuring Bonding Devices
1012 ==============================
1013
1014 You can configure bonding using either your distro's network
1015 initialization scripts, or manually using either iproute2 or the
1016 sysfs interface.  Distros generally use one of three packages for the
1017 network initialization scripts: initscripts, sysconfig or interfaces.
1018 Recent versions of these packages have support for bonding, while older
1019 versions do not.
1020
1021 We will first describe the options for configuring bonding for
1022 distros using versions of initscripts, sysconfig and interfaces with full
1023 or partial support for bonding, then provide information on enabling
1024 bonding without support from the network initialization scripts (i.e.,
1025 older versions of initscripts or sysconfig).
1026
1027 If you're unsure whether your distro uses sysconfig,
1028 initscripts or interfaces, or don't know if it's new enough, have no fear.
1029 Determining this is fairly straightforward.
1030
1031 First, look for a file called interfaces in /etc/network directory.
1032 If this file is present in your system, then your system use interfaces. See
1033 Configuration with Interfaces Support.
1034
1035 Else, issue the command::
1036
1037         $ rpm -qf /sbin/ifup
1038
1039 It will respond with a line of text starting with either
1040 "initscripts" or "sysconfig," followed by some numbers.  This is the
1041 package that provides your network initialization scripts.
1042
1043 Next, to determine if your installation supports bonding,
1044 issue the command::
1045
1046     $ grep ifenslave /sbin/ifup
1047
1048 If this returns any matches, then your initscripts or
1049 sysconfig has support for bonding.
1050
1051 3.1 Configuration with Sysconfig Support
1052 ----------------------------------------
1053
1054 This section applies to distros using a version of sysconfig
1055 with bonding support, for example, SuSE Linux Enterprise Server 9.
1056
1057 SuSE SLES 9's networking configuration system does support
1058 bonding, however, at this writing, the YaST system configuration
1059 front end does not provide any means to work with bonding devices.
1060 Bonding devices can be managed by hand, however, as follows.
1061
1062 First, if they have not already been configured, configure the
1063 slave devices.  On SLES 9, this is most easily done by running the
1064 yast2 sysconfig configuration utility.  The goal is for to create an
1065 ifcfg-id file for each slave device.  The simplest way to accomplish
1066 this is to configure the devices for DHCP (this is only to get the
1067 file ifcfg-id file created; see below for some issues with DHCP).  The
1068 name of the configuration file for each device will be of the form::
1069
1070     ifcfg-id-xx:xx:xx:xx:xx:xx
1071
1072 Where the "xx" portion will be replaced with the digits from
1073 the device's permanent MAC address.
1074
1075 Once the set of ifcfg-id-xx:xx:xx:xx:xx:xx files has been
1076 created, it is necessary to edit the configuration files for the slave
1077 devices (the MAC addresses correspond to those of the slave devices).
1078 Before editing, the file will contain multiple lines, and will look
1079 something like this::
1080
1081         BOOTPROTO='dhcp'
1082         STARTMODE='on'
1083         USERCTL='no'
1084         UNIQUE='XNzu.WeZGOGF+4wE'
1085         _nm_name='bus-pci-0001:61:01.0'
1086
1087 Change the BOOTPROTO and STARTMODE lines to the following::
1088
1089         BOOTPROTO='none'
1090         STARTMODE='off'
1091
1092 Do not alter the UNIQUE or _nm_name lines.  Remove any other
1093 lines (USERCTL, etc).
1094
1095 Once the ifcfg-id-xx:xx:xx:xx:xx:xx files have been modified,
1096 it's time to create the configuration file for the bonding device
1097 itself.  This file is named ifcfg-bondX, where X is the number of the
1098 bonding device to create, starting at 0.  The first such file is
1099 ifcfg-bond0, the second is ifcfg-bond1, and so on.  The sysconfig
1100 network configuration system will correctly start multiple instances
1101 of bonding.
1102
1103 The contents of the ifcfg-bondX file is as follows::
1104
1105         BOOTPROTO="static"
1106         BROADCAST="10.0.2.255"
1107         IPADDR="10.0.2.10"
1108         NETMASK="255.255.0.0"
1109         NETWORK="10.0.2.0"
1110         REMOTE_IPADDR=""
1111         STARTMODE="onboot"
1112         BONDING_MASTER="yes"
1113         BONDING_MODULE_OPTS="mode=active-backup miimon=100"
1114         BONDING_SLAVE0="eth0"
1115         BONDING_SLAVE1="bus-pci-0000:06:08.1"
1116
1117 Replace the sample BROADCAST, IPADDR, NETMASK and NETWORK
1118 values with the appropriate values for your network.
1119
1120 The STARTMODE specifies when the device is brought online.
1121 The possible values are:
1122
1123         ======== ======================================================
1124         onboot   The device is started at boot time.  If you're not
1125                  sure, this is probably what you want.
1126
1127         manual   The device is started only when ifup is called
1128                  manually.  Bonding devices may be configured this
1129                  way if you do not wish them to start automatically
1130                  at boot for some reason.
1131
1132         hotplug  The device is started by a hotplug event.  This is not
1133                  a valid choice for a bonding device.
1134
1135         off or   The device configuration is ignored.
1136         ignore
1137         ======== ======================================================
1138
1139 The line BONDING_MASTER='yes' indicates that the device is a
1140 bonding master device.  The only useful value is "yes."
1141
1142 The contents of BONDING_MODULE_OPTS are supplied to the
1143 instance of the bonding module for this device.  Specify the options
1144 for the bonding mode, link monitoring, and so on here.  Do not include
1145 the max_bonds bonding parameter; this will confuse the configuration
1146 system if you have multiple bonding devices.
1147
1148 Finally, supply one BONDING_SLAVEn="slave device" for each
1149 slave.  where "n" is an increasing value, one for each slave.  The
1150 "slave device" is either an interface name, e.g., "eth0", or a device
1151 specifier for the network device.  The interface name is easier to
1152 find, but the ethN names are subject to change at boot time if, e.g.,
1153 a device early in the sequence has failed.  The device specifiers
1154 (bus-pci-0000:06:08.1 in the example above) specify the physical
1155 network device, and will not change unless the device's bus location
1156 changes (for example, it is moved from one PCI slot to another).  The
1157 example above uses one of each type for demonstration purposes; most
1158 configurations will choose one or the other for all slave devices.
1159
1160 When all configuration files have been modified or created,
1161 networking must be restarted for the configuration changes to take
1162 effect.  This can be accomplished via the following::
1163
1164         # /etc/init.d/network restart
1165
1166 Note that the network control script (/sbin/ifdown) will
1167 remove the bonding module as part of the network shutdown processing,
1168 so it is not necessary to remove the module by hand if, e.g., the
1169 module parameters have changed.
1170
1171 Also, at this writing, YaST/YaST2 will not manage bonding
1172 devices (they do not show bonding interfaces on its list of network
1173 devices).  It is necessary to edit the configuration file by hand to
1174 change the bonding configuration.
1175
1176 Additional general options and details of the ifcfg file
1177 format can be found in an example ifcfg template file::
1178
1179         /etc/sysconfig/network/ifcfg.template
1180
1181 Note that the template does not document the various ``BONDING_*``
1182 settings described above, but does describe many of the other options.
1183
1184 3.1.1 Using DHCP with Sysconfig
1185 -------------------------------
1186
1187 Under sysconfig, configuring a device with BOOTPROTO='dhcp'
1188 will cause it to query DHCP for its IP address information.  At this
1189 writing, this does not function for bonding devices; the scripts
1190 attempt to obtain the device address from DHCP prior to adding any of
1191 the slave devices.  Without active slaves, the DHCP requests are not
1192 sent to the network.
1193
1194 3.1.2 Configuring Multiple Bonds with Sysconfig
1195 -----------------------------------------------
1196
1197 The sysconfig network initialization system is capable of
1198 handling multiple bonding devices.  All that is necessary is for each
1199 bonding instance to have an appropriately configured ifcfg-bondX file
1200 (as described above).  Do not specify the "max_bonds" parameter to any
1201 instance of bonding, as this will confuse sysconfig.  If you require
1202 multiple bonding devices with identical parameters, create multiple
1203 ifcfg-bondX files.
1204
1205 Because the sysconfig scripts supply the bonding module
1206 options in the ifcfg-bondX file, it is not necessary to add them to
1207 the system ``/etc/modules.d/*.conf`` configuration files.
1208
1209 3.2 Configuration with Initscripts Support
1210 ------------------------------------------
1211
1212 This section applies to distros using a recent version of
1213 initscripts with bonding support, for example, Red Hat Enterprise Linux
1214 version 3 or later, Fedora, etc.  On these systems, the network
1215 initialization scripts have knowledge of bonding, and can be configured to
1216 control bonding devices.  Note that older versions of the initscripts
1217 package have lower levels of support for bonding; this will be noted where
1218 applicable.
1219
1220 These distros will not automatically load the network adapter
1221 driver unless the ethX device is configured with an IP address.
1222 Because of this constraint, users must manually configure a
1223 network-script file for all physical adapters that will be members of
1224 a bondX link.  Network script files are located in the directory:
1225
1226 /etc/sysconfig/network-scripts
1227
1228 The file name must be prefixed with "ifcfg-eth" and suffixed
1229 with the adapter's physical adapter number.  For example, the script
1230 for eth0 would be named /etc/sysconfig/network-scripts/ifcfg-eth0.
1231 Place the following text in the file::
1232
1233         DEVICE=eth0
1234         USERCTL=no
1235         ONBOOT=yes
1236         MASTER=bond0
1237         SLAVE=yes
1238         BOOTPROTO=none
1239
1240 The DEVICE= line will be different for every ethX device and
1241 must correspond with the name of the file, i.e., ifcfg-eth1 must have
1242 a device line of DEVICE=eth1.  The setting of the MASTER= line will
1243 also depend on the final bonding interface name chosen for your bond.
1244 As with other network devices, these typically start at 0, and go up
1245 one for each device, i.e., the first bonding instance is bond0, the
1246 second is bond1, and so on.
1247
1248 Next, create a bond network script.  The file name for this
1249 script will be /etc/sysconfig/network-scripts/ifcfg-bondX where X is
1250 the number of the bond.  For bond0 the file is named "ifcfg-bond0",
1251 for bond1 it is named "ifcfg-bond1", and so on.  Within that file,
1252 place the following text::
1253
1254         DEVICE=bond0
1255         IPADDR=192.168.1.1
1256         NETMASK=255.255.255.0
1257         NETWORK=192.168.1.0
1258         BROADCAST=192.168.1.255
1259         ONBOOT=yes
1260         BOOTPROTO=none
1261         USERCTL=no
1262
1263 Be sure to change the networking specific lines (IPADDR,
1264 NETMASK, NETWORK and BROADCAST) to match your network configuration.
1265
1266 For later versions of initscripts, such as that found with Fedora
1267 7 (or later) and Red Hat Enterprise Linux version 5 (or later), it is possible,
1268 and, indeed, preferable, to specify the bonding options in the ifcfg-bond0
1269 file, e.g. a line of the format::
1270
1271   BONDING_OPTS="mode=active-backup arp_interval=60 arp_ip_target=192.168.1.254"
1272
1273 will configure the bond with the specified options.  The options
1274 specified in BONDING_OPTS are identical to the bonding module parameters
1275 except for the arp_ip_target field when using versions of initscripts older
1276 than and 8.57 (Fedora 8) and 8.45.19 (Red Hat Enterprise Linux 5.2).  When
1277 using older versions each target should be included as a separate option and
1278 should be preceded by a '+' to indicate it should be added to the list of
1279 queried targets, e.g.,::
1280
1281     arp_ip_target=+192.168.1.1 arp_ip_target=+192.168.1.2
1282
1283 is the proper syntax to specify multiple targets.  When specifying
1284 options via BONDING_OPTS, it is not necessary to edit
1285 ``/etc/modprobe.d/*.conf``.
1286
1287 For even older versions of initscripts that do not support
1288 BONDING_OPTS, it is necessary to edit /etc/modprobe.d/*.conf, depending upon
1289 your distro) to load the bonding module with your desired options when the
1290 bond0 interface is brought up.  The following lines in /etc/modprobe.d/*.conf
1291 will load the bonding module, and select its options:
1292
1293         alias bond0 bonding
1294         options bond0 mode=balance-alb miimon=100
1295
1296 Replace the sample parameters with the appropriate set of
1297 options for your configuration.
1298
1299 Finally run "/etc/rc.d/init.d/network restart" as root.  This
1300 will restart the networking subsystem and your bond link should be now
1301 up and running.
1302
1303 3.2.1 Using DHCP with Initscripts
1304 ---------------------------------
1305
1306 Recent versions of initscripts (the versions supplied with Fedora
1307 Core 3 and Red Hat Enterprise Linux 4, or later versions, are reported to
1308 work) have support for assigning IP information to bonding devices via
1309 DHCP.
1310
1311 To configure bonding for DHCP, configure it as described
1312 above, except replace the line "BOOTPROTO=none" with "BOOTPROTO=dhcp"
1313 and add a line consisting of "TYPE=Bonding".  Note that the TYPE value
1314 is case sensitive.
1315
1316 3.2.2 Configuring Multiple Bonds with Initscripts
1317 -------------------------------------------------
1318
1319 Initscripts packages that are included with Fedora 7 and Red Hat
1320 Enterprise Linux 5 support multiple bonding interfaces by simply
1321 specifying the appropriate BONDING_OPTS= in ifcfg-bondX where X is the
1322 number of the bond.  This support requires sysfs support in the kernel,
1323 and a bonding driver of version 3.0.0 or later.  Other configurations may
1324 not support this method for specifying multiple bonding interfaces; for
1325 those instances, see the "Configuring Multiple Bonds Manually" section,
1326 below.
1327
1328 3.3 Configuring Bonding Manually with iproute2
1329 -----------------------------------------------
1330
1331 This section applies to distros whose network initialization
1332 scripts (the sysconfig or initscripts package) do not have specific
1333 knowledge of bonding.  One such distro is SuSE Linux Enterprise Server
1334 version 8.
1335
1336 The general method for these systems is to place the bonding
1337 module parameters into a config file in /etc/modprobe.d/ (as
1338 appropriate for the installed distro), then add modprobe and/or
1339 `ip link` commands to the system's global init script.  The name of
1340 the global init script differs; for sysconfig, it is
1341 /etc/init.d/boot.local and for initscripts it is /etc/rc.d/rc.local.
1342
1343 For example, if you wanted to make a simple bond of two e100
1344 devices (presumed to be eth0 and eth1), and have it persist across
1345 reboots, edit the appropriate file (/etc/init.d/boot.local or
1346 /etc/rc.d/rc.local), and add the following::
1347
1348         modprobe bonding mode=balance-alb miimon=100
1349         modprobe e100
1350         ifconfig bond0 192.168.1.1 netmask 255.255.255.0 up
1351         ip link set eth0 master bond0
1352         ip link set eth1 master bond0
1353
1354 Replace the example bonding module parameters and bond0
1355 network configuration (IP address, netmask, etc) with the appropriate
1356 values for your configuration.
1357
1358 Unfortunately, this method will not provide support for the
1359 ifup and ifdown scripts on the bond devices.  To reload the bonding
1360 configuration, it is necessary to run the initialization script, e.g.,::
1361
1362         # /etc/init.d/boot.local
1363
1364 or::
1365
1366         # /etc/rc.d/rc.local
1367
1368 It may be desirable in such a case to create a separate script
1369 which only initializes the bonding configuration, then call that
1370 separate script from within boot.local.  This allows for bonding to be
1371 enabled without re-running the entire global init script.
1372
1373 To shut down the bonding devices, it is necessary to first
1374 mark the bonding device itself as being down, then remove the
1375 appropriate device driver modules.  For our example above, you can do
1376 the following::
1377
1378         # ifconfig bond0 down
1379         # rmmod bonding
1380         # rmmod e100
1381
1382 Again, for convenience, it may be desirable to create a script
1383 with these commands.
1384
1385
1386 3.3.1 Configuring Multiple Bonds Manually
1387 -----------------------------------------
1388
1389 This section contains information on configuring multiple
1390 bonding devices with differing options for those systems whose network
1391 initialization scripts lack support for configuring multiple bonds.
1392
1393 If you require multiple bonding devices, but all with the same
1394 options, you may wish to use the "max_bonds" module parameter,
1395 documented above.
1396
1397 To create multiple bonding devices with differing options, it is
1398 preferable to use bonding parameters exported by sysfs, documented in the
1399 section below.
1400
1401 For versions of bonding without sysfs support, the only means to
1402 provide multiple instances of bonding with differing options is to load
1403 the bonding driver multiple times.  Note that current versions of the
1404 sysconfig network initialization scripts handle this automatically; if
1405 your distro uses these scripts, no special action is needed.  See the
1406 section Configuring Bonding Devices, above, if you're not sure about your
1407 network initialization scripts.
1408
1409 To load multiple instances of the module, it is necessary to
1410 specify a different name for each instance (the module loading system
1411 requires that every loaded module, even multiple instances of the same
1412 module, have a unique name).  This is accomplished by supplying multiple
1413 sets of bonding options in ``/etc/modprobe.d/*.conf``, for example::
1414
1415         alias bond0 bonding
1416         options bond0 -o bond0 mode=balance-rr miimon=100
1417
1418         alias bond1 bonding
1419         options bond1 -o bond1 mode=balance-alb miimon=50
1420
1421 will load the bonding module two times.  The first instance is
1422 named "bond0" and creates the bond0 device in balance-rr mode with an
1423 miimon of 100.  The second instance is named "bond1" and creates the
1424 bond1 device in balance-alb mode with an miimon of 50.
1425
1426 In some circumstances (typically with older distributions),
1427 the above does not work, and the second bonding instance never sees
1428 its options.  In that case, the second options line can be substituted
1429 as follows::
1430
1431         install bond1 /sbin/modprobe --ignore-install bonding -o bond1 \
1432                                      mode=balance-alb miimon=50
1433
1434 This may be repeated any number of times, specifying a new and
1435 unique name in place of bond1 for each subsequent instance.
1436
1437 It has been observed that some Red Hat supplied kernels are unable
1438 to rename modules at load time (the "-o bond1" part).  Attempts to pass
1439 that option to modprobe will produce an "Operation not permitted" error.
1440 This has been reported on some Fedora Core kernels, and has been seen on
1441 RHEL 4 as well.  On kernels exhibiting this problem, it will be impossible
1442 to configure multiple bonds with differing parameters (as they are older
1443 kernels, and also lack sysfs support).
1444
1445 3.4 Configuring Bonding Manually via Sysfs
1446 ------------------------------------------
1447
1448 Starting with version 3.0.0, Channel Bonding may be configured
1449 via the sysfs interface.  This interface allows dynamic configuration
1450 of all bonds in the system without unloading the module.  It also
1451 allows for adding and removing bonds at runtime.  Ifenslave is no
1452 longer required, though it is still supported.
1453
1454 Use of the sysfs interface allows you to use multiple bonds
1455 with different configurations without having to reload the module.
1456 It also allows you to use multiple, differently configured bonds when
1457 bonding is compiled into the kernel.
1458
1459 You must have the sysfs filesystem mounted to configure
1460 bonding this way.  The examples in this document assume that you
1461 are using the standard mount point for sysfs, e.g. /sys.  If your
1462 sysfs filesystem is mounted elsewhere, you will need to adjust the
1463 example paths accordingly.
1464
1465 Creating and Destroying Bonds
1466 -----------------------------
1467 To add a new bond foo::
1468
1469         # echo +foo > /sys/class/net/bonding_masters
1470
1471 To remove an existing bond bar::
1472
1473         # echo -bar > /sys/class/net/bonding_masters
1474
1475 To show all existing bonds::
1476
1477         # cat /sys/class/net/bonding_masters
1478
1479 .. note::
1480
1481    due to 4K size limitation of sysfs files, this list may be
1482    truncated if you have more than a few hundred bonds.  This is unlikely
1483    to occur under normal operating conditions.
1484
1485 Adding and Removing Slaves
1486 --------------------------
1487 Interfaces may be enslaved to a bond using the file
1488 /sys/class/net/<bond>/bonding/slaves.  The semantics for this file
1489 are the same as for the bonding_masters file.
1490
1491 To enslave interface eth0 to bond bond0::
1492
1493         # ifconfig bond0 up
1494         # echo +eth0 > /sys/class/net/bond0/bonding/slaves
1495
1496 To free slave eth0 from bond bond0::
1497
1498         # echo -eth0 > /sys/class/net/bond0/bonding/slaves
1499
1500 When an interface is enslaved to a bond, symlinks between the
1501 two are created in the sysfs filesystem.  In this case, you would get
1502 /sys/class/net/bond0/slave_eth0 pointing to /sys/class/net/eth0, and
1503 /sys/class/net/eth0/master pointing to /sys/class/net/bond0.
1504
1505 This means that you can tell quickly whether or not an
1506 interface is enslaved by looking for the master symlink.  Thus:
1507 # echo -eth0 > /sys/class/net/eth0/master/bonding/slaves
1508 will free eth0 from whatever bond it is enslaved to, regardless of
1509 the name of the bond interface.
1510
1511 Changing a Bond's Configuration
1512 -------------------------------
1513 Each bond may be configured individually by manipulating the
1514 files located in /sys/class/net/<bond name>/bonding
1515
1516 The names of these files correspond directly with the command-
1517 line parameters described elsewhere in this file, and, with the
1518 exception of arp_ip_target, they accept the same values.  To see the
1519 current setting, simply cat the appropriate file.
1520
1521 A few examples will be given here; for specific usage
1522 guidelines for each parameter, see the appropriate section in this
1523 document.
1524
1525 To configure bond0 for balance-alb mode::
1526
1527         # ifconfig bond0 down
1528         # echo 6 > /sys/class/net/bond0/bonding/mode
1529         - or -
1530         # echo balance-alb > /sys/class/net/bond0/bonding/mode
1531
1532 .. note::
1533
1534    The bond interface must be down before the mode can be changed.
1535
1536 To enable MII monitoring on bond0 with a 1 second interval::
1537
1538         # echo 1000 > /sys/class/net/bond0/bonding/miimon
1539
1540 .. note::
1541
1542    If ARP monitoring is enabled, it will disabled when MII
1543    monitoring is enabled, and vice-versa.
1544
1545 To add ARP targets::
1546
1547         # echo +192.168.0.100 > /sys/class/net/bond0/bonding/arp_ip_target
1548         # echo +192.168.0.101 > /sys/class/net/bond0/bonding/arp_ip_target
1549
1550 .. note::
1551
1552    up to 16 target addresses may be specified.
1553
1554 To remove an ARP target::
1555
1556         # echo -192.168.0.100 > /sys/class/net/bond0/bonding/arp_ip_target
1557
1558 To configure the interval between learning packet transmits::
1559
1560         # echo 12 > /sys/class/net/bond0/bonding/lp_interval
1561
1562 .. note::
1563
1564    the lp_interval is the number of seconds between instances where
1565    the bonding driver sends learning packets to each slaves peer switch.  The
1566    default interval is 1 second.
1567
1568 Example Configuration
1569 ---------------------
1570 We begin with the same example that is shown in section 3.3,
1571 executed with sysfs, and without using ifenslave.
1572
1573 To make a simple bond of two e100 devices (presumed to be eth0
1574 and eth1), and have it persist across reboots, edit the appropriate
1575 file (/etc/init.d/boot.local or /etc/rc.d/rc.local), and add the
1576 following::
1577
1578         modprobe bonding
1579         modprobe e100
1580         echo balance-alb > /sys/class/net/bond0/bonding/mode
1581         ifconfig bond0 192.168.1.1 netmask 255.255.255.0 up
1582         echo 100 > /sys/class/net/bond0/bonding/miimon
1583         echo +eth0 > /sys/class/net/bond0/bonding/slaves
1584         echo +eth1 > /sys/class/net/bond0/bonding/slaves
1585
1586 To add a second bond, with two e1000 interfaces in
1587 active-backup mode, using ARP monitoring, add the following lines to
1588 your init script::
1589
1590         modprobe e1000
1591         echo +bond1 > /sys/class/net/bonding_masters
1592         echo active-backup > /sys/class/net/bond1/bonding/mode
1593         ifconfig bond1 192.168.2.1 netmask 255.255.255.0 up
1594         echo +192.168.2.100 /sys/class/net/bond1/bonding/arp_ip_target
1595         echo 2000 > /sys/class/net/bond1/bonding/arp_interval
1596         echo +eth2 > /sys/class/net/bond1/bonding/slaves
1597         echo +eth3 > /sys/class/net/bond1/bonding/slaves
1598
1599 3.5 Configuration with Interfaces Support
1600 -----------------------------------------
1601
1602 This section applies to distros which use /etc/network/interfaces file
1603 to describe network interface configuration, most notably Debian and it's
1604 derivatives.
1605
1606 The ifup and ifdown commands on Debian don't support bonding out of
1607 the box. The ifenslave-2.6 package should be installed to provide bonding
1608 support.  Once installed, this package will provide ``bond-*`` options
1609 to be used into /etc/network/interfaces.
1610
1611 Note that ifenslave-2.6 package will load the bonding module and use
1612 the ifenslave command when appropriate.
1613
1614 Example Configurations
1615 ----------------------
1616
1617 In /etc/network/interfaces, the following stanza will configure bond0, in
1618 active-backup mode, with eth0 and eth1 as slaves::
1619
1620         auto bond0
1621         iface bond0 inet dhcp
1622                 bond-slaves eth0 eth1
1623                 bond-mode active-backup
1624                 bond-miimon 100
1625                 bond-primary eth0 eth1
1626
1627 If the above configuration doesn't work, you might have a system using
1628 upstart for system startup. This is most notably true for recent
1629 Ubuntu versions. The following stanza in /etc/network/interfaces will
1630 produce the same result on those systems::
1631
1632         auto bond0
1633         iface bond0 inet dhcp
1634                 bond-slaves none
1635                 bond-mode active-backup
1636                 bond-miimon 100
1637
1638         auto eth0
1639         iface eth0 inet manual
1640                 bond-master bond0
1641                 bond-primary eth0 eth1
1642
1643         auto eth1
1644         iface eth1 inet manual
1645                 bond-master bond0
1646                 bond-primary eth0 eth1
1647
1648 For a full list of ``bond-*`` supported options in /etc/network/interfaces and
1649 some more advanced examples tailored to you particular distros, see the files in
1650 /usr/share/doc/ifenslave-2.6.
1651
1652 3.6 Overriding Configuration for Special Cases
1653 ----------------------------------------------
1654
1655 When using the bonding driver, the physical port which transmits a frame is
1656 typically selected by the bonding driver, and is not relevant to the user or
1657 system administrator.  The output port is simply selected using the policies of
1658 the selected bonding mode.  On occasion however, it is helpful to direct certain
1659 classes of traffic to certain physical interfaces on output to implement
1660 slightly more complex policies.  For example, to reach a web server over a
1661 bonded interface in which eth0 connects to a private network, while eth1
1662 connects via a public network, it may be desirous to bias the bond to send said
1663 traffic over eth0 first, using eth1 only as a fall back, while all other traffic
1664 can safely be sent over either interface.  Such configurations may be achieved
1665 using the traffic control utilities inherent in linux.
1666
1667 By default the bonding driver is multiqueue aware and 16 queues are created
1668 when the driver initializes (see Documentation/networking/multiqueue.rst
1669 for details).  If more or less queues are desired the module parameter
1670 tx_queues can be used to change this value.  There is no sysfs parameter
1671 available as the allocation is done at module init time.
1672
1673 The output of the file /proc/net/bonding/bondX has changed so the output Queue
1674 ID is now printed for each slave::
1675
1676         Bonding Mode: fault-tolerance (active-backup)
1677         Primary Slave: None
1678         Currently Active Slave: eth0
1679         MII Status: up
1680         MII Polling Interval (ms): 0
1681         Up Delay (ms): 0
1682         Down Delay (ms): 0
1683
1684         Slave Interface: eth0
1685         MII Status: up
1686         Link Failure Count: 0
1687         Permanent HW addr: 00:1a:a0:12:8f:cb
1688         Slave queue ID: 0
1689
1690         Slave Interface: eth1
1691         MII Status: up
1692         Link Failure Count: 0
1693         Permanent HW addr: 00:1a:a0:12:8f:cc
1694         Slave queue ID: 2
1695
1696 The queue_id for a slave can be set using the command::
1697
1698         # echo "eth1:2" > /sys/class/net/bond0/bonding/queue_id
1699
1700 Any interface that needs a queue_id set should set it with multiple calls
1701 like the one above until proper priorities are set for all interfaces.  On
1702 distributions that allow configuration via initscripts, multiple 'queue_id'
1703 arguments can be added to BONDING_OPTS to set all needed slave queues.
1704
1705 These queue id's can be used in conjunction with the tc utility to configure
1706 a multiqueue qdisc and filters to bias certain traffic to transmit on certain
1707 slave devices.  For instance, say we wanted, in the above configuration to
1708 force all traffic bound to 192.168.1.100 to use eth1 in the bond as its output
1709 device. The following commands would accomplish this::
1710
1711         # tc qdisc add dev bond0 handle 1 root multiq
1712
1713         # tc filter add dev bond0 protocol ip parent 1: prio 1 u32 match ip \
1714                 dst 192.168.1.100 action skbedit queue_mapping 2
1715
1716 These commands tell the kernel to attach a multiqueue queue discipline to the
1717 bond0 interface and filter traffic enqueued to it, such that packets with a dst
1718 ip of 192.168.1.100 have their output queue mapping value overwritten to 2.
1719 This value is then passed into the driver, causing the normal output path
1720 selection policy to be overridden, selecting instead qid 2, which maps to eth1.
1721
1722 Note that qid values begin at 1.  Qid 0 is reserved to initiate to the driver
1723 that normal output policy selection should take place.  One benefit to simply
1724 leaving the qid for a slave to 0 is the multiqueue awareness in the bonding
1725 driver that is now present.  This awareness allows tc filters to be placed on
1726 slave devices as well as bond devices and the bonding driver will simply act as
1727 a pass-through for selecting output queues on the slave device rather than
1728 output port selection.
1729
1730 This feature first appeared in bonding driver version 3.7.0 and support for
1731 output slave selection was limited to round-robin and active-backup modes.
1732
1733 3.7 Configuring LACP for 802.3ad mode in a more secure way
1734 ----------------------------------------------------------
1735
1736 When using 802.3ad bonding mode, the Actor (host) and Partner (switch)
1737 exchange LACPDUs.  These LACPDUs cannot be sniffed, because they are
1738 destined to link local mac addresses (which switches/bridges are not
1739 supposed to forward).  However, most of the values are easily predictable
1740 or are simply the machine's MAC address (which is trivially known to all
1741 other hosts in the same L2).  This implies that other machines in the L2
1742 domain can spoof LACPDU packets from other hosts to the switch and potentially
1743 cause mayhem by joining (from the point of view of the switch) another
1744 machine's aggregate, thus receiving a portion of that hosts incoming
1745 traffic and / or spoofing traffic from that machine themselves (potentially
1746 even successfully terminating some portion of flows). Though this is not
1747 a likely scenario, one could avoid this possibility by simply configuring
1748 few bonding parameters:
1749
1750    (a) ad_actor_system : You can set a random mac-address that can be used for
1751        these LACPDU exchanges. The value can not be either NULL or Multicast.
1752        Also it's preferable to set the local-admin bit. Following shell code
1753        generates a random mac-address as described above::
1754
1755               # sys_mac_addr=$(printf '%02x:%02x:%02x:%02x:%02x:%02x' \
1756                                        $(( (RANDOM & 0xFE) | 0x02 )) \
1757                                        $(( RANDOM & 0xFF )) \
1758                                        $(( RANDOM & 0xFF )) \
1759                                        $(( RANDOM & 0xFF )) \
1760                                        $(( RANDOM & 0xFF )) \
1761                                        $(( RANDOM & 0xFF )))
1762               # echo $sys_mac_addr > /sys/class/net/bond0/bonding/ad_actor_system
1763
1764    (b) ad_actor_sys_prio : Randomize the system priority. The default value
1765        is 65535, but system can take the value from 1 - 65535. Following shell
1766        code generates random priority and sets it::
1767
1768             # sys_prio=$(( 1 + RANDOM + RANDOM ))
1769             # echo $sys_prio > /sys/class/net/bond0/bonding/ad_actor_sys_prio
1770
1771    (c) ad_user_port_key : Use the user portion of the port-key. The default
1772        keeps this empty. These are the upper 10 bits of the port-key and value
1773        ranges from 0 - 1023. Following shell code generates these 10 bits and
1774        sets it::
1775
1776             # usr_port_key=$(( RANDOM & 0x3FF ))
1777             # echo $usr_port_key > /sys/class/net/bond0/bonding/ad_user_port_key
1778
1779
1780 4 Querying Bonding Configuration
1781 =================================
1782
1783 4.1 Bonding Configuration
1784 -------------------------
1785
1786 Each bonding device has a read-only file residing in the
1787 /proc/net/bonding directory.  The file contents include information
1788 about the bonding configuration, options and state of each slave.
1789
1790 For example, the contents of /proc/net/bonding/bond0 after the
1791 driver is loaded with parameters of mode=0 and miimon=1000 is
1792 generally as follows::
1793
1794         Ethernet Channel Bonding Driver: 2.6.1 (October 29, 2004)
1795         Bonding Mode: load balancing (round-robin)
1796         Currently Active Slave: eth0
1797         MII Status: up
1798         MII Polling Interval (ms): 1000
1799         Up Delay (ms): 0
1800         Down Delay (ms): 0
1801
1802         Slave Interface: eth1
1803         MII Status: up
1804         Link Failure Count: 1
1805
1806         Slave Interface: eth0
1807         MII Status: up
1808         Link Failure Count: 1
1809
1810 The precise format and contents will change depending upon the
1811 bonding configuration, state, and version of the bonding driver.
1812
1813 4.2 Network configuration
1814 -------------------------
1815
1816 The network configuration can be inspected using the ifconfig
1817 command.  Bonding devices will have the MASTER flag set; Bonding slave
1818 devices will have the SLAVE flag set.  The ifconfig output does not
1819 contain information on which slaves are associated with which masters.
1820
1821 In the example below, the bond0 interface is the master
1822 (MASTER) while eth0 and eth1 are slaves (SLAVE). Notice all slaves of
1823 bond0 have the same MAC address (HWaddr) as bond0 for all modes except
1824 TLB and ALB that require a unique MAC address for each slave::
1825
1826   # /sbin/ifconfig
1827   bond0     Link encap:Ethernet  HWaddr 00:C0:F0:1F:37:B4
1828             inet addr:XXX.XXX.XXX.YYY  Bcast:XXX.XXX.XXX.255  Mask:255.255.252.0
1829             UP BROADCAST RUNNING MASTER MULTICAST  MTU:1500  Metric:1
1830             RX packets:7224794 errors:0 dropped:0 overruns:0 frame:0
1831             TX packets:3286647 errors:1 dropped:0 overruns:1 carrier:0
1832             collisions:0 txqueuelen:0
1833
1834   eth0      Link encap:Ethernet  HWaddr 00:C0:F0:1F:37:B4
1835             UP BROADCAST RUNNING SLAVE MULTICAST  MTU:1500  Metric:1
1836             RX packets:3573025 errors:0 dropped:0 overruns:0 frame:0
1837             TX packets:1643167 errors:1 dropped:0 overruns:1 carrier:0
1838             collisions:0 txqueuelen:100
1839             Interrupt:10 Base address:0x1080
1840
1841   eth1      Link encap:Ethernet  HWaddr 00:C0:F0:1F:37:B4
1842             UP BROADCAST RUNNING SLAVE MULTICAST  MTU:1500  Metric:1
1843             RX packets:3651769 errors:0 dropped:0 overruns:0 frame:0
1844             TX packets:1643480 errors:0 dropped:0 overruns:0 carrier:0
1845             collisions:0 txqueuelen:100
1846             Interrupt:9 Base address:0x1400
1847
1848 5. Switch Configuration
1849 =======================
1850
1851 For this section, "switch" refers to whatever system the
1852 bonded devices are directly connected to (i.e., where the other end of
1853 the cable plugs into).  This may be an actual dedicated switch device,
1854 or it may be another regular system (e.g., another computer running
1855 Linux),
1856
1857 The active-backup, balance-tlb and balance-alb modes do not
1858 require any specific configuration of the switch.
1859
1860 The 802.3ad mode requires that the switch have the appropriate
1861 ports configured as an 802.3ad aggregation.  The precise method used
1862 to configure this varies from switch to switch, but, for example, a
1863 Cisco 3550 series switch requires that the appropriate ports first be
1864 grouped together in a single etherchannel instance, then that
1865 etherchannel is set to mode "lacp" to enable 802.3ad (instead of
1866 standard EtherChannel).
1867
1868 The balance-rr, balance-xor and broadcast modes generally
1869 require that the switch have the appropriate ports grouped together.
1870 The nomenclature for such a group differs between switches, it may be
1871 called an "etherchannel" (as in the Cisco example, above), a "trunk
1872 group" or some other similar variation.  For these modes, each switch
1873 will also have its own configuration options for the switch's transmit
1874 policy to the bond.  Typical choices include XOR of either the MAC or
1875 IP addresses.  The transmit policy of the two peers does not need to
1876 match.  For these three modes, the bonding mode really selects a
1877 transmit policy for an EtherChannel group; all three will interoperate
1878 with another EtherChannel group.
1879
1880
1881 6. 802.1q VLAN Support
1882 ======================
1883
1884 It is possible to configure VLAN devices over a bond interface
1885 using the 8021q driver.  However, only packets coming from the 8021q
1886 driver and passing through bonding will be tagged by default.  Self
1887 generated packets, for example, bonding's learning packets or ARP
1888 packets generated by either ALB mode or the ARP monitor mechanism, are
1889 tagged internally by bonding itself.  As a result, bonding must
1890 "learn" the VLAN IDs configured above it, and use those IDs to tag
1891 self generated packets.
1892
1893 For reasons of simplicity, and to support the use of adapters
1894 that can do VLAN hardware acceleration offloading, the bonding
1895 interface declares itself as fully hardware offloading capable, it gets
1896 the add_vid/kill_vid notifications to gather the necessary
1897 information, and it propagates those actions to the slaves.  In case
1898 of mixed adapter types, hardware accelerated tagged packets that
1899 should go through an adapter that is not offloading capable are
1900 "un-accelerated" by the bonding driver so the VLAN tag sits in the
1901 regular location.
1902
1903 VLAN interfaces *must* be added on top of a bonding interface
1904 only after enslaving at least one slave.  The bonding interface has a
1905 hardware address of 00:00:00:00:00:00 until the first slave is added.
1906 If the VLAN interface is created prior to the first enslavement, it
1907 would pick up the all-zeroes hardware address.  Once the first slave
1908 is attached to the bond, the bond device itself will pick up the
1909 slave's hardware address, which is then available for the VLAN device.
1910
1911 Also, be aware that a similar problem can occur if all slaves
1912 are released from a bond that still has one or more VLAN interfaces on
1913 top of it.  When a new slave is added, the bonding interface will
1914 obtain its hardware address from the first slave, which might not
1915 match the hardware address of the VLAN interfaces (which was
1916 ultimately copied from an earlier slave).
1917
1918 There are two methods to insure that the VLAN device operates
1919 with the correct hardware address if all slaves are removed from a
1920 bond interface:
1921
1922 1. Remove all VLAN interfaces then recreate them
1923
1924 2. Set the bonding interface's hardware address so that it
1925 matches the hardware address of the VLAN interfaces.
1926
1927 Note that changing a VLAN interface's HW address would set the
1928 underlying device -- i.e. the bonding interface -- to promiscuous
1929 mode, which might not be what you want.
1930
1931
1932 7. Link Monitoring
1933 ==================
1934
1935 The bonding driver at present supports two schemes for
1936 monitoring a slave device's link state: the ARP monitor and the MII
1937 monitor.
1938
1939 At the present time, due to implementation restrictions in the
1940 bonding driver itself, it is not possible to enable both ARP and MII
1941 monitoring simultaneously.
1942
1943 7.1 ARP Monitor Operation
1944 -------------------------
1945
1946 The ARP monitor operates as its name suggests: it sends ARP
1947 queries to one or more designated peer systems on the network, and
1948 uses the response as an indication that the link is operating.  This
1949 gives some assurance that traffic is actually flowing to and from one
1950 or more peers on the local network.
1951
1952 The ARP monitor relies on the device driver itself to verify
1953 that traffic is flowing.  In particular, the driver must keep up to
1954 date the last receive time, dev->last_rx.  Drivers that use NETIF_F_LLTX
1955 flag must also update netdev_queue->trans_start.  If they do not, then the
1956 ARP monitor will immediately fail any slaves using that driver, and
1957 those slaves will stay down.  If networking monitoring (tcpdump, etc)
1958 shows the ARP requests and replies on the network, then it may be that
1959 your device driver is not updating last_rx and trans_start.
1960
1961 7.2 Configuring Multiple ARP Targets
1962 ------------------------------------
1963
1964 While ARP monitoring can be done with just one target, it can
1965 be useful in a High Availability setup to have several targets to
1966 monitor.  In the case of just one target, the target itself may go
1967 down or have a problem making it unresponsive to ARP requests.  Having
1968 an additional target (or several) increases the reliability of the ARP
1969 monitoring.
1970
1971 Multiple ARP targets must be separated by commas as follows::
1972
1973  # example options for ARP monitoring with three targets
1974  alias bond0 bonding
1975  options bond0 arp_interval=60 arp_ip_target=192.168.0.1,192.168.0.3,192.168.0.9
1976
1977 For just a single target the options would resemble::
1978
1979     # example options for ARP monitoring with one target
1980     alias bond0 bonding
1981     options bond0 arp_interval=60 arp_ip_target=192.168.0.100
1982
1983
1984 7.3 MII Monitor Operation
1985 -------------------------
1986
1987 The MII monitor monitors only the carrier state of the local
1988 network interface.  It accomplishes this in one of three ways: by
1989 depending upon the device driver to maintain its carrier state, by
1990 querying the device's MII registers, or by making an ethtool query to
1991 the device.
1992
1993 If the use_carrier module parameter is 1 (the default value),
1994 then the MII monitor will rely on the driver for carrier state
1995 information (via the netif_carrier subsystem).  As explained in the
1996 use_carrier parameter information, above, if the MII monitor fails to
1997 detect carrier loss on the device (e.g., when the cable is physically
1998 disconnected), it may be that the driver does not support
1999 netif_carrier.
2000
2001 If use_carrier is 0, then the MII monitor will first query the
2002 device's (via ioctl) MII registers and check the link state.  If that
2003 request fails (not just that it returns carrier down), then the MII
2004 monitor will make an ethtool ETHTOOL_GLINK request to attempt to obtain
2005 the same information.  If both methods fail (i.e., the driver either
2006 does not support or had some error in processing both the MII register
2007 and ethtool requests), then the MII monitor will assume the link is
2008 up.
2009
2010 8. Potential Sources of Trouble
2011 ===============================
2012
2013 8.1 Adventures in Routing
2014 -------------------------
2015
2016 When bonding is configured, it is important that the slave
2017 devices not have routes that supersede routes of the master (or,
2018 generally, not have routes at all).  For example, suppose the bonding
2019 device bond0 has two slaves, eth0 and eth1, and the routing table is
2020 as follows::
2021
2022   Kernel IP routing table
2023   Destination     Gateway         Genmask         Flags   MSS Window  irtt Iface
2024   10.0.0.0        0.0.0.0         255.255.0.0     U        40 0          0 eth0
2025   10.0.0.0        0.0.0.0         255.255.0.0     U        40 0          0 eth1
2026   10.0.0.0        0.0.0.0         255.255.0.0     U        40 0          0 bond0
2027   127.0.0.0       0.0.0.0         255.0.0.0       U        40 0          0 lo
2028
2029 This routing configuration will likely still update the
2030 receive/transmit times in the driver (needed by the ARP monitor), but
2031 may bypass the bonding driver (because outgoing traffic to, in this
2032 case, another host on network 10 would use eth0 or eth1 before bond0).
2033
2034 The ARP monitor (and ARP itself) may become confused by this
2035 configuration, because ARP requests (generated by the ARP monitor)
2036 will be sent on one interface (bond0), but the corresponding reply
2037 will arrive on a different interface (eth0).  This reply looks to ARP
2038 as an unsolicited ARP reply (because ARP matches replies on an
2039 interface basis), and is discarded.  The MII monitor is not affected
2040 by the state of the routing table.
2041
2042 The solution here is simply to insure that slaves do not have
2043 routes of their own, and if for some reason they must, those routes do
2044 not supersede routes of their master.  This should generally be the
2045 case, but unusual configurations or errant manual or automatic static
2046 route additions may cause trouble.
2047
2048 8.2 Ethernet Device Renaming
2049 ----------------------------
2050
2051 On systems with network configuration scripts that do not
2052 associate physical devices directly with network interface names (so
2053 that the same physical device always has the same "ethX" name), it may
2054 be necessary to add some special logic to config files in
2055 /etc/modprobe.d/.
2056
2057 For example, given a modules.conf containing the following::
2058
2059         alias bond0 bonding
2060         options bond0 mode=some-mode miimon=50
2061         alias eth0 tg3
2062         alias eth1 tg3
2063         alias eth2 e1000
2064         alias eth3 e1000
2065
2066 If neither eth0 and eth1 are slaves to bond0, then when the
2067 bond0 interface comes up, the devices may end up reordered.  This
2068 happens because bonding is loaded first, then its slave device's
2069 drivers are loaded next.  Since no other drivers have been loaded,
2070 when the e1000 driver loads, it will receive eth0 and eth1 for its
2071 devices, but the bonding configuration tries to enslave eth2 and eth3
2072 (which may later be assigned to the tg3 devices).
2073
2074 Adding the following::
2075
2076         add above bonding e1000 tg3
2077
2078 causes modprobe to load e1000 then tg3, in that order, when
2079 bonding is loaded.  This command is fully documented in the
2080 modules.conf manual page.
2081
2082 On systems utilizing modprobe an equivalent problem can occur.
2083 In this case, the following can be added to config files in
2084 /etc/modprobe.d/ as::
2085
2086         softdep bonding pre: tg3 e1000
2087
2088 This will load tg3 and e1000 modules before loading the bonding one.
2089 Full documentation on this can be found in the modprobe.d and modprobe
2090 manual pages.
2091
2092 8.3. Painfully Slow Or No Failed Link Detection By Miimon
2093 ---------------------------------------------------------
2094
2095 By default, bonding enables the use_carrier option, which
2096 instructs bonding to trust the driver to maintain carrier state.
2097
2098 As discussed in the options section, above, some drivers do
2099 not support the netif_carrier_on/_off link state tracking system.
2100 With use_carrier enabled, bonding will always see these links as up,
2101 regardless of their actual state.
2102
2103 Additionally, other drivers do support netif_carrier, but do
2104 not maintain it in real time, e.g., only polling the link state at
2105 some fixed interval.  In this case, miimon will detect failures, but
2106 only after some long period of time has expired.  If it appears that
2107 miimon is very slow in detecting link failures, try specifying
2108 use_carrier=0 to see if that improves the failure detection time.  If
2109 it does, then it may be that the driver checks the carrier state at a
2110 fixed interval, but does not cache the MII register values (so the
2111 use_carrier=0 method of querying the registers directly works).  If
2112 use_carrier=0 does not improve the failover, then the driver may cache
2113 the registers, or the problem may be elsewhere.
2114
2115 Also, remember that miimon only checks for the device's
2116 carrier state.  It has no way to determine the state of devices on or
2117 beyond other ports of a switch, or if a switch is refusing to pass
2118 traffic while still maintaining carrier on.
2119
2120 9. SNMP agents
2121 ===============
2122
2123 If running SNMP agents, the bonding driver should be loaded
2124 before any network drivers participating in a bond.  This requirement
2125 is due to the interface index (ipAdEntIfIndex) being associated to
2126 the first interface found with a given IP address.  That is, there is
2127 only one ipAdEntIfIndex for each IP address.  For example, if eth0 and
2128 eth1 are slaves of bond0 and the driver for eth0 is loaded before the
2129 bonding driver, the interface for the IP address will be associated
2130 with the eth0 interface.  This configuration is shown below, the IP
2131 address 192.168.1.1 has an interface index of 2 which indexes to eth0
2132 in the ifDescr table (ifDescr.2).
2133
2134 ::
2135
2136      interfaces.ifTable.ifEntry.ifDescr.1 = lo
2137      interfaces.ifTable.ifEntry.ifDescr.2 = eth0
2138      interfaces.ifTable.ifEntry.ifDescr.3 = eth1
2139      interfaces.ifTable.ifEntry.ifDescr.4 = eth2
2140      interfaces.ifTable.ifEntry.ifDescr.5 = eth3
2141      interfaces.ifTable.ifEntry.ifDescr.6 = bond0
2142      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.10.10.10.10 = 5
2143      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.192.168.1.1 = 2
2144      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.10.74.20.94 = 4
2145      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.127.0.0.1 = 1
2146
2147 This problem is avoided by loading the bonding driver before
2148 any network drivers participating in a bond.  Below is an example of
2149 loading the bonding driver first, the IP address 192.168.1.1 is
2150 correctly associated with ifDescr.2.
2151
2152      interfaces.ifTable.ifEntry.ifDescr.1 = lo
2153      interfaces.ifTable.ifEntry.ifDescr.2 = bond0
2154      interfaces.ifTable.ifEntry.ifDescr.3 = eth0
2155      interfaces.ifTable.ifEntry.ifDescr.4 = eth1
2156      interfaces.ifTable.ifEntry.ifDescr.5 = eth2
2157      interfaces.ifTable.ifEntry.ifDescr.6 = eth3
2158      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.10.10.10.10 = 6
2159      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.192.168.1.1 = 2
2160      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.10.74.20.94 = 5
2161      ip.ipAddrTable.ipAddrEntry.ipAdEntIfIndex.127.0.0.1 = 1
2162
2163 While some distributions may not report the interface name in
2164 ifDescr, the association between the IP address and IfIndex remains
2165 and SNMP functions such as Interface_Scan_Next will report that
2166 association.
2167
2168 10. Promiscuous mode
2169 ====================
2170
2171 When running network monitoring tools, e.g., tcpdump, it is
2172 common to enable promiscuous mode on the device, so that all traffic
2173 is seen (instead of seeing only traffic destined for the local host).
2174 The bonding driver handles promiscuous mode changes to the bonding
2175 master device (e.g., bond0), and propagates the setting to the slave
2176 devices.
2177
2178 For the balance-rr, balance-xor, broadcast, and 802.3ad modes,
2179 the promiscuous mode setting is propagated to all slaves.
2180
2181 For the active-backup, balance-tlb and balance-alb modes, the
2182 promiscuous mode setting is propagated only to the active slave.
2183
2184 For balance-tlb mode, the active slave is the slave currently
2185 receiving inbound traffic.
2186
2187 For balance-alb mode, the active slave is the slave used as a
2188 "primary."  This slave is used for mode-specific control traffic, for
2189 sending to peers that are unassigned or if the load is unbalanced.
2190
2191 For the active-backup, balance-tlb and balance-alb modes, when
2192 the active slave changes (e.g., due to a link failure), the
2193 promiscuous setting will be propagated to the new active slave.
2194
2195 11. Configuring Bonding for High Availability
2196 =============================================
2197
2198 High Availability refers to configurations that provide
2199 maximum network availability by having redundant or backup devices,
2200 links or switches between the host and the rest of the world.  The
2201 goal is to provide the maximum availability of network connectivity
2202 (i.e., the network always works), even though other configurations
2203 could provide higher throughput.
2204
2205 11.1 High Availability in a Single Switch Topology
2206 --------------------------------------------------
2207
2208 If two hosts (or a host and a single switch) are directly
2209 connected via multiple physical links, then there is no availability
2210 penalty to optimizing for maximum bandwidth.  In this case, there is
2211 only one switch (or peer), so if it fails, there is no alternative
2212 access to fail over to.  Additionally, the bonding load balance modes
2213 support link monitoring of their members, so if individual links fail,
2214 the load will be rebalanced across the remaining devices.
2215
2216 See Section 12, "Configuring Bonding for Maximum Throughput"
2217 for information on configuring bonding with one peer device.
2218
2219 11.2 High Availability in a Multiple Switch Topology
2220 ----------------------------------------------------
2221
2222 With multiple switches, the configuration of bonding and the
2223 network changes dramatically.  In multiple switch topologies, there is
2224 a trade off between network availability and usable bandwidth.
2225
2226 Below is a sample network, configured to maximize the
2227 availability of the network::
2228
2229                 |                                     |
2230                 |port3                           port3|
2231           +-----+----+                          +-----+----+
2232           |          |port2       ISL      port2|          |
2233           | switch A +--------------------------+ switch B |
2234           |          |                          |          |
2235           +-----+----+                          +-----++---+
2236                 |port1                           port1|
2237                 |             +-------+               |
2238                 +-------------+ host1 +---------------+
2239                          eth0 +-------+ eth1
2240
2241 In this configuration, there is a link between the two
2242 switches (ISL, or inter switch link), and multiple ports connecting to
2243 the outside world ("port3" on each switch).  There is no technical
2244 reason that this could not be extended to a third switch.
2245
2246 11.2.1 HA Bonding Mode Selection for Multiple Switch Topology
2247 -------------------------------------------------------------
2248
2249 In a topology such as the example above, the active-backup and
2250 broadcast modes are the only useful bonding modes when optimizing for
2251 availability; the other modes require all links to terminate on the
2252 same peer for them to behave rationally.
2253
2254 active-backup:
2255         This is generally the preferred mode, particularly if
2256         the switches have an ISL and play together well.  If the
2257         network configuration is such that one switch is specifically
2258         a backup switch (e.g., has lower capacity, higher cost, etc),
2259         then the primary option can be used to insure that the
2260         preferred link is always used when it is available.
2261
2262 broadcast:
2263         This mode is really a special purpose mode, and is suitable
2264         only for very specific needs.  For example, if the two
2265         switches are not connected (no ISL), and the networks beyond
2266         them are totally independent.  In this case, if it is
2267         necessary for some specific one-way traffic to reach both
2268         independent networks, then the broadcast mode may be suitable.
2269
2270 11.2.2 HA Link Monitoring Selection for Multiple Switch Topology
2271 ----------------------------------------------------------------
2272
2273 The choice of link monitoring ultimately depends upon your
2274 switch.  If the switch can reliably fail ports in response to other
2275 failures, then either the MII or ARP monitors should work.  For
2276 example, in the above example, if the "port3" link fails at the remote
2277 end, the MII monitor has no direct means to detect this.  The ARP
2278 monitor could be configured with a target at the remote end of port3,
2279 thus detecting that failure without switch support.
2280
2281 In general, however, in a multiple switch topology, the ARP
2282 monitor can provide a higher level of reliability in detecting end to
2283 end connectivity failures (which may be caused by the failure of any
2284 individual component to pass traffic for any reason).  Additionally,
2285 the ARP monitor should be configured with multiple targets (at least
2286 one for each switch in the network).  This will insure that,
2287 regardless of which switch is active, the ARP monitor has a suitable
2288 target to query.
2289
2290 Note, also, that of late many switches now support a functionality
2291 generally referred to as "trunk failover."  This is a feature of the
2292 switch that causes the link state of a particular switch port to be set
2293 down (or up) when the state of another switch port goes down (or up).
2294 Its purpose is to propagate link failures from logically "exterior" ports
2295 to the logically "interior" ports that bonding is able to monitor via
2296 miimon.  Availability and configuration for trunk failover varies by
2297 switch, but this can be a viable alternative to the ARP monitor when using
2298 suitable switches.
2299
2300 12. Configuring Bonding for Maximum Throughput
2301 ==============================================
2302
2303 12.1 Maximizing Throughput in a Single Switch Topology
2304 ------------------------------------------------------
2305
2306 In a single switch configuration, the best method to maximize
2307 throughput depends upon the application and network environment.  The
2308 various load balancing modes each have strengths and weaknesses in
2309 different environments, as detailed below.
2310
2311 For this discussion, we will break down the topologies into
2312 two categories.  Depending upon the destination of most traffic, we
2313 categorize them into either "gatewayed" or "local" configurations.
2314
2315 In a gatewayed configuration, the "switch" is acting primarily
2316 as a router, and the majority of traffic passes through this router to
2317 other networks.  An example would be the following::
2318
2319
2320      +----------+                     +----------+
2321      |          |eth0            port1|          | to other networks
2322      | Host A   +---------------------+ router   +------------------->
2323      |          +---------------------+          | Hosts B and C are out
2324      |          |eth1            port2|          | here somewhere
2325      +----------+                     +----------+
2326
2327 The router may be a dedicated router device, or another host
2328 acting as a gateway.  For our discussion, the important point is that
2329 the majority of traffic from Host A will pass through the router to
2330 some other network before reaching its final destination.
2331
2332 In a gatewayed network configuration, although Host A may
2333 communicate with many other systems, all of its traffic will be sent
2334 and received via one other peer on the local network, the router.
2335
2336 Note that the case of two systems connected directly via
2337 multiple physical links is, for purposes of configuring bonding, the
2338 same as a gatewayed configuration.  In that case, it happens that all
2339 traffic is destined for the "gateway" itself, not some other network
2340 beyond the gateway.
2341
2342 In a local configuration, the "switch" is acting primarily as
2343 a switch, and the majority of traffic passes through this switch to
2344 reach other stations on the same network.  An example would be the
2345 following::
2346
2347     +----------+            +----------+       +--------+
2348     |          |eth0   port1|          +-------+ Host B |
2349     |  Host A  +------------+  switch  |port3  +--------+
2350     |          +------------+          |                  +--------+
2351     |          |eth1   port2|          +------------------+ Host C |
2352     +----------+            +----------+port4             +--------+
2353
2354
2355 Again, the switch may be a dedicated switch device, or another
2356 host acting as a gateway.  For our discussion, the important point is
2357 that the majority of traffic from Host A is destined for other hosts
2358 on the same local network (Hosts B and C in the above example).
2359
2360 In summary, in a gatewayed configuration, traffic to and from
2361 the bonded device will be to the same MAC level peer on the network
2362 (the gateway itself, i.e., the router), regardless of its final
2363 destination.  In a local configuration, traffic flows directly to and
2364 from the final destinations, thus, each destination (Host B, Host C)
2365 will be addressed directly by their individual MAC addresses.
2366
2367 This distinction between a gatewayed and a local network
2368 configuration is important because many of the load balancing modes
2369 available use the MAC addresses of the local network source and
2370 destination to make load balancing decisions.  The behavior of each
2371 mode is described below.
2372
2373
2374 12.1.1 MT Bonding Mode Selection for Single Switch Topology
2375 -----------------------------------------------------------
2376
2377 This configuration is the easiest to set up and to understand,
2378 although you will have to decide which bonding mode best suits your
2379 needs.  The trade offs for each mode are detailed below:
2380
2381 balance-rr:
2382         This mode is the only mode that will permit a single
2383         TCP/IP connection to stripe traffic across multiple
2384         interfaces. It is therefore the only mode that will allow a
2385         single TCP/IP stream to utilize more than one interface's
2386         worth of throughput.  This comes at a cost, however: the
2387         striping generally results in peer systems receiving packets out
2388         of order, causing TCP/IP's congestion control system to kick
2389         in, often by retransmitting segments.
2390
2391         It is possible to adjust TCP/IP's congestion limits by
2392         altering the net.ipv4.tcp_reordering sysctl parameter.  The
2393         usual default value is 3. But keep in mind TCP stack is able
2394         to automatically increase this when it detects reorders.
2395
2396         Note that the fraction of packets that will be delivered out of
2397         order is highly variable, and is unlikely to be zero.  The level
2398         of reordering depends upon a variety of factors, including the
2399         networking interfaces, the switch, and the topology of the
2400         configuration.  Speaking in general terms, higher speed network
2401         cards produce more reordering (due to factors such as packet
2402         coalescing), and a "many to many" topology will reorder at a
2403         higher rate than a "many slow to one fast" configuration.
2404
2405         Many switches do not support any modes that stripe traffic
2406         (instead choosing a port based upon IP or MAC level addresses);
2407         for those devices, traffic for a particular connection flowing
2408         through the switch to a balance-rr bond will not utilize greater
2409         than one interface's worth of bandwidth.
2410
2411         If you are utilizing protocols other than TCP/IP, UDP for
2412         example, and your application can tolerate out of order
2413         delivery, then this mode can allow for single stream datagram
2414         performance that scales near linearly as interfaces are added
2415         to the bond.
2416
2417         This mode requires the switch to have the appropriate ports
2418         configured for "etherchannel" or "trunking."
2419
2420 active-backup:
2421         There is not much advantage in this network topology to
2422         the active-backup mode, as the inactive backup devices are all
2423         connected to the same peer as the primary.  In this case, a
2424         load balancing mode (with link monitoring) will provide the
2425         same level of network availability, but with increased
2426         available bandwidth.  On the plus side, active-backup mode
2427         does not require any configuration of the switch, so it may
2428         have value if the hardware available does not support any of
2429         the load balance modes.
2430
2431 balance-xor:
2432         This mode will limit traffic such that packets destined
2433         for specific peers will always be sent over the same
2434         interface.  Since the destination is determined by the MAC
2435         addresses involved, this mode works best in a "local" network
2436         configuration (as described above), with destinations all on
2437         the same local network.  This mode is likely to be suboptimal
2438         if all your traffic is passed through a single router (i.e., a
2439         "gatewayed" network configuration, as described above).
2440
2441         As with balance-rr, the switch ports need to be configured for
2442         "etherchannel" or "trunking."
2443
2444 broadcast:
2445         Like active-backup, there is not much advantage to this
2446         mode in this type of network topology.
2447
2448 802.3ad:
2449         This mode can be a good choice for this type of network
2450         topology.  The 802.3ad mode is an IEEE standard, so all peers
2451         that implement 802.3ad should interoperate well.  The 802.3ad
2452         protocol includes automatic configuration of the aggregates,
2453         so minimal manual configuration of the switch is needed
2454         (typically only to designate that some set of devices is
2455         available for 802.3ad).  The 802.3ad standard also mandates
2456         that frames be delivered in order (within certain limits), so
2457         in general single connections will not see misordering of
2458         packets.  The 802.3ad mode does have some drawbacks: the
2459         standard mandates that all devices in the aggregate operate at
2460         the same speed and duplex.  Also, as with all bonding load
2461         balance modes other than balance-rr, no single connection will
2462         be able to utilize more than a single interface's worth of
2463         bandwidth.
2464
2465         Additionally, the linux bonding 802.3ad implementation
2466         distributes traffic by peer (using an XOR of MAC addresses
2467         and packet type ID), so in a "gatewayed" configuration, all
2468         outgoing traffic will generally use the same device.  Incoming
2469         traffic may also end up on a single device, but that is
2470         dependent upon the balancing policy of the peer's 802.3ad
2471         implementation.  In a "local" configuration, traffic will be
2472         distributed across the devices in the bond.
2473
2474         Finally, the 802.3ad mode mandates the use of the MII monitor,
2475         therefore, the ARP monitor is not available in this mode.
2476
2477 balance-tlb:
2478         The balance-tlb mode balances outgoing traffic by peer.
2479         Since the balancing is done according to MAC address, in a
2480         "gatewayed" configuration (as described above), this mode will
2481         send all traffic across a single device.  However, in a
2482         "local" network configuration, this mode balances multiple
2483         local network peers across devices in a vaguely intelligent
2484         manner (not a simple XOR as in balance-xor or 802.3ad mode),
2485         so that mathematically unlucky MAC addresses (i.e., ones that
2486         XOR to the same value) will not all "bunch up" on a single
2487         interface.
2488
2489         Unlike 802.3ad, interfaces may be of differing speeds, and no
2490         special switch configuration is required.  On the down side,
2491         in this mode all incoming traffic arrives over a single
2492         interface, this mode requires certain ethtool support in the
2493         network device driver of the slave interfaces, and the ARP
2494         monitor is not available.
2495
2496 balance-alb:
2497         This mode is everything that balance-tlb is, and more.
2498         It has all of the features (and restrictions) of balance-tlb,
2499         and will also balance incoming traffic from local network
2500         peers (as described in the Bonding Module Options section,
2501         above).
2502
2503         The only additional down side to this mode is that the network
2504         device driver must support changing the hardware address while
2505         the device is open.
2506
2507 12.1.2 MT Link Monitoring for Single Switch Topology
2508 ----------------------------------------------------
2509
2510 The choice of link monitoring may largely depend upon which
2511 mode you choose to use.  The more advanced load balancing modes do not
2512 support the use of the ARP monitor, and are thus restricted to using
2513 the MII monitor (which does not provide as high a level of end to end
2514 assurance as the ARP monitor).
2515
2516 12.2 Maximum Throughput in a Multiple Switch Topology
2517 -----------------------------------------------------
2518
2519 Multiple switches may be utilized to optimize for throughput
2520 when they are configured in parallel as part of an isolated network
2521 between two or more systems, for example::
2522
2523                        +-----------+
2524                        |  Host A   |
2525                        +-+---+---+-+
2526                          |   |   |
2527                 +--------+   |   +---------+
2528                 |            |             |
2529          +------+---+  +-----+----+  +-----+----+
2530          | Switch A |  | Switch B |  | Switch C |
2531          +------+---+  +-----+----+  +-----+----+
2532                 |            |             |
2533                 +--------+   |   +---------+
2534                          |   |   |
2535                        +-+---+---+-+
2536                        |  Host B   |
2537                        +-----------+
2538
2539 In this configuration, the switches are isolated from one
2540 another.  One reason to employ a topology such as this is for an
2541 isolated network with many hosts (a cluster configured for high
2542 performance, for example), using multiple smaller switches can be more
2543 cost effective than a single larger switch, e.g., on a network with 24
2544 hosts, three 24 port switches can be significantly less expensive than
2545 a single 72 port switch.
2546
2547 If access beyond the network is required, an individual host
2548 can be equipped with an additional network device connected to an
2549 external network; this host then additionally acts as a gateway.
2550
2551 12.2.1 MT Bonding Mode Selection for Multiple Switch Topology
2552 -------------------------------------------------------------
2553
2554 In actual practice, the bonding mode typically employed in
2555 configurations of this type is balance-rr.  Historically, in this
2556 network configuration, the usual caveats about out of order packet
2557 delivery are mitigated by the use of network adapters that do not do
2558 any kind of packet coalescing (via the use of NAPI, or because the
2559 device itself does not generate interrupts until some number of
2560 packets has arrived).  When employed in this fashion, the balance-rr
2561 mode allows individual connections between two hosts to effectively
2562 utilize greater than one interface's bandwidth.
2563
2564 12.2.2 MT Link Monitoring for Multiple Switch Topology
2565 ------------------------------------------------------
2566
2567 Again, in actual practice, the MII monitor is most often used
2568 in this configuration, as performance is given preference over
2569 availability.  The ARP monitor will function in this topology, but its
2570 advantages over the MII monitor are mitigated by the volume of probes
2571 needed as the number of systems involved grows (remember that each
2572 host in the network is configured with bonding).
2573
2574 13. Switch Behavior Issues
2575 ==========================
2576
2577 13.1 Link Establishment and Failover Delays
2578 -------------------------------------------
2579
2580 Some switches exhibit undesirable behavior with regard to the
2581 timing of link up and down reporting by the switch.
2582
2583 First, when a link comes up, some switches may indicate that
2584 the link is up (carrier available), but not pass traffic over the
2585 interface for some period of time.  This delay is typically due to
2586 some type of autonegotiation or routing protocol, but may also occur
2587 during switch initialization (e.g., during recovery after a switch
2588 failure).  If you find this to be a problem, specify an appropriate
2589 value to the updelay bonding module option to delay the use of the
2590 relevant interface(s).
2591
2592 Second, some switches may "bounce" the link state one or more
2593 times while a link is changing state.  This occurs most commonly while
2594 the switch is initializing.  Again, an appropriate updelay value may
2595 help.
2596
2597 Note that when a bonding interface has no active links, the
2598 driver will immediately reuse the first link that goes up, even if the
2599 updelay parameter has been specified (the updelay is ignored in this
2600 case).  If there are slave interfaces waiting for the updelay timeout
2601 to expire, the interface that first went into that state will be
2602 immediately reused.  This reduces down time of the network if the
2603 value of updelay has been overestimated, and since this occurs only in
2604 cases with no connectivity, there is no additional penalty for
2605 ignoring the updelay.
2606
2607 In addition to the concerns about switch timings, if your
2608 switches take a long time to go into backup mode, it may be desirable
2609 to not activate a backup interface immediately after a link goes down.
2610 Failover may be delayed via the downdelay bonding module option.
2611
2612 13.2 Duplicated Incoming Packets
2613 --------------------------------
2614
2615 NOTE: Starting with version 3.0.2, the bonding driver has logic to
2616 suppress duplicate packets, which should largely eliminate this problem.
2617 The following description is kept for reference.
2618
2619 It is not uncommon to observe a short burst of duplicated
2620 traffic when the bonding device is first used, or after it has been
2621 idle for some period of time.  This is most easily observed by issuing
2622 a "ping" to some other host on the network, and noticing that the
2623 output from ping flags duplicates (typically one per slave).
2624
2625 For example, on a bond in active-backup mode with five slaves
2626 all connected to one switch, the output may appear as follows::
2627
2628         # ping -n 10.0.4.2
2629         PING 10.0.4.2 (10.0.4.2) from 10.0.3.10 : 56(84) bytes of data.
2630         64 bytes from 10.0.4.2: icmp_seq=1 ttl=64 time=13.7 ms
2631         64 bytes from 10.0.4.2: icmp_seq=1 ttl=64 time=13.8 ms (DUP!)
2632         64 bytes from 10.0.4.2: icmp_seq=1 ttl=64 time=13.8 ms (DUP!)
2633         64 bytes from 10.0.4.2: icmp_seq=1 ttl=64 time=13.8 ms (DUP!)
2634         64 bytes from 10.0.4.2: icmp_seq=1 ttl=64 time=13.8 ms (DUP!)
2635         64 bytes from 10.0.4.2: icmp_seq=2 ttl=64 time=0.216 ms
2636         64 bytes from 10.0.4.2: icmp_seq=3 ttl=64 time=0.267 ms
2637         64 bytes from 10.0.4.2: icmp_seq=4 ttl=64 time=0.222 ms
2638
2639 This is not due to an error in the bonding driver, rather, it
2640 is a side effect of how many switches update their MAC forwarding
2641 tables.  Initially, the switch does not associate the MAC address in
2642 the packet with a particular switch port, and so it may send the
2643 traffic to all ports until its MAC forwarding table is updated.  Since
2644 the interfaces attached to the bond may occupy multiple ports on a
2645 single switch, when the switch (temporarily) floods the traffic to all
2646 ports, the bond device receives multiple copies of the same packet
2647 (one per slave device).
2648
2649 The duplicated packet behavior is switch dependent, some
2650 switches exhibit this, and some do not.  On switches that display this
2651 behavior, it can be induced by clearing the MAC forwarding table (on
2652 most Cisco switches, the privileged command "clear mac address-table
2653 dynamic" will accomplish this).
2654
2655 14. Hardware Specific Considerations
2656 ====================================
2657
2658 This section contains additional information for configuring
2659 bonding on specific hardware platforms, or for interfacing bonding
2660 with particular switches or other devices.
2661
2662 14.1 IBM BladeCenter
2663 --------------------
2664
2665 This applies to the JS20 and similar systems.
2666
2667 On the JS20 blades, the bonding driver supports only
2668 balance-rr, active-backup, balance-tlb and balance-alb modes.  This is
2669 largely due to the network topology inside the BladeCenter, detailed
2670 below.
2671
2672 JS20 network adapter information
2673 --------------------------------
2674
2675 All JS20s come with two Broadcom Gigabit Ethernet ports
2676 integrated on the planar (that's "motherboard" in IBM-speak).  In the
2677 BladeCenter chassis, the eth0 port of all JS20 blades is hard wired to
2678 I/O Module #1; similarly, all eth1 ports are wired to I/O Module #2.
2679 An add-on Broadcom daughter card can be installed on a JS20 to provide
2680 two more Gigabit Ethernet ports.  These ports, eth2 and eth3, are
2681 wired to I/O Modules 3 and 4, respectively.
2682
2683 Each I/O Module may contain either a switch or a passthrough
2684 module (which allows ports to be directly connected to an external
2685 switch).  Some bonding modes require a specific BladeCenter internal
2686 network topology in order to function; these are detailed below.
2687
2688 Additional BladeCenter-specific networking information can be
2689 found in two IBM Redbooks (www.ibm.com/redbooks):
2690
2691 - "IBM eServer BladeCenter Networking Options"
2692 - "IBM eServer BladeCenter Layer 2-7 Network Switching"
2693
2694 BladeCenter networking configuration
2695 ------------------------------------
2696
2697 Because a BladeCenter can be configured in a very large number
2698 of ways, this discussion will be confined to describing basic
2699 configurations.
2700
2701 Normally, Ethernet Switch Modules (ESMs) are used in I/O
2702 modules 1 and 2.  In this configuration, the eth0 and eth1 ports of a
2703 JS20 will be connected to different internal switches (in the
2704 respective I/O modules).
2705
2706 A passthrough module (OPM or CPM, optical or copper,
2707 passthrough module) connects the I/O module directly to an external
2708 switch.  By using PMs in I/O module #1 and #2, the eth0 and eth1
2709 interfaces of a JS20 can be redirected to the outside world and
2710 connected to a common external switch.
2711
2712 Depending upon the mix of ESMs and PMs, the network will
2713 appear to bonding as either a single switch topology (all PMs) or as a
2714 multiple switch topology (one or more ESMs, zero or more PMs).  It is
2715 also possible to connect ESMs together, resulting in a configuration
2716 much like the example in "High Availability in a Multiple Switch
2717 Topology," above.
2718
2719 Requirements for specific modes
2720 -------------------------------
2721
2722 The balance-rr mode requires the use of passthrough modules
2723 for devices in the bond, all connected to an common external switch.
2724 That switch must be configured for "etherchannel" or "trunking" on the
2725 appropriate ports, as is usual for balance-rr.
2726
2727 The balance-alb and balance-tlb modes will function with
2728 either switch modules or passthrough modules (or a mix).  The only
2729 specific requirement for these modes is that all network interfaces
2730 must be able to reach all destinations for traffic sent over the
2731 bonding device (i.e., the network must converge at some point outside
2732 the BladeCenter).
2733
2734 The active-backup mode has no additional requirements.
2735
2736 Link monitoring issues
2737 ----------------------
2738
2739 When an Ethernet Switch Module is in place, only the ARP
2740 monitor will reliably detect link loss to an external switch.  This is
2741 nothing unusual, but examination of the BladeCenter cabinet would
2742 suggest that the "external" network ports are the ethernet ports for
2743 the system, when it fact there is a switch between these "external"
2744 ports and the devices on the JS20 system itself.  The MII monitor is
2745 only able to detect link failures between the ESM and the JS20 system.
2746
2747 When a passthrough module is in place, the MII monitor does
2748 detect failures to the "external" port, which is then directly
2749 connected to the JS20 system.
2750
2751 Other concerns
2752 --------------
2753
2754 The Serial Over LAN (SoL) link is established over the primary
2755 ethernet (eth0) only, therefore, any loss of link to eth0 will result
2756 in losing your SoL connection.  It will not fail over with other
2757 network traffic, as the SoL system is beyond the control of the
2758 bonding driver.
2759
2760 It may be desirable to disable spanning tree on the switch
2761 (either the internal Ethernet Switch Module, or an external switch) to
2762 avoid fail-over delay issues when using bonding.
2763
2764
2765 15. Frequently Asked Questions
2766 ==============================
2767
2768 1.  Is it SMP safe?
2769 -------------------
2770
2771 Yes. The old 2.0.xx channel bonding patch was not SMP safe.
2772 The new driver was designed to be SMP safe from the start.
2773
2774 2.  What type of cards will work with it?
2775 -----------------------------------------
2776
2777 Any Ethernet type cards (you can even mix cards - a Intel
2778 EtherExpress PRO/100 and a 3com 3c905b, for example).  For most modes,
2779 devices need not be of the same speed.
2780
2781 Starting with version 3.2.1, bonding also supports Infiniband
2782 slaves in active-backup mode.
2783
2784 3.  How many bonding devices can I have?
2785 ----------------------------------------
2786
2787 There is no limit.
2788
2789 4.  How many slaves can a bonding device have?
2790 ----------------------------------------------
2791
2792 This is limited only by the number of network interfaces Linux
2793 supports and/or the number of network cards you can place in your
2794 system.
2795
2796 5.  What happens when a slave link dies?
2797 ----------------------------------------
2798
2799 If link monitoring is enabled, then the failing device will be
2800 disabled.  The active-backup mode will fail over to a backup link, and
2801 other modes will ignore the failed link.  The link will continue to be
2802 monitored, and should it recover, it will rejoin the bond (in whatever
2803 manner is appropriate for the mode). See the sections on High
2804 Availability and the documentation for each mode for additional
2805 information.
2806
2807 Link monitoring can be enabled via either the miimon or
2808 arp_interval parameters (described in the module parameters section,
2809 above).  In general, miimon monitors the carrier state as sensed by
2810 the underlying network device, and the arp monitor (arp_interval)
2811 monitors connectivity to another host on the local network.
2812
2813 If no link monitoring is configured, the bonding driver will
2814 be unable to detect link failures, and will assume that all links are
2815 always available.  This will likely result in lost packets, and a
2816 resulting degradation of performance.  The precise performance loss
2817 depends upon the bonding mode and network configuration.
2818
2819 6.  Can bonding be used for High Availability?
2820 ----------------------------------------------
2821
2822 Yes.  See the section on High Availability for details.
2823
2824 7.  Which switches/systems does it work with?
2825 ---------------------------------------------
2826
2827 The full answer to this depends upon the desired mode.
2828
2829 In the basic balance modes (balance-rr and balance-xor), it
2830 works with any system that supports etherchannel (also called
2831 trunking).  Most managed switches currently available have such
2832 support, and many unmanaged switches as well.
2833
2834 The advanced balance modes (balance-tlb and balance-alb) do
2835 not have special switch requirements, but do need device drivers that
2836 support specific features (described in the appropriate section under
2837 module parameters, above).
2838
2839 In 802.3ad mode, it works with systems that support IEEE
2840 802.3ad Dynamic Link Aggregation.  Most managed and many unmanaged
2841 switches currently available support 802.3ad.
2842
2843 The active-backup mode should work with any Layer-II switch.
2844
2845 8.  Where does a bonding device get its MAC address from?
2846 ---------------------------------------------------------
2847
2848 When using slave devices that have fixed MAC addresses, or when
2849 the fail_over_mac option is enabled, the bonding device's MAC address is
2850 the MAC address of the active slave.
2851
2852 For other configurations, if not explicitly configured (with
2853 ifconfig or ip link), the MAC address of the bonding device is taken from
2854 its first slave device.  This MAC address is then passed to all following
2855 slaves and remains persistent (even if the first slave is removed) until
2856 the bonding device is brought down or reconfigured.
2857
2858 If you wish to change the MAC address, you can set it with
2859 ifconfig or ip link::
2860
2861         # ifconfig bond0 hw ether 00:11:22:33:44:55
2862
2863         # ip link set bond0 address 66:77:88:99:aa:bb
2864
2865 The MAC address can be also changed by bringing down/up the
2866 device and then changing its slaves (or their order)::
2867
2868         # ifconfig bond0 down ; modprobe -r bonding
2869         # ifconfig bond0 .... up
2870         # ifenslave bond0 eth...
2871
2872 This method will automatically take the address from the next
2873 slave that is added.
2874
2875 To restore your slaves' MAC addresses, you need to detach them
2876 from the bond (``ifenslave -d bond0 eth0``). The bonding driver will
2877 then restore the MAC addresses that the slaves had before they were
2878 enslaved.
2879
2880 16. Resources and Links
2881 =======================
2882
2883 The latest version of the bonding driver can be found in the latest
2884 version of the linux kernel, found on http://kernel.org
2885
2886 The latest version of this document can be found in the latest kernel
2887 source (named Documentation/networking/bonding.rst).
2888
2889 Discussions regarding the development of the bonding driver take place
2890 on the main Linux network mailing list, hosted at vger.kernel.org. The list
2891 address is:
2892
2893 netdev@vger.kernel.org
2894
2895 The administrative interface (to subscribe or unsubscribe) can
2896 be found at:
2897
2898 http://vger.kernel.org/vger-lists.html#netdev