Networking::STPGlobals¶
Introduced : BIG-IP_v9.0
The STPGlobals interface enables you to work with global attributes
used to configure STP (Spanning Tree Protocol).
Methods¶
| Method | Description | Introduced |
| get_configuration_identifier | Gets the configuration identifier name in a spanning tree region, used to identify a group of adjacent bridges with identical configuration name, configuration revision levels, and assignments of VLANs to spanning tree instances. This setting is used only when the STP mode is MSTP, however the user may set it in any STP mode. | BIG-IP_v9.0 |
| get_configuration_revision | Gets the configuration revision level of the MSTP configuration. It&aposs used only when the STP mode is MSTP, however, the user may set it in any STP mode. | BIG-IP_v9.0 |
| get_description | Gets the STP global description. | BIG-IP_v11.0.0 |
| get_forward_delay | Gets the forward delay parameter, which controls how long an interface was blocked from forwarding network traffic after a reconfiguration of the spanning tree topology. The default value is 15 seconds, and the valid range is 4-30 seconds. Note that this parameter has no effect when the STP mode is RSPT or MSTP, as long as all bridges in the spanning tree use the RSTP or MSTP protocol. | BIG-IP_v9.0 |
| get_hello_time | Gets the hello time, which is 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-10 seconds. | BIG-IP_v9.0 |
| get_maximum_age | Gets the maximum age parameter, which controls how long spanning tree information received from other bridges is considered valid. The default value is 20 seconds, and the valid range is 6-40 seconds. | BIG-IP_v9.0 |
| get_maximum_hop | Gets the maximum hops an MSTP packet may travel before it is discarded. It&aposs used only when the STP mode is MSTP, however, the user may set it in any STP mode. | BIG-IP_v9.0 |
| get_mode | Gets the STP mode. | BIG-IP_v9.0 |
| get_transmit_hold | Gets the transmit hold count parameter, which is an absolute limit on the number of spanning tree protocol packets the BIG-IP may transmit on a port in any hello time interval. This ensures that the spanning tree packets will not unduly load the network even in unstable conditions. The default value is 6 packets, and the valid range is 1-10 packets. | BIG-IP_v9.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.0 |
| set_configuration_identifier | Sets the configuration identifier name in a spanning tree region, used to identify a group of adjacent bridges with identical configuration name, configuration revision levels, and assignments of VLANs to spanning tree instances. This setting is used only when the STP mode is MSTP, however the user may set it in any STP mode. | BIG-IP_v9.0 |
| set_configuration_revision | Sets the configuration revision level of the MSTP configuration. It&aposs used only when the STP mode is MSTP, however, the user may set it in any STP mode. | BIG-IP_v9.0 |
| set_description | Sets the STP global description. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_forward_delay | Sets the forward delay parameter, which controls how long an interface was blocked from forwarding network traffic after a reconfiguration of the spanning tree topology. The default value is 15 seconds, and the valid range is 4-30 seconds. Note that this parameter has no effect when the STP mode is RSPT or MSTP, as long as all bridges in the spanning tree use the RSTP or MSTP protocol. | BIG-IP_v9.0 |
| set_hello_time | Sets the hello time, which is 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-10 seconds. | BIG-IP_v9.0 |
| set_maximum_age | Sets the maximum age parameter, which controls how long spanning tree information received from other bridges is considered valid. The default value is 20 seconds, and the valid range is 6-40 seconds. | BIG-IP_v9.0 |
| set_maximum_hop | Sets the maximum hops an MSTP packet may travel before it is discarded. It&aposs used only when the STP mode is MSTP, however, the user may set it in any STP mode. | BIG-IP_v9.0 |
| set_mode | Sets the STP mode. | BIG-IP_v9.0 |
| set_transmit_hold | Sets the transmit hold count parameter, which is an absolute limit on the number of spanning tree protocol packets the BIG-IP may transmit on a port in any hello time interval. This ensures that the spanning tree packets will not unduly load the network even in unstable conditions. The default value is 6 packets, and the valid range is 1-10 packets. | BIG-IP_v9.0 |
See Also¶
iControl ::
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
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.