APIRef_tm_net_stp-globals¶

mgmt/tm/net/stp-globals

Global STP configuration, applies to all STP configuration items

REST Endpoints

Collection URI: /mgmt/tm/net/stp-globals
Collection Methods: OPTIONS, GET
Resource URI: /mgmt/tm/net/stp-globals/~resource id
Resource Methods: OPTIONS, GET, PUT, PATCH

Properties

Name	Type	Default Value	Required	Access	Description
`configName`	string		optional	read/write	Specifies the configuration name (1 - 32 characters in length) only when the spanning tree mode is MSTP. The default configuration name is a string representation of a globally-unique MAC address belonging to the traffic management system.The MSTP standard introduces the concept of spanning tree regions, which are groups of adjacent bridges with identical configuration names, configuration revision levels, and assignments of VLANs to spanning tree instances.
`configRevision`	integer	0	optional	read/write	Specifies the revision level of the MSTP configuration only when the spanning tree mode is MSTP. The specified number must be in the range 0 to 65535. The default value is 0 (zero).
`description`	string		optional	read/write	User defined description.
`fwdDelay`	integer	15	optional	read/write	In the original Spanning Tree Protocol, the forward delay parameter controlled the number of seconds for which an interface was blocked from forwarding network traffic after a reconfiguration of the spanning tree topology. This parameter has no effect when RSTP or MSTP are used, as long as all bridges in the spanning tree use the RSTP or MSTP protocol. If any legacy STP bridges are present, then neighboring bridges must fall back to the old protocol, whose reconfiguration time is affected by the forward delay value. The default forward delay value is 15, and the valid range is 4 to 30.
`helloTime`	integer	2	optional	read/write	Specifies the time interval in seconds between the periodic transmissions that communicate spanning tree information to the adjacent bridges in the network. The default value is 2 seconds, and the valid range is 1 to 10. The default hello time is optimal in virtually all cases. F5 recommends that you do not change the hello time.
`maxAge`	integer	20	optional	read/write	Specifies the number of seconds for which spanning tree information received from other bridges is considered valid. The default value is 20 seconds, and the valid range is 6 to 40 seconds.
`maxHops`	integer	20	optional	read/write	Specifies the maximum number of hops an MSTP packet may travel before it is discarded. Use this option only when the spanning tree mode is MSTP. The number of hops must be in the range of 1 to 255 hops. The default number of hops is 20.
`mode`	string	passthru	optional	read/write	Specifies the spanning tree modes.
`transmitHold`	integer	6	optional	read/write	Specifies the absolute limit on the number of spanning tree protocol packets the traffic management system may transmit on a port in any hello time interval. It is used to ensure that spanning tree packets do not unduly load the network even in unstable situations. The default value is 6 packets, and the valid range is 1 to 10 packets.

iControl Reference Index

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.