Networking::STPInstanceV2

Introduced : BIG-IP_v11.0.0
The STPInstance interface enables you to work with the definitions and attributes associated with an STP instance. This second version of the interface was created to handle changing the STP instance key from the STP instance identifier to an arbitrary name. Along the way, it also eliminated the unnecessary structures required to handle the STP instance interface members.

Methods

Method Description Introduced
add_vlan Adds/associates VLANs to the specified spanning tree instances. This method may be used only in MSTP mode. In STP or RSTP mode, all VLANs automatically belong to spanning tree instance 0. BIG-IP_v11.0.0
create Creates the specified spanning tree instances. BIG-IP_v11.0.0
delete_all_instances Deletes all spanning tree instances. BIG-IP_v11.0.0
delete_instance Deletes the specified spanning tree instances. BIG-IP_v11.0.0
get_bridge_priority Gets the bridge priorities of the specified spanning tree instances. Each bridge in a spanning tree instance has a priority value, which controls the topology of the spanning tree chosen by the protocol. The bridge with the lowest priority value will become the root of the spanning tree. Priority values range from 0-61440 in steps of 4096. Hence, the supported priorities are: 0 16384 32768 49152 4096 20480 36864 53248 8192 24576 40960 57344 12288 28672 45056 61440 The default bridge priority is 61440, which will prevent BIGIP from being chosen as the root bridge. If the specified bridge priority is not one of the allowed values listed above, it is rounded down to the next lower value in the list. In STP or RSTP mode, only STP intance 0 is valid. BIG-IP_v11.0.0
get_description Gets the descriptions for a set of STP instances. BIG-IP_v11.0.0
get_instance_id Gets the instance ids of the specified spanning tree instances. Note: A set_instance_id method is not supported. BIG-IP_v11.0.0
get_interface_active_state Gets the STP active states for the specified STP port objects. BIG-IP_v11.0.0
get_interface_path_cost Gets the path costs for the specified network interfaces in the specified spanning tree instances. An interface path cost represents the relative cost of sending network traffic through that interface. In calculating the spanning tree, the algorithm tries to minimize the total path cost between each point and the root bridge. By manipulating the path costs of different interfaces, it&aposs possible to steer traffic toward paths that are faster, more reliable, and/or more economical. Path costs have a range of 1-200,000,000, and the default path cost for an interface is based on the interface&aposs maximum speed (not the actual speed). Max interface speed Default path cost 10 Gb/s 2,000 1 Gb/s 20,000 100 Mb/s 200,000 10 MB/s 2,000,000 The default path cost is a function of the interface&aposs maximum speed, not its actual speed, so the default path cost of a 10/100/1000 Mb/s interface will be 20,000 even if the interface is running at 10 Mb/s. Changes in link speed don&apost cause path costs to change. Link aggregation doesn&apost affect the default path cost, i.e. a trunk of four 1 Gb/s interfaces will still have a default path cost of 20,000. In STP or RSTP mode, only STP intance 0 is valid. BIG-IP_v11.0.0
get_interface_priority Gets the priorities for the specified network interfaces in the specified spanning tree instances. These priority values influence which interfaces are chosen to carry network traffic. Interfaces with numerically lower values are favored to carry traffic. Interface priorities have values in the range from 0-240 in steps of 16. Hence, the supported priorities are: 0 64 128 192 16 80 144 208 32 96 160 224 48 112 176 240 The default interface priority is 128. If the specified interface priority is not one of the allowed values listed above, it is rounded down to the next lower value in the list. In STP or RSTP mode, only STP intance 0 is valid. BIG-IP_v11.0.0
get_interface_requested_state Gets the STP requested/configured states for the specified STP port objects. BIG-IP_v11.0.0
get_interface_role Gets the STP roles for the specified STP port objects. BIG-IP_v11.0.0
get_list Gets a list of all spanning tree instances. BIG-IP_v11.0.0
get_regional_root_bridge_mac_address Gets the MAC addresses of the regional root bridges. BIG-IP_v11.0.0
get_root_bridge_mac_address Gets the MAC addresses of the root bridges. BIG-IP_v11.0.0
get_version Gets the version information for this interface. BIG-IP_v11.0.0
get_vlan Gets the lists of VLANs the specified spanning tree instances are associated with. This method may be used only in MSTP mode. In STP or RSTP mode, all VLANs automatically belong to spanning tree instance 0. BIG-IP_v11.0.0
remove_all_vlans Removes all VLANs from the specified spanning tree instances. This method may be used only in MSTP mode. In STP or RSTP mode, all VLANs automatically belong to spanning tree instance 0, and they can not be deleted from it. BIG-IP_v11.0.0
remove_vlan Removes VLANs from the specified spanning tree instances. This method may be used only in MSTP mode. In STP or RSTP mode, all VLANs automatically belong to spanning tree instance 0, and they can not be deleted from it. BIG-IP_v11.0.0
set_bridge_priority Sets the bridge priorities of the specified spanning tree instances. Each bridge in a spanning tree instance has a priority value, which controls the topology of the spanning tree chosen by the protocol. The bridge with the lowest priority value will become the root of the spanning tree. Priority values range from 0-61440 in steps of 4096. Hence, the supported priorities are: 0 16384 32768 49152 4096 20480 36864 53248 8192 24576 40960 57344 12288 28672 45056 61440 The default bridge priority is 61440, which will prevent BIGIP from being chosen as the root bridge. If the specified bridge priority is not one of the allowed values listed above, it is rounded down to the next lower value in the list. In STP or RSTP mode, only STP intance 0 is valid. BIG-IP_v11.0.0
set_description Sets the description for a set of STP instances. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.0.0
set_interface_path_cost Sets the path costs for the specified network interfaces in the specified spanning tree instances. An interface path cost represents the relative cost of sending network traffic through that interface. In calculating the spanning tree, the algorithm tries to minimize the total path cost between each point and the root bridge. By manipulating the path costs of different interfaces, it&aposs possible to steer traffic toward paths that are faster, more reliable, and/or more economical. Path costs have a range of 1-200,000,000, and the default path cost for an interface is based on the interface&aposs maximum speed (not the actual speed). Max interface speed Default path cost 10 Gb/s 2,000 1 Gb/s 20,000 100 Mb/s 200,000 10 MB/s 2,000,000 The default path cost is a function of the interface&aposs maximum speed, not its actual speed, so the default path cost of a 10/100/1000 Mb/s interface will be 20,000 even if the interface is running at 10 Mb/s. Changes in link speed don&apost cause path costs to change. Link aggregation doesn&apost affect the default path cost, i.e. a trunk of four 1 Gb/s interfaces will still have a default path cost of 20,000. In STP or RSTP mode, only STP intance 0 is valid. BIG-IP_v11.0.0
set_interface_priority Sets the priorities for the specified network interfaces in the specified spanning tree instances. These priority values influence which interfaces are chosen to carry network traffic. Interfaces with numerically lower values are favored to carry traffic. Interface priorities have values in the range from 0-240 in steps of 16. Hence, the supported priorities are: 0 64 128 192 16 80 144 208 32 96 160 224 48 112 176 240 The default interface priority is 128. If the specified interface priority is not one of the allowed values listed above, it is rounded down to the next lower value in the list. In STP or RSTP mode, only STP intance 0 is valid. BIG-IP_v11.0.0

Structures

Structure

Description

PathCost

An struct that specifies an unit of interface/trunk path cost.


Enumerations

Enumeration Description
PathCostType A list of path cost types.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
PathCostSequence PathCost [] A sequence of path cost data structures.
PathCostSequenceSequence PathCost [] [] A sequence of path cost data structure sequences.
PathCostTypeSequence PathCostType [] A sequence of path cost types.
PathCostTypeSequenceSequence PathCostType [] [] An alias for a sequence of path cost types.

See Also

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.