- **bridge**: bridge configuration module
+ **bridge**: Bridge configuration module. Supports both vlan aware
+ and non vlan aware bridges. For the vlan aware bridge, the port sp
+ ecific attributes must be specified under the port. And for vlan u
+ naware bridge port specific attributes must be specified under the
+ bridge.
- **bridge-mcqifaddr**
+ **bridge-vlan-aware**
- **help**: set multicast query to use ifaddr
+ **help**: vlan aware bridge. Setting this attribute to yes ena
+ bles vlan filtering on the bridge
**required**: False
- **default**: 0
-
**example**:
- bridge-mcqifaddr 0
+ bridge-vlan-aware yes/no
- **bridge-gcint**
+ **bridge-pathcosts**
- **help**: bridge garbage collection interval in secs
+ **help**: bridge set port path costs
**required**: False
- **default**: 4
+ **default**: 100
**example**:
- bridge-gcint 4
+ bridge-pathcosts swp1=100 swp2=100
- **bridge-mcsqc**
+ **bridge-portprios**
- **help**: set multicast startup query count
+ **help**: bridge port prios
**required**: False
- **default**: 2
+ **default**: 32
**example**:
- bridge-mcsqc 2
+ bridge-portprios swp1=32 swp2=32
- **bridge-stp**
+ **bridge-fd**
- **help**: bridge-stp yes/no
+ **help**: bridge forward delay
**required**: False
- **default**: no
-
- **validvals**: yes,on,off,no
+ **default**: 15
**example**:
- bridge-stp no
+ bridge-fd 15
- **bridge-mcsqi**
+ **bridge-ageing**
- **help**: set multicast startup query interval (in secs)
+ **help**: bridge ageing
**required**: False
- **default**: 31
+ **default**: 300
**example**:
- bridge-mcsqi 31
+ bridge-ageing 300
- **bridge-mcmi**
+ **bridge-hello**
- **help**: set multicast membership interval (in secs)
+ **help**: bridge set hello time
**required**: False
- **default**: 260
-
- **example**:
- bridge-mcmi 260
-
-
- **bridge-ports**
-
- **help**: bridge ports
-
-
- **required**: True
+ **default**: 2
**example**:
- bridge-ports swp1.100 swp2.100 swp3.100
-
- bridge-ports glob swp1-3.100
-
- bridge-ports regex (swp[1|2|3].100)
+ bridge-hello 2
- **bridge-mcsnoop**
+ **bridge-gcint**
- **help**: set multicast snooping
+ **help**: bridge garbage collection interval in secs
**required**: False
- **default**: 1
+ **default**: 4
**example**:
- bridge-mcsnoop 1
+ bridge-gcint 4
- **bridge-maxwait**
+ **bridge-mcquerier**
- **help**: forces to time seconds the maximum time that the Deb
- ian bridge setup scripts will wait for the bridge ports to ge
- t to the forwarding status, doesn't allow factional part. If i
- t is equal to 0 then no waiting is done
+ **help**: set multicast querier
**required**: False
**default**: 0
**example**:
- bridge-maxwait 3
+ bridge-mcquerier 0
- **bridge-pathcosts**
+ **bridge-mclmc**
- **help**: bridge set port path costs
+ **help**: set multicast last member count
**required**: False
- **default**: 100
+ **default**: 2
**example**:
- bridge-pathcosts swp1=100 swp2=100
+ bridge-mclmc 2
- **bridge-portprios**
+ **bridge-mcsqc**
- **help**: bridge port prios
+ **help**: set multicast startup query count
**required**: False
- **default**: 32
+ **default**: 2
**example**:
- bridge-portprios swp1=32 swp2=32
+ bridge-mcsqc 2
- **bridge-fd**
+ **bridge-mcrouter**
- **help**: bridge forward delay
+ **help**: set multicast router
**required**: False
- **default**: 15
+ **default**: 1
**example**:
- bridge-fd 15
+ bridge-mcrouter 1
- **bridge-ageing**
+ **bridge-stp**
- **help**: bridge ageing
+ **help**: bridge-stp yes/no
**required**: False
- **default**: 300
+ **default**: no
+
+ **validvals**: yes,on,off,no
**example**:
- bridge-ageing 300
+ bridge-stp no
- **bridge-hello**
+ **bridge-pvid**
- **help**: bridge set hello time
+ **help**: bridge port pvid. Must be specified under the bridge
+ port
**required**: False
- **default**: 2
-
**example**:
- bridge-hello 2
+ bridge-pvid 1
- **bridge-mcquerier**
+ **bridge-mcsqi**
- **help**: set multicast querier
+ **help**: set multicast startup query interval (in secs)
**required**: False
- **default**: 0
+ **default**: 31
**example**:
- bridge-mcquerier 0
+ bridge-mcsqi 31
- **bridge-mclmc**
+ **bridge-mcmi**
- **help**: set multicast last member count
+ **help**: set multicast membership interval (in secs)
**required**: False
- **default**: 2
+ **default**: 260
**example**:
- bridge-mclmc 2
+ bridge-mcmi 260
- **bridge-mcrouter**
+ **bridge-mclmi**
- **help**: set multicast router
+ **help**: set multicast last member interval (in secs)
**required**: False
**default**: 1
**example**:
- bridge-mcrouter 1
+ bridge-mclmi 1
- **bridge-portmcrouter**
+ **bridge-vids**
- **help**: set port multicast routers
+ **help**: bridge port vids. Can be specified under the bridge
+ or under the port. If specified under the bridge the ports inh
+ erit it unless overridden by a bridge-vids attribuet under the
+ port
**required**: False
- **default**: 1
-
**example**:
- bridge-portmcrouter swp1=1 swp2=1
+ bridge-vids 4000
+ bridge-vids 2000 2200-3000
- **bridge-mclmi**
- **help**: set multicast last member interval (in secs)
+ **bridge-ports**
+ **help**: bridge ports
- **required**: False
- **default**: 1
+ **required**: True
**example**:
- bridge-mclmi 1
+ bridge-ports swp1.100 swp2.100 swp3.100
+
+ bridge-ports glob swp1-3.100
+ bridge-ports regex (swp[1|2|3].100)
- **bridge-hashmax**
- **help**: set hash max
+ **bridge-mcqifaddr**
+
+ **help**: set multicast query to use ifaddr
**required**: False
- **default**: 4096
+ **default**: 0
**example**:
- bridge-hashmax 4096
+ bridge-mcqifaddr 0
**bridge-waitport**
**default**: 0
**example**:
- bridge-waitport 4
+ bridge-waitport 4 swp1 swp2
**bridge-mcqri**
bridge-mcqpi 255
+ **bridge-hashmax**
+
+ **help**: set hash max
+
+
+ **required**: False
+
+ **default**: 4096
+
+ **example**:
+ bridge-hashmax 4096
+
+
**bridge-bridgeprio**
**help**: bridge priority
bridge-maxage 20
+ **bridge-mcsnoop**
+
+ **help**: set multicast snooping
+
+
+ **required**: False
+
+ **default**: 1
+
+ **example**:
+ bridge-mcsnoop 1
+
+
+ **bridge-access**
+
+ **help**: bridge port access vlan. Must be specified under the
+ bridge port
+
+
+ **required**: False
+
+ **example**:
+ bridge-access 300
+
+
+ **bridge-maxwait**
+
+ **help**: forces to time seconds the maximum time that the Deb
+ ian bridge setup scripts will wait for the bridge ports to ge
+ t to the forwarding status, doesn't allow factional part. If i
+ t is equal to 0 then no waiting is done
+
+
+ **required**: False
+
+ **default**: 0
+
+ **example**:
+ bridge-maxwait 3
+
+
+ **bridge-portmcrouter**
+
+ **help**: set port multicast routers
+
+
+ **required**: False
+
+ **default**: 1
+
+ **example**:
+ under the bridge: bridge-portmcrouter swp1=1 swp2=1
+
+ under the port: bridge-portmcrouter 1
+
+
**bridge-portmcfl**
- **help**: port multicast fast leave
+ **help**: port multicast fast leave.
**required**: False
**default**: 0
**example**:
- bridge-portmcfl swp1=0 swp2=0
+ under the bridge: bridge-portmcfl swp1=0 swp2=0
+
+ under the port: bridge-portmcfl 0
**bridge-mcqi**
**mstpctl**: mstp configuration module for bridges
- **mstpctl-fdelay**
+ **mstpctl-portadminedge**
- **help**: set forwarding delay
+ **help**: enable/disable initial edge state of the port
**required**: False
- **default**: 15
+ **default**: no
+
+ **validvals**: yes,no
**example**:
- mstpctl-fdelay 15
+ mstpctl-portadminedge swp1=no swp2=no
- **mstpctl-txholdcount**
+ **mstpctl-portbpdufilter**
- **help**: bridge transmit holdcount
+ **help**: enable/disable bpdu filter on a port. syntax varies
+ when defined under a bridge vs under a port
**required**: False
- **default**: 6
+ **default**: no
+
+ **validvals**: yes,no
**example**:
- mstpctl-txholdcount 6
+ under a bridge: mstpctl-portbpdufilter swp1=no swp2=no
+ under a port: mstpctl-portbpdufilter yes
- **mstpctl-portautoedge**
- **help**: enable/disable auto transition to/from edge state of
- the port
+ **mstpctl-fdelay**
+
+ **help**: set forwarding delay
**required**: False
- **default**: no
-
- **validvals**: yes,no
+ **default**: 15
**example**:
- mstpctl-portautoedge swp1=yes swp2=yes
+ mstpctl-fdelay 15
- **mstpctl-portrestrrole**
+ **mstpctl-portnetwork**
- **help**: enable/disable port ability to take root role of the
- port
+ **help**: enable/disable bridge assurance capability for a por
+ t
**required**: False
**validvals**: yes,no
**example**:
- mstpctl-portrestrrole swp1=no swp2=no
+ mstpctl-portnetwork swp1=no swp2=no
- **mstpctl-portnetwork**
+ **mstpctl-txholdcount**
- **help**: enable/disable bridge assurance capability for a por
- t
+ **help**: bridge transmit holdcount
**required**: False
- **default**: no
+ **default**: 6
- **validvals**: yes,no
+ **example**:
+ mstpctl-txholdcount 6
+
+
+ **mstpctl-forcevers**
+
+ **help**: bridge force stp version
+
+
+ **required**: False
+
+ **default**: rstp
**example**:
- mstpctl-portnetwork swp1=no swp2=no
+ mstpctl-forcevers rstp
- **mstpctl-portp2p**
+ **mstpctl-portautoedge**
- **help**: bridge port p2p detection mode
+ **help**: enable/disable auto transition to/from edge state of
+ the port
**required**: False
- **default**: no
+ **default**: yes
**validvals**: yes,no
**example**:
- mstpctl-portp2p swp1=no swp2=no
+ mstpctl-portautoedge swp1=yes swp2=yes
+
+
+ **mstpctl-maxhops**
+
+ **help**: bridge max hops
+
+
+ **required**: False
+
+ **default**: 15
+
+ **example**:
+ mstpctl-maxhops 15
**mstpctl-treeprio**
mstpctl-treeportprio swp1=128 swp2=128
- **mstpctl-hello**
+ **mstpctl-portpathcost**
- **help**: set hello time
+ **help**: bridge port path cost
**required**: False
- **default**: 2
+ **default**: 0
**example**:
- mstpctl-hello 2
+ mstpctl-portpathcost swp1=0 swp2=1
- **mstpctl-ageing**
+ **mstpctl-portrestrtcn**
- **help**: ageing time
+ **help**: enable/disable port ability to propagate received to
+ pology change notification of the port
**required**: False
- **default**: 300
+ **default**: no
+
+ **validvals**: yes,no
**example**:
- mstpctl-ageing 300
+ mstpctl-portrestrtcn swp1=no swp2=no
- **mstpctl-portadminedge**
+ **mstpctl-maxage**
- **help**: enable/disable initial edge state of the port
+ **help**: max message age
**required**: False
- **default**: no
-
- **validvals**: yes,no
+ **default**: 20
**example**:
- mstpctl-portadminedge swp1=no swp2=no
+ mstpctl-maxage 20
- **mstpctl-maxage**
+ **mstpctl-hello**
- **help**: max message age
+ **help**: set hello time
**required**: False
- **default**: 20
+ **default**: 2
**example**:
- mstpctl-maxage 20
+ mstpctl-hello 2
- **mstpctl-maxhops**
+ **mstpctl-portrestrrole**
- **help**: bridge max hops
+ **help**: enable/disable port ability to take root role of the
+ port
**required**: False
- **default**: 15
+ **default**: no
+
+ **validvals**: yes,no
**example**:
- mstpctl-maxhops 15
+ mstpctl-portrestrrole swp1=no swp2=no
- **mstpctl-portrestrtcn**
+ **mstpctl-bpduguard**
- **help**: enable/disable port ability to propagate received to
- pology change notification of the port
+ **help**: enable/disable bpduguard
**required**: False
**validvals**: yes,no
**example**:
- mstpctl-portrestrtcn swp1=no swp2=no
+ mstpctl-bpduguard swp1=no swp2=no
- **mstpctl-portpathcost**
+ **mstpctl-ageing**
- **help**: bridge port path cost
+ **help**: ageing time
**required**: False
- **default**: 0
+ **default**: 300
**example**:
- mstpctl-portpathcost swp1=0 swp2=1
+ mstpctl-ageing 300
- **mstpctl-portadminage**
+ **mstpctl-treeportcost**
- **help**: bridge port admin age
+ **help**: port tree cost
**required**: False
- **default**: no
+ **mstpctl-portp2p**
+
+ **help**: bridge port p2p detection mode
- **validvals**: yes,no
+
+ **required**: False
+
+ **default**: auto
+
+ **validvals**: yes,no,auto
**example**:
- mstpctl-portadminage swp1=no swp2=no
+ mstpctl-portp2p swp1=no swp2=no
- **mstpctl-portbpdufilter**
- **help**: enable/disable bpdu filter on a port
+ **clagd**: This module generates the clagd defaults file.
+
+
+ **clagd-priority**
+
+ **help**: The priority of this clagd switch
**required**: False
- **default**: no
+ **example**:
+ clagd-priority 30000
- **validvals**: yes,no
+
+ **clagd-backup-ip**
+
+ **help**: Backup IP address of the clagd peer
+
+
+ **required**: False
**example**:
- mstpctl-portbpdufilter swp1=no swp2=no
+ clagd-backup-ip 192.1.1.1
- **mstpctl-forcevers**
+ **clagd-enable**
- **help**: bridge force stp version
+ **help**: enable clagd
**required**: False
- **default**: rstp
+ **validvals**: yes,no
**example**:
- mstpctl-forcevers rstp
+ clagd-enable yes
- **mstpctl-treeportcost**
+ **clag-id**
- **help**: port tree cost
+ **help**: multi-chassis lag id
**required**: False
- **mstpctl-bpduguard**
+ **default**: 0
- **help**: enable/disable bpduguard
+ validrange: 0-65535
+ **example**:
+ clag-id 1
- **required**: False
- **default**: no
+ **clagd-peer-ip**
- **validvals**: yes,no
+ **help**: The IP address of the clagd peer
+
+
+ **required**: True
**example**:
- mstpctl-bpduguard swp1=no swp2=no
+ clagd-peer 10.10.10.2
+
+
+ **clagd-sys-mac**
+
+ **help**: The system ID of the CLAG pair
+
+
+ **required**: True
+
+ **example**:
+ clagd-sys-mac 44:38:39:ff:00:00
+
+
+ **clagd-args**
+
+ **help**: Additional command line arguments for clagd
+
+
+ **required**: False
+
+ **example**:
+ clagd-args --log /var/log/clagd.log
+
+ clagd-args --verbose --lacpPoll 10
+
+ clagd-args --debug 0x4
**required**: False
- **ifenslave**: bond configuration module
+ **bridgevlan**: bridgevlan module configures vlan attributes on a
+ vlan aware bridge. This module only understands vlan interface nam
+ e with dot notations. eg br0.100. where br0 is the vlan aware brid
+ ge this config is for
- **bond-miimon**
+ **bridge-igmp-querier-src**
- **help**: bond miimon
+ **help**: bridge igmp querier src. Must be specified under the
+ vlan interface
**required**: False
- **default**: 0
+ **example**:
+ bridge-igmp-querier-src 172.16.101.1
- validrange: 0-255
- **example**:
- bond-miimon 0
+ **ifenslave**: bond configuration module
- **bond-slaves**
- **help**: bond slaves
+ **bond-use-carrier**
+ **help**: bond use carrier
- **required**: True
- **example**:
- bond-slaves swp1 swp2
+ **required**: False
- bond-slaves glob swp1-2
+ **default**: 1
- bond-slaves regex (swp[1|2)
+ **validvals**: 0,1
+ **example**:
+ bond-use-carrier 1
- **bond-mode**
- **help**: bond mode
+ **bond-lacp-bypass-period**
+
+ **help**: grace period (seconds) for lacp bypass
**required**: False
- **default**: balance-rr
+ **default**: 0
- **validvals**: balance-rr,active-backup,balance-xor,broadcast,802.3ad,balance-tlb,balance-alb
+ validrange: 0-900
**example**:
- bond-mode 802.3ad
+ bond-lacp-bypass-period 100
- **bond-num-grat-arp**
+ **bond-miimon**
- **help**: bond use carrier
+ **help**: bond miimon
**required**: False
- **default**: 1
+ **default**: 0
validrange: 0-255
**example**:
- bond-num-grat-arp 1
+ bond-miimon 0
- **bond-ad-sys-mac-addr**
+ **bond-lacp-rate**
- **help**: 802.3ad system mac address
+ **help**: bond lacp rate
**required**: False
- **default**: 00:00:00:00:00:00
+ **default**: 0
+
+ **validvals**: 0,1
**example**:
- bond-ad-sys-mac-addr 00:00:00:00:00:00
+ bond-lacp-rate 0
- **bond-use-carrier**
+ **bond-lacp-bypass-priority**
- **help**: bond use carrier
+ **help**: slave priority for lacp bypass
**required**: False
- **default**: 1
+ **example**:
+ bond-lacp-bypass-priority swp1=1 swp2=1 swp3=2
- **validvals**: 0,1
+
+ **bond-min-links**
+
+ **help**: bond min links
+
+
+ **required**: False
+
+ **default**: 0
**example**:
- bond-use-carrier 1
+ bond-min-links 0
- **bond-lacp-rate**
+ **bond-slaves**
+
+ **help**: bond slaves
- **help**: bond use carrier
+
+ **required**: True
+
+ **example**:
+ bond-slaves swp1 swp2
+
+ bond-slaves glob swp1-2
+
+ bond-slaves regex (swp[1|2)
+
+
+ **bond-lacp-bypass-allow**
+
+ **help**: allow lacp bypass
**required**: False
**validvals**: 0,1
**example**:
- bond-lacp-rate 0
+ bond-lacp-bypass-allow 0
- **bond-min-links**
+ **bond-mode**
- **help**: bond min links
+ **help**: bond mode
**required**: False
- **default**: 0
+ **default**: balance-rr
+
+ **validvals**: balance-rr,active-backup,balance-xor,broadcast,802.3ad,balance-tlb,balance-alb
**example**:
- bond-min-links 0
+ bond-mode 802.3ad
**bond-num-unsol-na**
bond-xmit-hash-policy layer2
+ **bond-num-grat-arp**
+
+ **help**: bond use carrier
+
+
+ **required**: False
+
+ **default**: 1
+
+ validrange: 0-255
+
+ **example**:
+ bond-num-grat-arp 1
+
+
+ **bond-ad-sys-mac-addr**
+
+ **help**: 802.3ad system mac address
+
+
+ **required**: False
+
+ **default**: 00:00:00:00:00:00
+
+ **example**:
+ bond-ad-sys-mac-addr 00:00:00:00:00:00
+
+
**address**: address configuration module for interfaces
scope host
+ **address-purge**
+
+ **help**: purge existing addresses. By default any existing ip
+ addresses on an interface are purged to match persistant addre
+ sses in the interfaces file. Set this attribute to 'no'if you
+ want to preserve existing addresses
+
+
+ **required**: False
+
+ **default**: yes
+
+ **example**:
+ address-purge yes/no
+
+
**preferred-lifetime**
**help**: preferred lifetime
+ **addressvirtual**: address module configures virtual addresses fo
+ r interfaces. It creates a macvlan interface for every mac ip addr
+ ess-virtual line
+
+
+ **address-virtual**
+
+ **help**: bridge router virtual mac and ip
+
+
+ **required**: False
+
+ **example**:
+ address-virtual 00:11:22:33:44:01 11.0.1.254/24 11.0.1.254/24
+
+
+
+ **vxlan**: vxlan module configures vxlan interfaces.
+
+
+ **vxlan-learning**
+
+ **help**: vxlan learning on/off
+
+
+ **required**: False
+
+ **default**: on
+
+ **example**:
+ vxlan-learning off
+
+
+ **vxlan-id**
+
+ **help**: vxlan id
+
+
+ **required**: True
+
+ **example**:
+ vxlan-id 100
+
+
+ **vxlan-remoteip**
+
+ **help**: vxlan remote ip
+
+
+ **required**: False
+
+ **example**:
+ vxlan-remoteip 172.16.22.127
+
+
+ **vxlan-svcnodeip**
+
+ **help**: vxlan id
+
+
+ **required**: False
+
+ **example**:
+ vxlan-svcnodeip 172.16.22.125
+
+
+ **vxlan-local-tunnelip**
+
+ **help**: vxlan local tunnel ip
+
+
+ **required**: False
+
+ **example**:
+ vxlan-local-tunnelip 172.16.20.103
+
+
+
SEE ALSO
========
interfaces(5),
ip(8),
mstpctl(8),
brctl(8),
- ethtool(8)
+ ethtool(8),
+ clagctl(8)
projects / mirror_ifupdown2.git / commitdiff