MSTPCTL-UTILS-INTERFACES(5)

NAME
mstpctl-utils-interfaces - mstpctl-utils extensions for the interfaces(5) file format

DESCRIPTION
/etc/network/interfaces contains network interface configuration information for the ifup(8) and ifdown(8) commands. This manpage describes the mstpctl extensions to the standard interfaces(5) file format.

The main extension is the mstpctl_ports option, with it you describe that the interface is a bridge and what ports does it have. Spanning Tree protocol parameters can also be specified. Currently multiple spanning trees are not supported by this extension (although mstpd/mstpctl supports MSTP without restrictions). This means that all settings here are applied to the CIST tree.

We'll see this with an example:
    auto br0
    iface br0 inet static
        address 12.0.0.3
        netmask 255.255.255.0
        mstpctl_ports swp1 swp2 swp3 swp4
        mstpctl_stp on
        mstpctl_maxwait auto
        mstpctl_maxage 20
        mstpctl_fdelay 15
        mstpctl_maxhops 20
        mstpctl_txholdcount 6
        mstpctl_forcevers rstp
        mstpctl_portpathcost swp1=0 swp2=0
        mstpctl_portadminedge swp1=no swp2=no swp4=yes
        mstpctl_portautoedge swp1=yes swp2=yes
        mstpctl_portp2p swp1=no swp2=no
        mstpctl_portrestrrole swp1=no swp2=no
        mstpctl_bpduguard swp1=no swp2=no swp4=yes
        mstpctl_portrestrtcn swp1=no swp2=no
        mstpctl_treeprio 8
        mstpctl_treeportprio swp3=8
        mstpctl_hello 2
        mstpctl_portnetwork swp1=no
        mstpctl_portbpdufilter swp4=yes

IFACE OPTIONS
The below interface options for configuring STP parameters on an STP enabled bridge can be specified in /etc/network/interfaces.

mstpctl_ports interface specification
    this option must exist to specify the bridge and the ports which need to be added to the bridge.
        mstpctl_ports swp1 swp4

    Regular expressions can be used to select a number of interfaces
        mstpctl_ports regex (eth|vif).*
    This means to evaluate (as in egrep(1)) the expressions that follow after "regex" until either the end or a "noregex" statement is reached.

  mstpctl_stp yes|no
turn spanning tree protocol on/off, default is no.

mstpctl_maxwait time|auto
    set max time in seconds to wait for initial STP convergence before allowing ifup to exit, default is auto (=fdelay*2+1).

mstpctl_maxage time
    set max message age to time seconds, default is 20.

mstpctl_fdelay time
    set bridge forward delay to time seconds, default is 15.

mstpctl_maxhops max_hops
    set bridge maximum hops to max_hops, default is 20.

mstpctl_forcevers mstp|rstp|stp
    forces the bridge to use specific STP protocol version. mstp is the default.

mstpctl_txholdcount tx_hold_count
    set bridge transmit hold count to tx_hold_count, default is 6.

mstpctl_treeprio priority
    set bridge tree priority, priority is between 0 and 15. Bridge priority affects bridge id, lowest priority bridge will be the root. Note that traditionally bridge priority is a multiple of 4096 and ranges from 0 to 15*4096 = 61440. mstpd is different - it throws out that useless "multiple of 4096" rule and expresses bridge priority in natural units (0-15). Default is 8.

mstpctl_portpathcost port cost
    set path cost for a port, default is 0 (= auto), port is the name of the interface to which this setting applies.

mstpctl_portadminedge port yes|no
    Enables/disables the admin edge state of the port, default is no.

mstpctl_portautoedge port yes|no
    Enables/disables the auto transition to/from edge state of the port, default is yes.

mstpctl_portp2p port yes|no|auto
    Enables/disables the point2point detection mode of the port, default is auto.

mstpctl_portrestrrole port yes|no
    Enables/disables the restrictions on the port's ability to take root role, default is no (i.e. no restrictions on the port's role).

mstpctl_portrestrtcn port yes|no
    Enables/disables the restrictions on the port's ability to propagate received topology change notification, default is no (i.e. no restrictions on the TCN propagation).

mstpctl_bpduguard port yes|no
    Enables/disables the bpduguard configuration of the port, default is no.

mstpctl_treeportprio port priority
    sets the port's priority to priority. The priority value is a number between 0 and 15. Note that traditionally port priority is a multiple of 16 and ranges from 0 to 15*16 = 240. mstpd is different - it throws out that useless "multiple of 16" rule and expresses port priority in natural units (0-15). Default is 8.

mstpctl_hello time
    set hello time to time seconds, default is 2.

mstpctl_ageing time
    sets the ethernet (MAC) address ageing time, in seconds. Used only when protocol version is forced to STP, default is 300s. Note that this parameter differs from the other ones: it is only informational parameter. By setting it in the mstpd one do not change the real bridge's Ageing Time; it is supposed to be set as information to the mstpd that real Ageing Time in the real bridge was changed.

mstpctl_portnetwork port yes|no
    Enables/disables the bridge assurance capability for a port, default is no.

mstpctl_portbpdufilter port yes|no
    Enables/disables the bridge BPDU filter capability for a port, default is no.

FILES

/etc/network/interfaces
    definitions of network interfaces See interfaces(5) for more information.

AUTHOR
This manpage was written by Satish Ashok <sashok@cumulusnetworks.com> based on brctl-utils-interfaces(5).

SEE ALSO
brctl(8), interfaces(5), ifup(8), iwconfig(8), run-parts(8).