Switch CLI Reference Guide
- Introduction
- System Commands
- ACL Commands
- Domain Name Server (DNS) Commands
- Energy Efficient Ethernet (EEE) Commands
- Internet Group Management Protocol (IGMP) Commands
- IP Commands
- Link Aggregation Commands
- Loopback Detection Commands
- Link Layer Discovery Protocol Commands
- Monitor (Mirror) Commands
- Port-Based Network Access Control Commands
- Power Over Ethernet Commands
- Quality of Service Commands
- RADIUS Commands
- Remote Network Monitoring (RMON) Commands
- Simple Network Management Protocol (SNMP) Commands
- Simple Network Time Protocol (SNTP) Commands
- Spanning Tree Commands
- Secure Shell Commands
- Syslog Commands
- VLAN Commands
- Voice VLAN Commands
- SonicWall Support
Spanning Tree Commands
Command Objective |
This command enables the spanning tree operation in the Switch for the selected spanning tree Mode. Spanning tree operation provides path redundancy while preventing undesirable loops in the network that are created by multiple active paths between stations. It logically breaks such loops and prevents looping traffic from clogging the network. The no form of this command disables the spanning tree operation in the Switch. The spanning tree operation is automatically enabled in the Switch, once the spanning tree Mode is changed. The spanning tree operation can be enabled in the Switch only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set, if the functionality is already shutdown. |
Syntax |
|
Mode | Global Configuration Mode |
Command Objective |
This command sets the type of spanning tree to be executed, enables spanning tree operation and starts spanning tree functionality in the Switch. The current selected type of spanning tree is enabled and the existing spanning tree type is disabled in the Switch. |
Syntax |
|
Parameter Description |
|
Mode | Global Configuration Mode |
Command Objective |
This command sets the spanning tree timers such as hello time, that are used for controlling the transmission of BPDUs during the computation of loop free topology. The no form of this command resets the spanning tree timers to its default values. The spanning tree timers are reset to its default value, even if the spanning tree Mode is changed.
The values configured for the spanning tree timers should satisfy the following conditions: 2 * (forward-time - 1) >= max-age, and max-age >= 2 * (hello-time +1) The STP timers can be configured in the Switch, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set, if the functionality is already shutdown. This spanning tree timer’s configuration is not supported in PVRST Mode. |
Syntax |
|
Parameter Description |
|
Mode | Global Configuration Mode |
Command Objective |
This command sets the transmit hold-count value for the Switch. The transmit hold count value is a counter that is used to limit the maximum transmission rate of the Switch and to avoid flooding. This value specifies the maximum number of packets that can be sent in a given hello time interval. This value ranges between 1 and 10. The no form of this command sets the transmit hold-count to its default value. The transmit hold-count is changed to its default value even if the spanning tree Mode is changed. The transmit hold-count value can be configured in the Switch, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set, if the functionality is already shutdown. |
Syntax |
|
Parameter Description |
|
Mode | Global Configuration Mode |
Command Objective |
This command configures the priority value that is assigned to the Switch. The no form of this command resets the priority to its default value. The priority value is changed to its default value even if the spanning tree Mode is changed. In RSTP, this value is used during the election of root. In MSTP, this value is used during the election of CIST root, CIST regional root and IST root. The priority value can be configured in the Switch, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set, if the functionality is already shutdown. |
Syntax |
|
Parameter Description |
|
Mode | Global Configuration Mode |
Command Objective |
This command configures the forward timer of the spanning tree and the no form of the command sets the forward timer to the default value. The forward timer controls the speed at which a port changes its spanning tree state from Blocking state to Forwarding state. The timer value ranges between 4 and 30 seconds.
The values configured for the spanning tree forward timers should satisfy the following conditions: 2* (forward-time - 1) >= max-age, and max-age >= 2 * (hello- time +1) This command is a standardized implementation of the existing command; spanning-tree timers. It operates similar to the existing command. The STP forward timers can be configured in the Switch, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set, if the functionality is already shutdown. |
Syntax |
|
Mode | Global Configuration Mode |
Command Objective |
This command configures the max-age timer of the spanning tree.The max-age timer denotes the time (in seconds) after which the spanning tree protocol information learnt from the network on any port will be discarded. The timer value ranges between 6 and 40 seconds. The no form of the command sets the max-age timer to the default value.
The values configured for the spanning tree forward timers should satisfy the following conditions: 2* (forward-time - 1) >= max-age, and max-age >= 2 * (hello- time +1) This command is a standardized implementation of the existing command; spanning-tree timers. It operates similar to the existing command. The STP forward timers can be configured in the Switch, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set, if the functionality is already shutdown. |
Syntax |
|
Mode | Global Configuration Mode |
Command Objective |
This command configures the spanning tree hello time. The no form of this command resets the hello time to its default value. The hello time represents the time interval (in seconds) between two successive configuration BPDUs generated by the Switch on the port. This value is either 1 or 2 seconds. This value is applied to all active MSTIs. This command can be executed successfully, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set as mst. |
Syntax |
|
Mode | Global Configuration Mode |
Command Objective |
This command deletes all bridge and port level spanning tree statistics information. For RSTP, the information contains number of:
For MSTP, the information contains number of:
The statistics information can be deleted, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set, if the functionality is already shutdown. |
Syntax |
|
Parameter Description |
|
Mode | Global Configuration Mode |
Command Objective |
This command configures the maximum number of active MSTIs that can be created. This value ranges between 1 and 64. The no form of this command resets maximum MSTP instance value to its default value. This command can be executed successfully, only if the spanning tree functionality is started and enabled in the Switch. The type of spanning tree Mode should be set as mst. |
Syntax |
|
Mode | Global Configuration Mode |
Command Objective |
This command enables BPDU (Bridge Protocol Data Unit) transmission and reception on the interface. This command is a standardized implementation of the existing command; spanning-tree priority. It operates similar to the existing command. The no form of the command disables BPDU transmission and reception on the interface. This command executes only if:
|
Syntax |
|
Parameter Description |
|
Mode | Global Configuration Mode |
Command Objective |
This command enters into MSTP configuration Mode, where instance specific and MST region configuration can be done. This command can be executed successfully, only if the spanning tree functionality is started and enabled in the Switch. The type of spanning tree Mode should be set as mst. |
Syntax |
|
Mode | Global Configuration Mode |
Command Objective |
This command configures the name for the MST region. The name is unique and used to identify the specific MST region. Each MST region contains multiple spanning tree instances and runs special instance of spanning tree known as IST to disseminate STP topology information for other STP instances. The no form of this command resets the name to its default value. |
Syntax |
|
Mode | MSTP Configuration Mode |
Command Objective |
This command configures the revision number for the MST region. This value ranges between 0 and 65535. The no form of this command resets the revision number to its default value. |
Syntax |
|
Mode | MSTP Configuration Mode |
Command Objective |
This command creates an MST instance and maps it to VLANs. The no form of this command deletes the instance / unmaps specific VLANs from the MST instance. |
Syntax |
|
Mode | MSTP Configuration Mode |
Command Objective |
This command enables automatic detection of Edge port parameter of an interface. The no form of this command disables automatic detection of Edge port parameter of an interface. The automatic detection of Edge port parameter is disabled, even if the spanning tree Mode is changed. Once automatic detection is enabled, the Edge port parameter is automatically detected and set. The port is set as edge port, if no BPDU is received on the port. The port is set as non-edge port, if any BPDU is received. The automatic detection of Edge port parameter can be configured in the Switch, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set, if the functionality is already shutdown. |
Syntax |
|
Mode | Interface Configuration Mode |
Command Objective |
This command configures the port related spanning tree information for all kinds of STPs. This can be applied for any port, in RSTP/MSTP Mode. This command creates port in STP when Automatic Port Create feature is disabled. The no form of this command resets the port related spanning tree information to its default value. The port related spanning tree information is changed to its default value even if the spanning tree Mode is changed. This command also deletes port in STP when Automatic Port Create feature is disabled. In STP module, whenever a port is mapped to any context, the corresponding port is created irrespective of whether STP is intended to be enabled on that interface. This leads To STP scaling issues and this problem is solved by having control at STP module on the port entry creation at STP module itself. |
Syntax |
|
Parameter Description |
|
Mode | Interface Configuration Mode |
Command Objective |
This command configures the port related spanning tree information for a specified MSTI in a port. The no form of this command resets the spanning tree information of a port to its default value. This command can be executed successfully, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set as mst. |
Syntax |
|
Parameter Description |
|
Mode | Interface Configuration Mode |
Command Objective |
This command displays spanning tree related information available in the Switch for the current STP enabled in the Switch. The information contain priority, address and timer details for root and bridge, status of dynamic pathcost calculation feature, status of spanning tree function, STP compatibility version used, configured spanning tree Mode, bridge and port level spanning tree statistics information, and details of ports enabled in the Switch. The port details contain port ID, port role, port state, port cost, port priority and link type. This command can be executed successfully, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set, if the functionality is already shutdown. |
Syntax |
|
Parameter Description |
|
Mode | Privileged EXEC Mode |
Command Objective |
This command displays detailed spanning tree related information of the Switch and all ports enabled in the Switch. The information contains status of spanning tree operation, current selected spanning Mode, current spanning tree compatibility version, bridge and root priority, bridge and root addresses, port path cost, port priority, port timers, bridge and port level spanning tree statistics information, transmit hold- count value, link-type, and status of L2GP, loop guard, BPDU receive, BPDU transmit, restricted TCN, restricted role and portfast features. This command can be executed successfully, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set, if the functionality is already shutdown. |
Syntax |
|
Parameter Description |
|
Mode | Privileged EXEC Mode |
Command Objective |
This command displays spanning tree related information available in the Switch for the current STP enabled in the Switch. The information contains priority, address and timer details for root and bridge, status of dynamic pathcost calculation feature, status of spanning tree function, STP compatibility version used, configured spanning tree Mode, bridge and port level spanning tree statistics information, and details of ports enabled in the Switch. The port details contain port ID, port role, port state, port cost, port priority and link type. This command can be executed successfully, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set, if the functionality is already shutdown. |
Syntax |
|
Parameter Description |
|
Mode | Privileged EXEC Mode |
Command Objective |
This command displays the port related spanning tree information for the specified interface. The information contains port ID, port role, port state, port cost, port priority and link type. This command can be executed successfully, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set, if the functionality is already shutdown. |
Syntax |
|
Parameter Description |
|
Mode | Privileged EXEC Mode |
Command Objective |
This command displays the spanning tree root information. The information contain root ID, root path cost, maximum age time, forward delay time and root port, for the RSTP. The information also contains the instance ID for MSTP. This command can be executed successfully, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set, if the functionality is already shutdown. |
Syntax |
|
Parameter Description |
|
Mode | Privileged EXEC Mode |
Command Objective |
This command displays the spanning tree bridge information. The information contain bridge ID, hello time, maximum age time, forward delay time and protocol enabled, for the RSTP. The information also contains the instance ID for MSTP. This command can be executed successfully, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set, if the functionality is already shutdown. |
Syntax |
|
Parameter Description |
|
Mode | Privileged EXEC Mode |
Command Objective |
This command displays multiple spanning tree information for all MSTIs in the Switch. The information contain MSTI ID, VLAN IDs mapped to the instance, bridge address and priority, root address and priority, IST root address, priority and path cost, forward delay, maximum age, maximum hop count, and port details of interfaces enabled in the Switch. The port details contain interface ID, port role, port state, port cost, port priority and port link type. This command can be executed successfully, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set as mst. |
Syntax |
|
Parameter Description |
|
Mode | Privileged EXEC Mode |
Command Objective |
This command displays multiple spanning tree instance related information. This information contains the MST region name, MST region revision, and a list containing MSTI IDs and VLAN IDs mapped to the corresponding MSTI. This command can be executed successfully, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set as mst. |
Syntax |
|
Parameter Description |
|
Mode | Privileged EXEC Mode |
Command Objective |
This command displays multiple spanning tree port specific information for the specified port. This information contain interface ID, edge port status, port link type, port hello time, BPDUs sent and received on the port, and instance related details. The instance details contain MSTI ID, MSTI role, MSTI status, MSTI cost and MSTI priority. This command can be executed successfully, only if the spanning tree functionality is not shutdown in the Switch. The type of spanning tree Mode should be set as mst. |
Syntax |
|
Parameter Description |
|
Mode | Privileged EXEC Mode |
Was This Article Helpful?
Help us to improve our support portal