f5os_stp_config – Manage STP config

New in version 1.8.0.

Synopsis

  • Manages STP config.

Parameters

Parameter Choices/Defaults Configuration Comments
bridge_priority
integer
Default:
32768
Specifies the bridge in the spanning tree with the lowest relative priority becomes the root bridge.
The default value is 32768. The valid range is from 0 to 61440 in multiples of 4096.
forwarding_delay
integer
Default:
15
Specifies the amount of time, in seconds, that the system blocks an interface from forwarding network traffic.
The default value is 15, and the valid range is from 4 to 30.
This has no effect when running in RSTP or MSTP unless using an added legacy STP bridge.
hello_time
integer
Default:
2
Specifies the time interval, in seconds, that the rSeries system transmits spanning tree information to adjacent bridges in the network.
The default value is 2.
hold_count
integer
Default:
6
Specifies the maximum number of spanning tree frames (BPDUs) that the system can transmit on a port within the Hello Time interval.
This ensures that spanning tree frames do not overload the network. The default value is 6, and the valid range is from 1 to 10.
interfaces
dictionary
S
p
e
c
i
f
i
e
s
i
n
t
e
r
f
a
c
e
s
f
o
r
w
h
i
c
h
w
e
w
a
n
t
t
o
e
n
a
b
l
e
S
T
P
.
cost
integer
Default:
1
Used to calculate the cost of sending spanning tree traffic through the interface to an adjacent bridge or spanning tree region.
The default value is 0, and the valid range is from 1 (lowest) to 200,000,000 (highest).
edge_port
string
    Choices:
  • EDGE_AUTO ←
  • EDGE_ENABLE
  • EDGE_DISABLE
Needed only for RSTP or MSTP.
When enabled, indicates the interface or LAG is an edge port that does not receive any BPDU frames.
Set to EDGE_AUTO, EDGE_ENABLE, or EDGE_DISABLE.
Enabling EDGE-ENABLE, if interface later receives BPDUs, the system disables the setting automatically, as only non-edge interfaces receive BPDUs.
link_type
string
    Choices:
  • P2P ←
  • SHARED
Specifies the type of optimization.
P2P Optimizes for point-to-point spanning tree links (connects two spanning tree bridges only).
Note that P2P is the only valid STP link type for a LAG.
SHARED Optimizes for shared spanning tree links (connecting two or more spanning tree bridges).
The default value is P2P.
name
string
Specifies Interface to configure.
port_priority
integer
Default:
128
Used as the port identifier together with the slot/port numbers.
The default value is 128 (when an interface is selected), and the valid range is from 0 (highest) to 240 (lowest) in multiples of 16.
max_age
integer
Default:
20
Specifies the length of time, in seconds, that spanning tree information received from other bridges is considered valid.
The default value is 20, and the valid range is from 6 to 40.
mode
string
added in 1.14.0
    Choices:
  • stp ←
  • rstp
  • mstp
Specifies the mode of the spanning tree protocol.
The default value is STP.
mstp_instances
list / elements=dictionary
added in 1.14.0
Specifies the MSTP instances to configure.
bridge_priority
integer
Specifies the bridge priority for the mstp instance.
instance_id
integer
Specifies the mstp instance ID.
interface
dictionary
Specifies the interface associated with the mstp instance.
cost
integer
Used to calculate the cost of sending spanning tree traffic through the interface to an adjacent bridge or spanning tree region.
edge_port
string
    Choices:
  • EDGE_AUTO
  • EDGE_ENABLE
  • EDGE_DISABLE
Specifies whether the interface is an edge port.
When enabled, indicates the interface or LAG is an edge port that does not receive any BPDU frames.
link_type
string
    Choices:
  • P2P
  • SHARED
Specifies the type of optimization.
P2P Optimizes for point-to-point spanning tree links (connects two spanning tree bridges only).
Note that P2P is the only valid STP link type for a LAG.
SHARED Optimizes for shared spanning tree links (connecting two or more spanning tree bridges).
name
string
Specifies the interface name.
port_priority
integer
Used as the port identifier together with the slot/port numbers.
vlans
list / elements=integer
Specifies the VLANs to include in the mstp instance.
state
string
    Choices:
  • present ←
  • absent
If present, this option creates STP configuration on specified remote host.
If absent, this option disables STP configuration with default settings on the device.

Examples

- name: Enable STP
  f5os_stp_config:
    hello_time: 1
    max_age: 6
    forwarding_delay: 15
    hold_count: 6
    bridge_priority: 32768
    interfaces:
      name: 1.0
      cost: 1
      port_priority: 128
      edge_port: EDGE_AUTO
      link_type: P2P

Return Values

The following are the fields unique to this module:

Key Returned Description
bridge_priority
integer
changed
Specifies the bridge in the spanning tree with the lowest relative priority becomes the root bridge.

Sample:
32768
forwarding_delay
integer
changed
Specifies the amount of time, in seconds, that the system blocks an interface from forwarding network traffic.

Sample:
15
hello_time
integer
changed
Specifies the time interval, in seconds, that the rSeries system transmits spanning tree information.

Sample:
1
hold_count
integer
changed
Specifies the maximum number of spanning tree frames (BPDUs) that the system can transmit on a port.

Sample:
6
max_age
integer
changed
Specifies the length of time, in seconds, that spanning tree information received from other bridges is considered valid.

Sample:
6


Status

Authors

  • Prateek Ramani (@ramani)