.\" Generated by scdoc 1.11.2 .\" Complete documentation for this program is not available as a GNU info page .ie \n(.g .ds Aq \(aq .el .ds Aq ' .nh .ad l .\" Begin generated content: .TH "interfaces-bond" "5" "2024-03-13" .P .SH NAME .P \fBinterfaces-bond\fR - Bonding/LAG extensions for the interfaces(5) file format .P .SH DESCRIPTION .P The Linux implementation for Ling Aggregation Groups (LAGs) is called \fIbonding\fR, whereas a LAG interface is called \fIbond\fR.\& The Linux bonding implementation supports active/passive setups, classical EtherChannels as well as LACP (802.\&3ad).\& .P The following options set up bonding/LAG interfaces with ifupdown-ng.\& .P See https://www.\&kernel.\&org/doc/Documentation/networking/bonding.\&rst and for more information.\& .P .SH BOND-RELATED OPTIONS .P A bond interface must have at least one member port set.\& All other options are optional.\& .P \fBbond-members\fR \fIlist of interfaces\fR .RS 4 Denotes the physical member interfaces to form this LAG.\& For compatiblity to ifupdown1 and ifupdown2 \fIslaves\fR as well as \fIbond-slaves\fR are an alias for this option.\& This option is required.\& .P .RE \fBbond-mode\fR \fImode\fR .RS 4 Denotes the mode for this LAG.\& The \fImode\fR can be given as string or as numerical value.\& Valid values are \fIbalance-rr\fR (0), \fIactive-backup\fR (1), \fIbalance-xor\fR (2), \fIbroadcast\fR (3), \fI802.\&3ad\fR (4), \fIbalance-tlb\fR (5), \fIbalance-alb\fR (6).\& The default is \fIbalance-rr\fR.\& .P .RE \fBbond-xmit-hash-policy\fR \fIpolicy\fR .RS 4 Denotes the hash policy/algorithm used to distribute packets across the physical links.\& This only applies for modes \fIbalance-alb\fR, \fIbalance-tlb\fR, \fIbalance-xor\fR, and \fI802.\&3ad\fR.\& The \fIpolicy\fR can be given as string or as numerical value.\& Valid values are \fIlayer2\fR (0), \fIlayer3+4\fR (1), \fIlayer2+3\fR (2), \fIencap2+3\fR (3), and \fIencap3+4\fR (4).\& The default is \fIlayer2\fR.\& .P .RE \fBbond-min-links\fR \fInumber\fR .RS 4 Denotes the minimum number of available links before turning on carrier.\& .P .RE \fBbond-miimon\fR \fIinterval\fR .RS 4 Denotes the MII link monitoring frequency in milliseconds.\& This determines how often the link state of each slave is inspected for link failures.\& A value of zero disables MII link monitoring.\& The default is 0.\& .P .RE \fBbond-use-carrier\fR \fIbool\fR .RS 4 Denotes wether miimon uses MII or ethtool ioctls vs.\& the netif_carrier_ok() call to determine member link status.\& A value of 1 enables the use of netif_carrier_ok(), a value of 0 will use the deprecated MII / ETHTOOL ioctls.\& The default is 1.\& .P .RE \fBbond-updelay\fR \fIdelay\fR .RS 4 Denotes the delay in milliseconds before considering link up, in milliseconds.\& The default is 0.\& .P .RE \fBbond-downdelay\fR \fIdelay\fR .RS 4 Denotes the delay in milliseconds before considering link down, in milliseconds.\& The default is 0.\& .P .RE \fBbond-all-slaves-active\fR \fIbool\fR .RS 4 Denotes wether duplicate frames (received on inactive ports) should be dropped (0) or delivered (1).\& The default is 0.\& .P .RE \fBbond-packets-per-slave\fR \fInum_packets\fR .RS 4 Denotes the number of packets to transmit through a member before moving to the next one.\& When set to 0 then a slave is chosen at random.\& The valid range is 0 - 65535; the default value is 1.\& This option has effect only in balance-rr mode.\& .P .RE \fBbond-lp-interval\fR \fIinterval\fR .RS 4 Denotes the interval in seconds between sending learning packets to each members peer switch.\& The valid range is 1 - 0x7fffffff; the default value is 1.\& This option has effect only in modes balance-tlb and balance-alb.\& .P .RE \fBbond-resend-igmp\fR \fInumber\fR .RS 4 Denotes the number of IGMP membership reports to send after a link failover happend.\& The valid range is 0 - 255; a value of 0 prevents the IGMP membership report from being issued in response to the failover event.\& The default is 1.\& This option is useful for bonding modes balance-rr, active-backup balance-tlb and balance-alb, in which a failover can switch the IGMP traffic from one slave to another.\& .P .RE .SH LACP-RELATED OPTIONS .P The following options are only valid in LACP (802.\&3ad) mode.\& .P \fBbond-lacp-rate\fR \fIrate\fR .RS 4 Denotes the \fIrate\fR of LACPDU requested from the peer.\& The \fIrate\fR can be given as string or as numerical value.\& Valid values are slow (0) and fast (1).\& The default is slow.\& .P .RE \fBbond-ad-select\fR \fImode\fR .RS 4 Denotes the 802.\&3ad aggregation selection logic.\& The \fImode\fR can be given as string or as numerical value.\& Valid values are \fIstable\fR (0), \fIbandwidth\fR (1) and \fIcound\fR (2).\& The default is \fIstable\fR.\& .P .RE \fBbond-ad-actor-sys-prio\fR \fIpriority\fR .RS 4 Denotes the LACP system priority.\& The allowed range is 1 - 65535.\& The default value is 65535.\& .P .RE \fBbond-ad-user-port-key\fR \fIkey\fR .RS 4 Denotes the upper 10 bits of the port-key.\& he values can be from 0 - 1023.\& The default is 0.\& .P .P .RE .SH ACTIVE/BACKUP-RELATED OPTIONS .P The following options are only valid in active/passive setups.\& .P \fBbond-primary\fR \fIinterface\fR .RS 4 Denotes the primary member interface The specified device will always be the active slave while it is available.\& The primary option is only valid for active-backup, balance-tlb and balance-alb mode.\& .P .RE \fBbond-primary-reselect\fR \fIpolicy\fR .RS 4 Denotes the reselection policy for the primary member interface.\& Valid values are \fIalways\fR (0), \fIbetter\fR (1), and \fIfailure\fR (2).\& The default is \fIalways\fR.\& .P .RE \fBbond-fail-over-mac\fR \fImode\fR .RS 4 Denotes whether active-backup mode should set all member interfaces to the same MAC address at enslavement (the traditional behavior), or, when enabled, perform special handling of the bond'\&s MAC address in accordance with the selected policy.\& Valid values are \fInone\fR (0), \fIactive\fR (1), \fIfollow\fR (2).\& The default is \fInone\fR.\& .P .RE \fBbond-num-grat-arp\fR \fIcount\fR .RS 4 Denotes the number of peer notifications (gratuitous ARPs and unsolicited IPv6 Neighbor Advertisements) to be issued after a failover event.\& The valid range is 0 - 255; the default is 1.\& .P .RE \fBbond-num-unsol-na\fR \fIcount\fR .RS 4 This is an alias for \fIbond-num-grat-arp\fR .P .RE \fBbond-peer-notif-delay\fR \fIinterval\fR .RS 4 Denotes the interval in milliseconds, between each peer notification (gratuitous ARP and unsolicited IPv6 Neighbor Advertisement) issued after a failover event.\& The default is 0 which means to match the value of the link monitor interval.\& .P .RE .SH ARP-RELATED OPTIONS .P The following options configure ARP link monitoring.\& The ARP monitor works by periodically checking the slave devices to determine whether they have sent or received traffic recently.\& Regular traffic is generated via ARP probes issued for the addresses specified by the \fIbond-arp-ip-target\fR option.\& .P \fBbond-arp-interval\fR \fIinterval\fR .RS 4 Denotes the frequency in milliseconds to send ARP probes.\& .P .RE \fBbond-arp-ip-target\fR \fIIPv4 address\fR .RS 4 Denotes the IP addresses to use as ARP monitoring peers when \fIbond-arp-interval\fR is > 0.\& .P .RE \fBbond-arp-validate\fR \fImode\fR .RS 4 Specifies whether or not ARP probes and replies should be validated in any mode that supports arp monitoring, or whether non-ARP traffic should be filtered (disregarded) for link monitoring purposes.\& Valid values are \fInone\fR (0), \fIactive\fR (1), \fIbackup\fR (2), \fIall\fR (3), \fIfilter\fR (4), \fIfilter_active\fR (5), and \fIfilter_backup\fR (6).\& The default is \fInone\fR.\& .P .RE \fBbond-arp-all-targets\fR \fImode\fR .RS 4 Denotes the number of \fIbond-arp-ip-targets\fR that have to be reachable to consider the member interface to be up.\& Valid options are \fIany\fR (0) and \fIall\fR (1).\& The default is \fIany\fR.\& .P .RE .SH EXAMPLES .P A bond using two links and LACP (802.\&3ad): .P .nf .RS 4 auto bond0 iface bond0 bond-members eth0 eth1 bond-mode 802\&.3ad bond-xmit-hash-policy layer3+4 bond-min-links 1 # address 192\&.0\&.2\&.42/24 address 2001:db8::42/64 .fi .RE .P .SH AUTHORS .P Maximilian Wilhelm