1 ==========================
2 ifupdown-addons-interfaces
3 ==========================
4 ---------------------------------------------------------
5 ifupdown2 addon modules interface configuration
6 ---------------------------------------------------------
7 :Author: roopa@cumulusnetworks.com
9 :Copyright: Copyright 2013 Cumulus Networks, Inc. All rights reserved.
16 ifupdown2 addon modules add incremental functionality to
19 All installed addon modules are executed on every interface
20 listed in the interfaces file. Addon modules are installed under
21 /usr/share/ifupdownaddons. To see the list of active addon
22 modules, see ifaddon(8).
24 Addon modules add new attributes to the interfaces(5) file.
25 Below is a list of attribute options provided by each module.
26 These can be listed under each iface section in the interfaces(5)
32 Listed below are addon modules and their supported attributes.
33 The attributes if applicable go under the iface section in the
36 **ethtool**: ethtool configuration module for interfaces
41 **help**: set link duplex
48 **validvals**: half,full
56 **help**: set autonegotiation
71 **help**: set link speed
81 **bridge**: Bridge configuration module. Supports both vlan aware
82 and non vlan aware bridges. For the vlan aware bridge, the port sp
83 ecific attributes must be specified under the port. And for vlan u
84 naware bridge port specific attributes must be specified under the
90 **help**: vlan aware bridge. Setting this attribute to yes ena
91 bles vlan filtering on the bridge
97 bridge-vlan-aware yes/no
102 **help**: bridge set port path costs
110 bridge-pathcosts swp1=100 swp2=100
115 **help**: bridge port prios
123 bridge-portprios swp1=32 swp2=32
128 **help**: bridge forward delay
141 **help**: bridge ageing
154 **help**: bridge set hello time
167 **help**: bridge garbage collection interval in secs
180 **help**: set multicast querier
193 **help**: set multicast last member count
206 **help**: set multicast startup query count
219 **help**: set multicast router
232 **help**: bridge-stp yes/no
239 **validvals**: yes,on,off,no
247 **help**: bridge port pvid. Must be specified under the bridge
259 **help**: set multicast startup query interval (in secs)
272 **help**: set multicast membership interval (in secs)
285 **help**: set multicast last member interval (in secs)
298 **help**: bridge port vids. Can be specified under the bridge
299 or under the port. If specified under the bridge the ports inh
300 erit it unless overridden by a bridge-vids attribuet under the
309 bridge-vids 2000 2200-3000
314 **help**: bridge ports
320 bridge-ports swp1.100 swp2.100 swp3.100
322 bridge-ports glob swp1-3.100
324 bridge-ports regex (swp[1|2|3].100)
329 **help**: set multicast query to use ifaddr
342 **help**: wait for a max of time secs for the specified ports
343 to become available,if no ports are specified then those speci
344 fied on bridge-ports will be used here. Specifying no ports he
345 re should not be used if we are using regex or "all" on bridge
346 _ports,as it wouldnt work.
354 bridge-waitport 4 swp1 swp2
359 **help**: set multicast query response interval (in secs)
372 **help**: set hash elasticity
385 **help**: set multicast querier interval (in secs)
398 **help**: set hash max
409 **bridge-bridgeprio**
411 **help**: bridge priority
419 bridge-bridgeprio 32768
424 **help**: bridge set maxage
437 **help**: set multicast snooping
450 **help**: bridge port access vlan. Must be specified under the
462 **help**: forces to time seconds the maximum time that the Deb
463 ian bridge setup scripts will wait for the bridge ports to ge
464 t to the forwarding status, doesn't allow factional part. If i
465 t is equal to 0 then no waiting is done
476 **bridge-portmcrouter**
478 **help**: set port multicast routers
486 under the bridge: bridge-portmcrouter swp1=1 swp2=1
488 under the port: bridge-portmcrouter 1
493 **help**: port multicast fast leave.
501 under the bridge: bridge-portmcfl swp1=0 swp2=0
503 under the port: bridge-portmcfl 0
508 **help**: set multicast query interval (in secs)
520 **usercmds**: user commands for interfaces
525 **help**: run command at interface down
532 **help**: run command after interface bring up
539 **help**: run command at interface bring up
546 **help**: run command before bringing the interface down
553 **help**: run command before bringing the interface up
560 **help**: run command after bringing interface down
566 **mstpctl**: mstp configuration module for bridges
569 **mstpctl-portadminedge**
571 **help**: enable/disable initial edge state of the port
578 **validvals**: yes,no
581 mstpctl-portadminedge swp1=no swp2=no
584 **mstpctl-portbpdufilter**
586 **help**: enable/disable bpdu filter on a port. syntax varies
587 when defined under a bridge vs under a port
594 **validvals**: yes,no
597 under a bridge: mstpctl-portbpdufilter swp1=no swp2=no
599 under a port: mstpctl-portbpdufilter yes
604 **help**: set forwarding delay
615 **mstpctl-portnetwork**
617 **help**: enable/disable bridge assurance capability for a por
625 **validvals**: yes,no
628 mstpctl-portnetwork swp1=no swp2=no
631 **mstpctl-txholdcount**
633 **help**: bridge transmit holdcount
641 mstpctl-txholdcount 6
644 **mstpctl-forcevers**
646 **help**: bridge force stp version
654 mstpctl-forcevers rstp
657 **mstpctl-portautoedge**
659 **help**: enable/disable auto transition to/from edge state of
667 **validvals**: yes,no
670 mstpctl-portautoedge swp1=yes swp2=yes
675 **help**: bridge max hops
688 **help**: tree priority
698 mstpctl-treeprio 32768
701 **mstpctl-treeportprio**
703 **help**: port priority for MSTI instance
713 mstpctl-treeportprio swp1=128 swp2=128
716 **mstpctl-portpathcost**
718 **help**: bridge port path cost
726 mstpctl-portpathcost swp1=0 swp2=1
729 **mstpctl-portrestrtcn**
731 **help**: enable/disable port ability to propagate received to
732 pology change notification of the port
739 **validvals**: yes,no
742 mstpctl-portrestrtcn swp1=no swp2=no
747 **help**: max message age
760 **help**: set hello time
771 **mstpctl-portrestrrole**
773 **help**: enable/disable port ability to take root role of the
781 **validvals**: yes,no
784 mstpctl-portrestrrole swp1=no swp2=no
787 **mstpctl-bpduguard**
789 **help**: enable/disable bpduguard
796 **validvals**: yes,no
799 mstpctl-bpduguard swp1=no swp2=no
804 **help**: ageing time
815 **mstpctl-treeportcost**
817 **help**: port tree cost
824 **help**: bridge port p2p detection mode
831 **validvals**: yes,no,auto
834 mstpctl-portp2p swp1=no swp2=no
838 **clagd**: This module generates the clagd defaults file.
843 **help**: The priority of this clagd switch
854 **help**: Backup IP address of the clagd peer
860 clagd-backup-ip 192.1.1.1
865 **help**: enable clagd
870 **validvals**: yes,no
878 **help**: multi-chassis lag id
893 **help**: The IP address of the clagd peer
899 clagd-peer 10.10.10.2
904 **help**: The system ID of the CLAG pair
910 clagd-sys-mac 44:38:39:ff:00:00
915 **help**: Additional command line arguments for clagd
921 clagd-args --log /var/log/clagd.log
923 clagd-args --verbose --lacpPoll 10
925 clagd-args --debug 0x4
929 **vlan**: vlan module configures vlan interfaces.This module under
930 stands vlan interfaces with dot notations. eg swp1.100. Vlan inter
931 faces with any other names need to have raw device and vlan id att
944 **help**: vlan raw device
950 **bridgevlan**: bridgevlan module configures vlan attributes on a
951 vlan aware bridge. This module only understands vlan interface nam
952 e with dot notations. eg br0.100. where br0 is the vlan aware brid
953 ge this config is for
956 **bridge-igmp-querier-src**
958 **help**: bridge igmp querier src. Must be specified under the
965 bridge-igmp-querier-src 172.16.101.1
969 **ifenslave**: bond configuration module
974 **help**: bond use carrier
987 **bond-lacp-bypass-period**
989 **help**: grace period (seconds) for lacp bypass
999 bond-lacp-bypass-period 100
1004 **help**: bond miimon
1019 **help**: bond lacp rate
1032 **bond-lacp-bypass-priority**
1034 **help**: slave priority for lacp bypass
1040 bond-lacp-bypass-priority swp1=1 swp2=1 swp3=2
1045 **help**: bond min links
1058 **help**: bond slaves
1064 bond-slaves swp1 swp2
1066 bond-slaves glob swp1-2
1068 bond-slaves regex (swp[1|2)
1071 **bond-lacp-bypass-allow**
1073 **help**: allow lacp bypass
1083 bond-lacp-bypass-allow 0
1093 **default**: balance-rr
1095 **validvals**: balance-rr,active-backup,balance-xor,broadcast,802.3ad,balance-tlb,balance-alb
1101 **bond-num-unsol-na**
1103 **help**: bond slave devices
1116 **bond-ad-sys-priority**
1118 **help**: 802.3ad system priority
1126 bond-ad-sys-priority 65535
1129 **bond-xmit-hash-policy**
1131 **help**: bond slave devices
1138 **validvals**: layer2,layer3+4,layer2+3
1141 bond-xmit-hash-policy layer2
1144 **bond-num-grat-arp**
1146 **help**: bond use carrier
1159 **bond-ad-sys-mac-addr**
1161 **help**: 802.3ad system mac address
1166 **default**: 00:00:00:00:00:00
1169 bond-ad-sys-mac-addr 00:00:00:00:00:00
1173 **address**: address configuration module for interfaces
1178 **help**: broadcast address
1184 broadcast 10.0.1.255
1189 **help**: hw address
1195 hwaddress 44:38:39:00:27:b8
1200 **help**: description/alias
1211 **help**: ipv4 or ipv6 addresses
1217 address 10.0.12.3/24
1219 address 2000:1000:1000:1000:3::5/128
1235 **help**: purge existing addresses. By default any existing ip
1236 addresses on an interface are purged to match persistant addre
1237 sses in the interfaces file. Set this attribute to 'no'if you
1238 want to preserve existing addresses
1246 address-purge yes/no
1249 **preferred-lifetime**
1251 **help**: preferred lifetime
1257 preferred-lifetime forever
1259 preferred-lifetime 10
1264 **help**: default gateway
1270 gateway 255.255.255.0
1275 **help**: interface mtu
1287 **addressvirtual**: address module configures virtual addresses fo
1288 r interfaces. It creates a macvlan interface for every mac ip addr
1294 **help**: bridge router virtual mac and ip
1300 address-virtual 00:11:22:33:44:01 11.0.1.254/24 11.0.1.254/24
1304 **vxlan**: vxlan module configures vxlan interfaces.
1309 **help**: vxlan learning on/off
1333 **help**: vxlan remote ip
1339 vxlan-remoteip 172.16.22.127
1350 vxlan-svcnodeip 172.16.22.125
1353 **vxlan-local-tunnelip**
1355 **help**: vxlan local tunnel ip
1361 vxlan-local-tunnelip 172.16.20.103