rstpctl.8

   1 .TH RSTPCTL 8 "August 20, 2006" "" ""
   2 .SH NAME
   3 rstpctl \- rstpd spanning tree protocol administration
   4 .SH SYNOPSIS
   5 .BR "rstpctl [command]"
   6 .SH DESCRIPTION
   7 .B rstpctl
   8 is used to set up, maintain, and inspect the bridge RSTP
   9 configuration for ethernet bridges as implemented using
  10 .BR rstpd (8).
  11 .BR rstpd
  12 implements the spanning tree algorithm specified by the Rapid Spanning
  13 Tree Protocol (RSTP). An implementation of the original Spanning Tree
  14 Protocol (STP) is provided by the Linux kernel bridging code and can
  15 be enabled and controlled using the
  16 .BR "brctl"
  17 command.
  18
  19 .SH COMMANDS
  20
  21 .B rstpctl showbridge [<bridge> ... ]
  22 displays the spanning tree configuration and status for the specified
  23 bridges. If no bridges are given, it displays the information for all
  24 bridges.
  25
  26 .B rstpctl showport <bridge> [<port> ... ]
  27 displays, as one line per port, the spanning tree configuration and
  28 status for the specified ports. If no ports are specified, it displays
  29 the information for all ports of the bridge.
  30
  31 The format of the line is :
  32 .br
  33 .B "pe  name iiii ssss  rrrr-rootbridgeid dddd-desgbridgeid dprt"
  34 .br
  35 where the following abbreviations are used.
  36
  37 \fBp\fR: '*' if the port link is not point to point, ' ' otherwise.
  38 .br
  39 \fBe\fR: 'E' if the port is operating as an edge port, ' ' otherwise.
  40 .br
  41 \fBname\fR: The name of the port, i.e, the network interface name.
  42 .br
  43 \fBiiii\fR: The port id, containing the port priority and port number
  44 .br
  45 \fBssss\fR: The port state, one of down (disabled), disc (discarding),
  46 lear (learning), forw (forwading), unkn (unknown).
  47 .br
  48 \fBrrrr-rootbridgeid\fR: Root bridge id, including priority.
  49 .br
  50 \fBdddd-desgbridgeid\fR: Designated bridge id, including priority
  51 .br
  52 \fBdprt\fR: Designated port id
  53
  54
  55 .B rstpctl showportdetail <bridge> [<port> ... ]
  56 displays the spanning tree configuration and status for the specified
  57 ports much more verbosely. If no ports are specified, it displays the
  58 information for all ports of the bridge.
  59
  60 .B rstpctl setbridgeprio <bridge> <priority>
  61 sets the bridge's priority to <priority>. The priority value is a
  62 number between 0 and 61440 in steps of 4096, and defaults to 32768.
  63 Lower priority values are 'better'. The bridge with the lowest
  64 priority will be elected 'root bridge'.
  65
  66 .B rstpctl sethello <bridge> <time>
  67 sets the bridge's 'bridge hello time' to <time> seconds.
  68
  69 .B rstpctl setmaxage <bridge> <time>
  70 sets the bridge's 'maximum message age' to <time> seconds.
  71
  72 .B rstpctl setfdelay <bridge> <time>
  73 sets the bridge's 'bridge forward delay' to <time> seconds.
  74
  75 .B rstpctl setforcevers <bridge> {normal|slow}
  76 sets the bridge's spanning tree algorithm to operate in normal
  77 (i.e. RSTP) mode or force it to operate in slow (i.e. old STP)
  78 mode. In normal mode, RSTP falls back to STP on ports where it
  79 sees other hosts operating in STP mode.
  80
  81 .B rstpctl settxholdcount <bridge> <tx_hold_count>
  82 sets the transmit hold count, which limits the rate of transmission
  83 of BPDUs. No more than <tx_hold_count> + 1 BPDUs are transmitted in
  84 one second. This is a number from 1 to 10.
  85
  86 .B rstpctl setportprio <bridge> <port> <priority>
  87 sets the ports's priority to <priority>. The priority value is a
  88 number from 0 to 240 in steps of 16, defaulting to 128.
  89
  90 .B rstpctl setportpathcost <bridge> <port> <cost>
  91 sets the ports's path cost to <cost>. This is by default set
  92 automatically based on the link speed. This setting overrides the
  93 automatic setting. Setting this to zero puts it back in automatic
  94 mode.
  95
  96 .B rstpctl setportadminedge <bridge> <port> {yes|no}
  97 sets or unsets the port's configuration as an edge port. If a port is
  98 an edge port, then it is assumed to be a leaf link in the graph, not
  99 connected to any other bridges. Receiving any STP BPDU's on a port
 100 configured as an edge port turns off edge port behaviour for the port.
 101
 102 .B rstpctl setportautoedge <bridge> <port> {yes|no}
 103 sets or unsets the port's configuration as an auto edge port.
 104 If it is configured as auto edge, the port is brought up based on a
 105 shorter timer when no response in received and treated as an edge port.
 106 Receiving any STP BPDU's turns off edge port behaviour for the port.
 107
 108 .B rstpctl portmcheck <bridge> <port>
 109 : This command is used when the port is operating in STP compatibility
 110 mode. I causes the bridge to transmit RSTP BPDUs and to test the
 111 hypothesis that non RSTP hosts have been removed from the LAN
 112 connected to the port, and if that is the case, the remaining hosts
 113 switch back to RSTP mode.
 114
 115 .B rstpctl debuglevel <level>
 116 sets the level of verbosity of rstpd's logging.
 117
 118 .SH NOTES
 119 TODO: Indicate lack of persistence of configuration across restarts of
 120 daemon.
 121
 122 .SH SEE ALSO
 123 .BR rstpd(8),
 124 .BR brctl(8)
 125
 126 .SH COPYRIGHT
 127 This manual page Copyright (c) 2006 EMC Corporation.
 128
 129 This manual page is free software; you can redistribute it and/or modify it
 130 under the terms of the GNU General Public License as published by the Free
 131 Software Foundation; either version 2 of the License, or (at your option)
 132 any later version. It comes with NO WARRANTY.
 133 .\" The full GNU General Public License is included in this distribution in the
 134 .\" file called LICENSE.
 135
 136 .SH AUTHOR
 137 Srinivas Aji <Aji_Srinivas@emc.com>