]> git.ipfire.org Git - people/ms/rstp.git/blobdiff - rstpctl.8
Use new RSTP library.
[people/ms/rstp.git] / rstpctl.8
index 456a8796f910faef27015240109aad8938f9982f..ca72eafbd9f55739a3e012ca42e71d01b05ae38a 100644 (file)
--- a/rstpctl.8
+++ b/rstpctl.8
@@ -18,11 +18,6 @@ command.
 
 .SH COMMANDS
 
-.B rstpctl rstp <bridge> {on|off}
-configures whether rstpd implements RSTP (Rapid Spanning Tree
-Protocol) for the specified bridge. The remaining commands are
-applicable only if rstpd is configured to run RSTP on that bridge.
-
 .B rstpctl showbridge [<bridge> ... ]
 displays the spanning tree configuration and status for the specified
 bridges. If no bridges are given, it displays the information for all
@@ -35,7 +30,7 @@ the information for all ports of the bridge.
 
 The format of the line is :
 .br
-.B "pes  name iiii sss  rrrr-rootbridgeid dddd-desgbridgeid dprt R"
+.B "pe  name iiii ssss  rrrr-rootbridgeid dddd-desgbridgeid dprt"
 .br
 where the following abbreviations are used.
 
@@ -43,23 +38,18 @@ where the following abbreviations are used.
 .br
 \fBe\fR: 'E' if the port is operating as an edge port, ' ' otherwise.
 .br
-\fBs\fR: 's' if the port is in STP (slow) mode, ' ' otherwise.
-.br
 \fBname\fR: The name of the port, i.e, the network interface name.
 .br
 \fBiiii\fR: The port id, containing the port priority and port number
 .br
-\fBsss\fR: The port state, one of Dis (disabled), Blk (blocking), Lrn
-(learning), Fwd (forwading), Non (non-stp), Unk (unknown).
+\fBssss\fR: The port state, one of down (disabled), disc (discarding),
+lear (learning), forw (forwading), unkn (unknown).
 .br
 \fBrrrr-rootbridgeid\fR: Root bridge id, including priority.
 .br
 \fBdddd-desgbridgeid\fR: Designated bridge id, including priority
 .br
 \fBdprt\fR: Designated port id
-.br
-\fBR\fR: Port role, one of 'A' (alternate), 'B' (backup), 'R' (root), 'D'
-(designated), '-' (non-stp)
 
 
 .B rstpctl showportdetail <bridge> [<port> ... ]
@@ -67,12 +57,6 @@ displays the spanning tree configuration and status for the specified
 ports much more verbosely. If no ports are specified, it displays the
 information for all ports of the bridge.
 
-.B rstpctl setbridgestate <bridge> {on|off}
-enables/disables the operation of RSTP. When RSTP is configured with
-the
-.BR rstp
-subcommand listed above, the default is enabled.
-
 .B rstpctl setbridgeprio <bridge> <priority>
 sets the bridge's priority to <priority>. The priority value is a
 number between 0 and 61440 in steps of 4096, and defaults to 32768.
@@ -94,6 +78,11 @@ sets the bridge's spanning tree algorithm to operate in normal
 mode. In normal mode, RSTP falls back to STP on ports where it
 sees other hosts operating in STP mode.
 
+.B rstpctl settxholdcount <bridge> <tx_hold_count>
+sets the transmit hold count, which limits the rate of transmission
+of BPDUs. No more than <tx_hold_count> + 1 BPDUs are transmitted in
+one second. This is a number from 1 to 10.
+
 .B rstpctl setportprio <bridge> <port> <priority>
 sets the ports's priority to <priority>. The priority value is a
 number from 0 to 240 in steps of 16, defaulting to 128.
@@ -104,15 +93,17 @@ automatically based on the link speed. This setting overrides the
 automatic setting. Setting this to zero puts it back in automatic
 mode.
 
-.B rstpctl setportedge <bridge> <port> {yes|no}
-sets or unsets the port's configures as an edge port. If a port is an
-edge port, then it is assumed to be a leaf link in the graph, not
+.B rstpctl setportadminedge <bridge> <port> {yes|no}
+sets or unsets the port's configuration as an edge port. If a port is
+an edge port, then it is assumed to be a leaf link in the graph, not
 connected to any other bridges. Receiving any STP BPDU's on a port
 configured as an edge port turns off edge port behaviour for the port.
 
-.B rstpctl setportnonstp <bridge> <port> {yes|no}
-: Setting this to yes disables RSTP operation on the port, which then
-is always kept in FORWARDING state.
+.B rstpctl setportautoedge <bridge> <port> {yes|no}
+sets or unsets the port's configuration as an auto edge port.
+If it is configured as auto edge, the port is brought up based on a
+shorter timer when no response in received and treated as an edge port.
+Receiving any STP BPDU's turns off edge port behaviour for the port.
 
 .B rstpctl portmcheck <bridge> <port>
 : This command is used when the port is operating in STP compatibility