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