Spanning Tree Protocol Commands
stp-modify
This command is used to configure Spanning Tree Protocol (STP).
Syntax stp-modify
mst-config-name name-string |
Soecify the name of the Multiple Spanning Tree (MST) configuration. |
enable|disable |
Specify if you want to enable or disable STP. |
stp-mode rstp|mstp |
Specify the STP mode as RSTP or MSTP. |
Specify one or more of the following options: |
|
bpdus-bridge-ports|bpdus-all-ports |
Specify if you want BPDU packets to bridge specific ports or all ports. |
bridge-priority bridge-priority-number |
Specify the bridge priority. |
hello-time seconds |
Specify the hello time in seconds. This is a value between 1 and 10 seconds. The default value is 2 seconds. |
forwarding-delay seconds |
Specify the forwarding delay in seconds. This is a value between 4 and 30 seconds. |
max-age seconds |
Specify the maximum age of the bridge. This is a value between 6 and 40 seconds. The default value is 20 seconds. |
mst-max-hops number |
Specify the maximum hop count for MSTP BPDUs. The default value is 20 with a range of 1 to 32 hops. |
mst-config-name mst-config-name-string |
Specify the name of the MST configuration instance. |
root-guard-wait-time seconds |
Specify the time to wait for root guard in seconds. The range is 0 (disable) to 300 seconds with a default value of 20 seconds. |
Defaults None.
Access CLI
History .
Version 1.2 |
Command introduced. |
Version 2.4 |
The parameters, mst-config, stp-mode, and mst-max-hops, added. |
Version 3.0.0 |
The parameter, root-guard-wait-time, added. |
Usage STP is a standard inter-switch protocol used to ensure that an ad hoc network topology is loop-free at Layer 2, on a per VLAN basis. If your network connections form loops, and STP is disabled, packets recirculate between the switches and cause a decrease in network performance. If you are certain that your network is loop-free, you do not need to enable STP. Use this command to enable or disable STP on the network.
Examples To enable STP, use the following command:
CLI network-admin@switch > stp-modify enable
stp-show
This command is used to display information about Spanning Tree Protocol (STP) state.
Syntax stp-show
Defaults None.
Access CLI
History .
Version 1.2 |
Command introduced. |
Version 2.4 |
The parameters, mst-config, and mst-max-hops, added. |
Version 3.0.0 |
The parameter, root-guard-wait-time, added. |
Usage STP is a standard inter-switch protocol is used to ensure that an ad hoc network topology is loop-free at Layer 2, on a per VLAN basis. If your network connections form loops, and STP is disabled, packets recirculate between the switches and causes a decrease in network performance. If you are certain that your network is loop-free, you do not need to enable STP. Use this command to enable or disable STP on the network.
Examples To display STP information, use the following command:
CLI network-admin@switch > stp-show
switch: pleiades25
enable: yes
stp-mode: rstp
bpdus-bridge-ports: yes
bridge-id: 66:0e:94:fd:83:de
bridge-priority: 32768
hello-time: 2
forwarding-delay: 15
max-age: 20
root-guard-wait-time: 20
switch: eri-dev01
enable: yes
stp-mode: rstp
bpdus-bridge-ports: yes
bridge-id: 66:0e:94:dd:72:a7
bridge-priority: 32768
hello-time: 2
forwarding-delay: 15
max-age: 20
root-guard-wait-time: 20
stp-port-event-show
This command is used to display information about port events on the switch.
Syntax stp-port-event-show
time date/time: yyyy-mm-ddThh:mm:ss |
Specifies a specific time for an event. |
start-time date/time: yyyy-mm-ddThh:mm:ss |
Specifies the time that the event began. |
end-time date/time: yyyy-mm-ddThh:mm:ss |
Specifies the time that the event ended. |
duration duration: #d#h#m#s |
Specifies the duration in days, hours, minutes, and seconds. |
interval duration: #d#h#m#s |
Specifies the interval between the events. |
since-start |
Specifies if the event is requested since the start time. |
older-than duration: #d#h#m#s |
Specifies if the event is older than the requested duration. |
within-last duration: #d#h#m#s |
Specifies if the event is within the last requested duration. |
port port-number |
Specifies the port number of the event. |
vlan vlan-list |
Specifies the VLAN list for the event. |
instance instance-number |
Specifies the instance for the STP events collection. |
count count-number |
Specifies the number of events. |
initial-state Disabled|Blocking|Listening|Learning|Forwarding |
Specifies the initial state of the event. |
other-state Disabled|Blocking|Listening|Learning|Forwarding |
Specifies if the event had other states. |
final-state Disabled|Blocking|Listening|Learning|Forwarding |
Specifies the final state of the event. |
Defaults None
Access CLI
History
Version 2.0 |
Command introduced. |
Version 2.4.1 |
The parameter, instance, added. |
Usage Use this command to display port event information for STP.
Examples To display STP port events, use the following command:
CLI network-admin@switch > stp-port-event-show
stp-port-modify
This command is used to configure Bridge Protocol Data Unit (BPDU) processing by one or more ports on a switch.
Syntax stp-port-modify
port port-list |
Specify the switch network data port number, list of ports, or a range of ports. The range must be a port number between 1 to 64. |
Specify one or more of the following options: |
|
block|no-block |
Specify if the port blocks BPDUs. |
filter|no-filter |
Specify if the port filters BPDUs. |
edge|no-edge |
Specify if the port is an Edge port. The port can transition directly to a forwarding state but lose Edge port status as soon as any BPDU packets are received. |
bpdu-guard|no-bpdu-guard |
Specify if BPDU guard is on or off. |
root-guard|no-root-guard |
Specify if root guard is on or off. |
priority integer |
Specify the STP port priority as a value between 0 and 240. The default value is 128. |
cost number |
Specify the cost as a number between 1 and 200000000. The default value is 2000. |
Defaults None.
Access CLI
History
Version 1.2 |
Command introduced. |
Version 2.2 |
The parameter edge|no-edge added to support RSTP. The parameter, guard|no-guard, added. |
Version 2.3 |
The parameter, cost, added. |
Version 2.4.1 |
The parameter, priority, added. |
Version 2.6.0 |
The parameter, guard, changed to bpdu-guard, and a new parameter, root-guard, added. |
Usage STP is a standard inter-switch protocol is used to ensure that an ad hoc network topology is loop-free at Layer 2, on a per VLAN basis. If your network connections form loops, and STP is disabled, packets recirculate between the switches and causes a decrease in network performance. If you are certain that your network is loop-free, you do not need to enable STP. BPDUs are used in the election of the STP root switch and should not be received from an end host port. This command can block one port or multiple ports from processing BPDUs to prevent a malicious end host from masquerading as a switch and participating in the STP root election.If a BPDU is received by a port that is configured to block BPDUs, the port is shut down. Alternatively, you can filter BPDUs on a port. If the port is configured to filter BPDUs, the BPDU packet is dropped but the port is not shut down.
Examples To block BPDUs and shut down port 17, use the following command:
CLI network-admin@switch > stp-port-modify port 17 block on
stp-port-show
This command is used to display the configuration for Bridge Protocol Data Unit (BPDU) processing by one or more ports on a switch.
Syntax stp-port-show
port port-list |
Specify the switch network data port number, list of ports, or a range of ports. The range must be a port number between 1 to 64. |
block off|on |
Specify if the port blocks BPDUs. |
filter off|on |
Specify if the port filters BPDUs. |
port-fast| |
Specify if the port is enabled for PortFast. PortFast allows a port to enter the forwarding state almost immediately by dramatically decreasing the time of the listening and learning states. |
edge|no-edge |
Specify if the port is an Edge port. The port can transition directly to a forwarding state but lose Edge port status as soon as any BPDU packets are received. |
bpdu-guard|no-bpdu-guard |
Specify if BPDU guard is on or off. |
root-guard|no-root-guard |
Specify if root guard is on or off. |
priority integer |
Specify the STP port priority as a value between 0 and 240. The default value is 128. |
cost number |
Specify the cost as a number between 1 and 200000000. The default value is 2000. |
Defaults None.
Access CLI
History
Version 1.2 |
Command introduced. |
Version 2.2 |
The parameter edge|no-edge added to support RSTP. The parameter, guard|no-guard, added. |
Version 2.3 |
The parameter, cost, added. |
Version 2.4.1 |
The parameter, priority, added. |
Version 2.6.0 |
The parameter, guard, changed to bpdu-guard, and a new parameter, root-guard, added. |
Usage STP is a standard inter-switch protocol is used to ensure that an ad hoc network topology is loop-free at Layer 2, on a per VLAN basis. If your network connections form loops, and STP is disabled, packets recirculate between the switches and causes a decrease in network performance. If you are certain that your network is loop-free, you do not need to enable STP.
Examples To display configuration information, use the following command:
CLI network-admin@switch > stp-port-show port 17
switch: pubdev01
port: 55
block: off
filter: off
edge: yes
guard: no
switch: pubdev01
port: 65
block: off
filter: off
guard: no
switch: pubdev01
port: 66
block: off
filter: off
guard: no
stp-port-state-show
This command is used to display information about the state of Spanning Tree Protocol (STP) ports.
Syntax stp-port-state-show
vlan vlan-id |
Displays the VLAN identifier for the STP instance. |
ports port-list |
Displays STP ports. |
stp-state Disabled|Discarding|Learning|Forwarding |
Displays the forwarding state. |
role Disabled|Root|Designated|Alternate|Backup |
Displays the port role. |
selected-role Disabled|Root|Designated|Alternate|Backup |
Displays the selected port role. |
state new-info|proposing|proposed|agreed|agreed|learn|learning|forward|forwarding|reselect|selected|reroot|rcvd-bpdu|rcvd-msg|rcvd-tc|rcvd-tc-ack|send-rstp|tc-prop|tc-ack|update-info|sync|synced|disputed|fdb-flush|online|looping|manual-online|edge|vlag-local-up|vlag-remote-up|requested-online|first-sync|p-is-d|p-is-m|root-guard-active |
Displays the port state machine state. |
designated-priority designated-priority-string |
Displays the designated priority vector. |
port-priority port-priority-string |
Displays the port priority vector. |
message-priority message-priority-string |
Displays the message priority vector. |
info-is disabled|received|mine|aged |
Displays the origin of the port information. |
designated-times designated-times-string |
Displays the designated times: age, max age, hello, forward delay |
port-times port-times-string |
Displays the port times: age, max age, hello, forward delay. |
message-times message-times-string |
Displays the message times: age, max age, hello, forward delay. |
hello-timer hello-timer-number |
Displays the hello time value. |
topology-timer topology-timer-number |
Displays the topology timer value. |
forward-timer forward-timer-number |
Displays the forward timer value. |
rcvd-info-timer rcvd-info-timer-number |
Displays the received info timer value. |
recent-root-timer recent-root-timer-number |
Displays the recent root timer value. |
recent-backup-timer recent-backup-timer-number |
Displays the recent backup timer value. |
edge-delay-timer edge-delay-timer-number |
Displays the edge delay timer value. |
migration-timer migration-timer-number |
Displays the migration timer value. |
sm-table-bits sm-table-bits-number |
Displays the state machine table state. |
sm-table sm-table-string |
Displays the state machine table description |
vlag-peer-port vlag-peer-port-number |
Displays the VLAG peer port if it is an active-active VLAG. |
peer|no-peer |
Displays the STP peer state. |
Defaults None.
Access CLI
History Command introduced in Version 2.4.1.
Usage STP is a standard inter-switch protocol is used to ensure that an ad hoc network topology is loop-free at Layer 2, on a per VLAN basis. If your network connections form loops, and STP is disabled, packets recirculate between the switches and causes a decrease in network performance. If you are certain that your network is loop-free, you do not need to enable STP. One drawback of STP is that it does not allow for Layer 2 multipathing and may result in suboptimal utilization of available network links. Therefore, a fabric of Pluribus Networks switches does not use STP within the boundaries of the fabric. The use of STP is recommended for ad hoc networks that interoperate in a heterogeneous, multi-vendor switch environment. Use this command to enable or disable STP on the network.
Examples To display STP port state information, use the following command:
CLI network-admin@switch > stp-port-state-show
stp-state-show
This command is used to display information about the state of Spanning Tree Protocol (STP).
Syntax stp-state-show
vlan vlan-id |
Displays the VLAN identifier for the STP instance. |
ports port-list |
Displays STP ports. |
instance-id instance-id-number |
Displays the STP instance ID. |
name name-string |
Specifies the name of the Spanning Tree Group (STG) for the STP instance. |
bridge-id mac-address |
Specifies the MAC address of the bridge switch. |
bridge-priority bridge-priority- |
Specifies the priority for the bridge switch. |
root-id mac-address |
Specifies the MAC address of the root switch. |
root-priority root-priority-number |
Specifies the priority for the root switch. |
root-port root-port-number |
Specifies the root port for STP. |
root-port(peer) root-port(peer)-number |
Specifies the peer root port for STP. |
hello-time hello-time-number |
Specifies the interval, in seconds, between the generation of configuration messages by the root switch. |
forwarding-delay forwarding-delay- |
Specifies the number of seconds that the interface waits before changing from its spanning-tree learning and listening states to the forwarding state. |
max-age max-age-number] |
Specifies the amount of time that the switch stores protocol information received on an interface. |
internal|no-internal |
Specifies if it is an internal port. |
[peer|no-peer] |
Specifies if it is a peer port or not. |
Defaults None.
Access CLI
History
Version 1.2 |
Command introduced. |
Version 2.2 |
The parameter, blocking, removed, and edge, designated, alternate, backup, vlag-mirror, internal, and peer added to support RSTP. |
Version 2.2.6 |
The parameter, root-port(peer), added. |
Version 2.3 |
The following parameters are deprecated: • disabled • learning • forwarding • discarding • edge • designated • alternate • backup • vlag-mirror |
Version 2.3.1 |
The parameter, ports, added. |
Version 2.4.1 |
The parameter, instance-id, added. |
Usage STP is a standard inter-switch protocol is used to ensure that an ad hoc network topology is loop-free at Layer 2, on a per VLAN basis. If your network connections form loops, and STP is disabled, packets recirculate between the switches and causes a decrease in network performance. If you are certain that your network is loop-free, you do not need to enable STP. One drawback of STP is that it does not allow for Layer 2 multipathing and may result in suboptimal utilization of available network links. Therefore, a fabric of Pluribus Networks switches does not use STP within the boundaries of the fabric. The use of STP is recommended for ad hoc networks that interoperate in a heterogeneous, multi-vendor switch environment. Use this command to enable or disable STP on the network.
Examples To display STP information, use the following command:
CLI network-admin@switch > stp-state-show
switch: pleiades25
vlan: 1
name: stg-default-stg
bridge-id: 64:0e:94:18:00:8f
bridge-priority: 32769
root-id: 64:0e:94:18:00:8f
root-priority: 32769
root-port: 0
hello-time: 2
forwarding-delay: 15
max-age: 20
disabled: none
learning: none
forwarding: 12,56,65-66,255
discarding: none
edge: 65-66
designated: 12,56,65-66,255
alternate: none
backup: none
vlag-mirror: none