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