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 rstp <bridge> {on|off}
  22 configures whether rstpd implements RSTP (Rapid Spanning Tree
  23 Protocol) for the specified bridge. The remaining commands are
  24 applicable only if rstpd is configured to run RSTP on that bridge.
  25
  26 .B rstpctl showbridge [<bridge> ... ]
  27 displays the spanning tree configuration and status for the specified
  28 bridges. If no bridges are given, it displays the information for all
  29 bridges.
  30
  31 .B rstpctl showport <bridge> [<port> ... ]
  32 displays, as one line per port, the spanning tree configuration and
  33 status for the specified ports. If no ports are specified, it displays
  34 the information for all ports of the bridge.
  35
  36 The format of the line is :
  37 .br
  38 .B "pes  name iiii sss  rrrr-rootbridgeid dddd-desgbridgeid dprt R"
  39 .br
  40 where the following abbreviations are used.
  41
  42 \fBp\fR: '*' if the port link is not point to point, ' ' otherwise.
  43 .br
  44 \fBe\fR: 'E' if the port is operating as an edge port, ' ' otherwise.
  45 .br
  46 \fBs\fR: 's' if the port is in STP (slow) mode, ' ' otherwise.
  47 .br
  48 \fBname\fR: The name of the port, i.e, the network interface name.
  49 .br
  50 \fBiiii\fR: The port id, containing the port priority and port number
  51 .br
  52 \fBsss\fR: The port state, one of Dis (disabled), Blk (blocking), Lrn
  53 (learning), Fwd (forwading), Non (non-stp), Unk (unknown).
  54 .br
  55 \fBrrrr-rootbridgeid\fR: Root bridge id, including priority.
  56 .br
  57 \fBdddd-desgbridgeid\fR: Designated bridge id, including priority
  58 .br
  59 \fBdprt\fR: Designated port id
  60 .br
  61 \fBR\fR: Port role, one of 'A' (alternate), 'B' (backup), 'R' (root), 'D'
  62 (designated), '-' (non-stp)
  63
  64
  65 .B rstpctl showportdetail <bridge> [<port> ... ]
  66 displays the spanning tree configuration and status for the specified
  67 ports much more verbosely. If no ports are specified, it displays the
  68 information for all ports of the bridge.
  69
  70 .B rstpctl setbridgestate <bridge> {on|off}
  71 enables/disables the operation of RSTP. When RSTP is configured with
  72 the
  73 .BR rstp
  74 subcommand listed above, the default is enabled.
  75
  76 .B rstpctl setbridgeprio <bridge> <priority>
  77 sets the bridge's priority to <priority>. The priority value is a
  78 number between 0 and 61440 in steps of 4096, and defaults to 32768.
  79 Lower priority values are 'better'. The bridge with the lowest
  80 priority will be elected 'root bridge'.
  81
  82 .B rstpctl sethello <bridge> <time>
  83 sets the bridge's 'bridge hello time' to <time> seconds.
  84
  85 .B rstpctl setmaxage <bridge> <time>
  86 sets the bridge's 'maximum message age' to <time> seconds.
  87
  88 .B rstpctl setfdelay <bridge> <time>
  89 sets the bridge's 'bridge forward delay' to <time> seconds.
  90
  91 .B rstpctl setforcevers <bridge> {normal|slow}
  92 sets the bridge's spanning tree algorithm to operate in normal
  93 (i.e. RSTP) mode or force it to operate in slow (i.e. old STP)
  94 mode. In normal mode, RSTP falls back to STP on ports where it
  95 sees other hosts operating in STP mode.
  96
  97 .B rstpctl setportprio <bridge> <port> <priority>
  98 sets the ports's priority to <priority>. The priority value is a
  99 number from 0 to 240 in steps of 16, defaulting to 128.
 100
 101 .B rstpctl setportpathcost <bridge> <port> <cost>
 102 sets the ports's path cost to <cost>. This is by default set
 103 automatically based on the link speed. This setting overrides the
 104 automatic setting. Setting this to zero puts it back in automatic
 105 mode.
 106
 107 .B rstpctl setportedge <bridge> <port> {yes|no}
 108 sets or unsets the port's configures as an edge port. If a port is an
 109 edge port, then it is assumed to be a leaf link in the graph, not
 110 connected to any other bridges. Receiving any STP BPDU's on a port
 111 configured as an edge port turns off edge port behaviour for the port.
 112
 113 .B rstpctl setportnonstp <bridge> <port> {yes|no}
 114 : Setting this to yes disables RSTP operation on the port, which then
 115 is always kept in FORWARDING state.
 116
 117 .B rstpctl portmcheck <bridge> <port>
 118 : This command is used when the port is operating in STP compatibility
 119 mode. I causes the bridge to transmit RSTP BPDUs and to test the
 120 hypothesis that non RSTP hosts have been removed from the LAN
 121 connected to the port, and if that is the case, the remaining hosts
 122 switch back to RSTP mode.
 123
 124 .B rstpctl debuglevel <level>
 125 sets the level of verbosity of rstpd's logging.
 126
 127 .SH NOTES
 128 TODO: Indicate lack of persistence of configuration across restarts of
 129 daemon.
 130
 131 .SH SEE ALSO
 132 .BR rstpd(8),
 133 .BR brctl(8)
 134
 135 .SH COPYRIGHT
 136 This manual page Copyright (c) 2006 EMC Corporation.
 137
 138 This manual page is free software; you can redistribute it and/or modify it
 139 under the terms of the GNU General Public License as published by the Free
 140 Software Foundation; either version 2 of the License, or (at your option)
 141 any later version. It comes with NO WARRANTY.
 142 .\" The full GNU General Public License is included in this distribution in the
 143 .\" file called LICENSE.
 144
 145 .SH AUTHOR
 146 Srinivas Aji <Aji_Srinivas@emc.com>