1RSTPCTL(8) RSTPCTL(8)
2
6 rstpctl - rstpd spanning tree protocol administration
7
9 rstpctl [command]
10
12 rstpctl is used to set up, maintain, and inspect the bridge RSTP con‐
13 figuration for ethernet bridges as implemented using rstpd(8). rstpd
14 implements the spanning tree algorithm specified by the Rapid Spanning
15 Tree Protocol (RSTP). An implementation of the original Spanning Tree
16 Protocol (STP) is provided by the Linux kernel bridging code and can be
17 enabled and controlled using the brctl command.
18
21 rstpctl rstp <bridge> {on|off} configures whether rstpd implements RSTP
22 (Rapid Spanning Tree Protocol) for the specified bridge. The remaining
23 commands are applicable only if rstpd is configured to run RSTP on that
24 bridge.
25 rstpctl showbridge [<bridge> ... ] displays the spanning tree configu‐
27 ration and status for the specified bridges. If no bridges are given,
28 it displays the information for all bridges.
29 rstpctl showport <bridge> [<port> ... ] displays, as one line per port,
31 the spanning tree configuration and status for the specified ports. If
32 no ports are specified, it displays the information for all ports of
33 the bridge.
34 The format of the line is :
36 pes name iiii sss rrrr-rootbridgeid dddd-desgbridgeid dprt R
37 where the following abbreviations are used.
38 p: '*' if the port link is not point to point, ' ' otherwise.
40 e: 'E' if the port is operating as an edge port, ' ' otherwise.
41 s: 's' if the port is in STP (slow) mode, ' ' otherwise.
42 name: The name of the port, i.e, the network interface name.
43 iiii: The port id, containing the port priority and port number
44 sss: The port state, one of Dis (disabled), Blk (blocking), Lrn (learn‐
45 ing), Fwd (forwading), Non (non-stp), Unk (unknown).
46 rrrr-rootbridgeid: Root bridge id, including priority.
47 dddd-desgbridgeid: Designated bridge id, including priority
48 dprt: Designated port id
49 R: Port role, one of 'A' (alternate), 'B' (backup), 'R' (root), 'D'
50 (designated), '-' (non-stp)
51 rstpctl showportdetail <bridge> [<port> ... ] displays the spanning
54 tree configuration and status for the specified ports much more ver‐
55 bosely. If no ports are specified, it displays the information for all
56 ports of the bridge.
57 rstpctl setbridgestate <bridge> {on|off} enables/disables the operation
59 of RSTP. When RSTP is configured with the rstp subcommand listed above,
60 the default is enabled.
61 rstpctl setbridgeprio <bridge> <priority> sets the bridge's priority to
63 <priority>. The priority value is a number between 0 and 61440 in steps
64 of 4096, and defaults to 32768. Lower priority values are 'better'.
65 The bridge with the lowest priority will be elected 'root bridge'.
66 rstpctl sethello <bridge> <time> sets the bridge's 'bridge hello time'
68 to <time> seconds.
69 rstpctl setmaxage <bridge> <time> sets the bridge's 'maximum message
71 age' to <time> seconds.
72 rstpctl setfdelay <bridge> <time> sets the bridge's 'bridge forward
74 delay' to <time> seconds.
75 rstpctl setforcevers <bridge> {normal|slow} sets the bridge's spanning
77 tree algorithm to operate in normal (i.e. RSTP) mode or force it to
78 operate in slow (i.e. old STP) mode. In normal mode, RSTP falls back to
79 STP on ports where it sees other hosts operating in STP mode.
80 rstpctl setportprio <bridge> <port> <priority> sets the ports's prior‐
82 ity to <priority>. The priority value is a number from 0 to 240 in
83 steps of 16, defaulting to 128.
84 rstpctl setportpathcost <bridge> <port> <cost> sets the ports's path
86 cost to <cost>. This is by default set automatically based on the link
87 speed. This setting overrides the automatic setting. Setting this to
88 zero puts it back in automatic mode.
89 rstpctl setportedge <bridge> <port> {yes|no} sets or unsets the port's
91 configures as an edge port. If a port is an edge port, then it is
92 assumed to be a leaf link in the graph, not connected to any other
93 bridges. Receiving any STP BPDU's on a port configured as an edge port
94 turns off edge port behaviour for the port.
95 rstpctl setportnonstp <bridge> <port> {yes|no} : Setting this to yes
97 disables RSTP operation on the port, which then is always kept in FOR‐
98 WARDING state.
99 rstpctl portmcheck <bridge> <port> : This command is used when the port
101 is operating in STP compatibility mode. I causes the bridge to transmit
102 RSTP BPDUs and to test the hypothesis that non RSTP hosts have been
103 removed from the LAN connected to the port, and if that is the case,
104 the remaining hosts switch back to RSTP mode.
105 rstpctl debuglevel <level> sets the level of verbosity of rstpd's log‐
107 ging.
108
111 TODO: Indicate lack of persistence of configuration across restarts of
112 daemon.
113
116 rstpd(8), brctl(8)
117
120 This manual page Copyright (c) 2006 EMC Corporation.
121 This manual page is free software; you can redistribute it and/or mod‐
123 ify it under the terms of the GNU General Public License as published
124 by the Free Software Foundation; either version 2 of the License, or
125 (at your option) any later version. It comes with NO WARRANTY.
126
129 Srinivas Aji <Aji_Srinivas@emc.com>
130 August 20, 2006 RSTPCTL(8)