Try SpotterManage network global settings on BIG-IP
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Wojciech Wypior (@wojtek0806)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Module to manage STP, Multicast, DAG, LLDP and Self Allow global settings on a BIG-IP.
- name: Update STP settings
bigip_network_globals:
stp:
config_name: foobar
config_revision: 1
max_hops: 20
mode: mstp
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Update DAG settings
bigip_network_globals:
dag:
icmp_hash: ipicmp
round_robin_mode: local
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Update multiple settings
bigip_network_globals:
stp:
config_name: foobar
config_revision: 1
max_hops: 20
mode: mstp
dag:
icmp_hash: ipicmp
round_robin_mode: local
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
dag:
description:
- Manage global disaggregation settings.
suboptions:
dag_ipv6_prefix_len:
description:
- Specifies whether SPDAG or IPv6 prefix DAG should be used to disaggregate IPv6
traffic when vlan cmp hash is set to C(src-ip) or C(dst-ip).
- The valid value range is 0 - 128, with C(128) value SPAG is in use.
- This option is only available in TMOS version C(13.x) and above.
type: int
icmp_hash:
choices:
- icmp
- ipicmp
description:
- Specifies the ICMP hash for ICMP echo request and ICMP echo reply in SW DAG.
- When C(icmp), ICMP echo request and ICMP echo reply are disaggregated based
on ICMP id.
- When C(ipicmp), ICMP echo request and ICMP echo reply are disaggregated based
on ICMP id and IP addresses.
- This option is only available in C(TMOS) version C(13.x) and above.
type: str
round_robin_mode:
choices:
- global
- local
description:
- Specifies whether the round robin disaggregator (DAG) on a blade can disaggregate
packets to all the TMMs in the system or only to the TMMs local to the blade.
- When C(global), the DAG will disaggregate packets to all TMMs in the system.
- When C(local), the DAG will disaggregate packets only to the TMMs local to the
blade.
type: str
type: dict
stp:
description:
- Manage global settings for STP on BIG-IP.
suboptions:
config_name:
description:
- Specifies the configuration name. The accepted length is from 1 to 32 characters.
- Only has effect when the C(mode) is C(mstp).
type: str
config_revision:
description:
- Specifies the revision level of the MSTP configuration, when C(mode) is C(mstp).
- You must specify a number in the range of 0 to 65535.
type: int
description:
description:
- User-defined description.
type: str
fwd_delay:
description:
- 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 C(rstp) or C(mstp) modes are used, as long as all bridges
in the spanning tree use the RSTP or MSTP protocol.
- If any legacy STP bridges are present, neighboring bridges must fall back to
the old protocol, whose reconfiguration time is affected by the forward delay
value.
- The valid range is 4 to 30.
type: int
hello_time:
description:
- Specifies the time interval in seconds between the periodic transmissions that
communicate spanning tree information to the adjacent bridges in the network.
- The hello time set by default on the device is optimal in virtually all cases.
F5 recommends that you do not change the hello time.
- The valid range is 1 to 10.
type: int
max_age:
description:
- Specifies the number of seconds for which spanning tree information received
from other bridges is considered valid.
- The valid range is 6 to 40 seconds.
type: int
max_hops:
description:
- Specifies the maximum number of hops an MSTP packet may travel before it is
discarded.
- This option only takes effect when C(mode) is C(mstp).
- The number of hops must be in the range of 1 to 255.
type: int
mode:
choices:
- disabled
- mstp
- passthru
- rstp
- stp
description:
- Specifies the spanning tree mode.
- 'The C(mstp), C(rstp) and C(stp) options are only supported on hardware platforms.
Attempting to set these modes on VE type platforms will result in failure. The
only valid options on VE type platforms are: C(passthru) and C(disabled).'
type: str
transmit_hold:
description:
- 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.
- The valid range is 1 to 10 packets.
type: int
type: dict
lldp:
description:
- Manage LLDP configuration options.
suboptions:
enabled:
description:
- Specifies the current status of LLDP.
- When C(true), the LLDP is enabled globally on the device.
- When C(false), the LLDP is disabled globally on the device.
type: bool
max_neighbors_per_port:
description:
- Specifies the maximum number of neighbors per port.
- The valid value range is 0 - 65535.
type: int
reinit_delay:
description:
- Specifies the maximum number of seconds to wait after reaching the TTL interval
before resetting TTL timer.
- The valid value range is 0 - 65535.
type: int
tx_delay:
description:
- Specifies the number of seconds to wait for LLDP to initialize on an interface
before sending LLDP message.
- The valid value range is 0 - 65535.
type: int
tx_hold:
description:
- Specifies the multiplier that determines the LLDP Time to Live (TTL). TTL is
determined by multiplying this value and C(tx_interval).
- The valid value range is 0 - 65535.
type: int
tx_interval:
description:
- Specifies the interval devices use to send LLDP information from each of their
interfaces.
- The valid value range is 0 - 65535.
type: int
type: dict
provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- The password for the user account used to connect to the BIG-IP or the BIG-IQ.
- You may omit this option by setting the environment variable C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- Specifies the timeout in seconds for communicating with the network device for
either connecting or sending commands. If the timeout is exceeded before the
operation is completed, the module will error.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative
privileges on the device.
- You may omit this option by setting the environment variable C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(no), SSL certificates are not validated. Use this only on personally controlled
sites using self-signed certificates.
- You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules
multicast:
description:
- Manage multicast traffic configuration options.
suboptions:
max_pending_packets:
description:
- Specifies the maximum number of packet queued on behalf of a single incomplete
MFC entry.
- The valid range is 0 - 4294967295.
type: int
max_pending_routes:
description:
- Specifies the number of incomplete MFC entries each TMM will allow to exist
at one time.
- The valid range is 0 - 4294967295.
type: int
rate_limit:
description:
- When C(true), the DB variable C(switchboard.maxmcastrate) setting controls the
multicast packet per second rate limiting in the switch.
type: bool
route_lookup_timeout:
description:
- Specifies maximum lifetime of an incomplete MFC entry, in seconds.
- The valid range is 0 - 4294967295.
type: int
type: dict
self_allow:
description:
- Manage Self Allow global configuration options.
suboptions:
all:
description:
- Sets B(all) or B(none) ports and protocols as a system wide C(self_allow) setting.
- When C(true), the self_allow allows all protocols and ports. This is the equivalent
of setting B(all) option in C(TMSH).
- When C(false), the self_allow allows no protocols and ports. This is the equivalent
of setting B(none) option in C(TMSH).
type: bool
defaults:
description:
- The default set of protocols and ports allowed by a self IP if the self IP allow-service
setting is B(default).
elements: dict
suboptions:
port:
description:
- The port number to be set.
- The valid value range is 0 - 65535.
type: int
protocol:
description:
- The protocol name to be set.
type: str
type: list
type: dict
version_added: 1.1.0
version_added_collection: f5networks.f5_modules
dag:
contains:
dag_ipv6_prefix_len:
description: Specifies whether SPDAG or IPv6 prefix DAG should be used to disaggregate
IPv6 traffic.
returned: changed
sample: 128
type: int
icmp_hash:
description: Specifies the ICMP hash for the ICMP echo request and ICMP echo
reply in SW DAG.
returned: changed
sample: ipicmp
type: str
round_robin_mode:
description: The mode of operation of the DAG on a blade.
returned: changed
sample: local
type: str
description: Manage multicast traffic configuration options.
returned: changed
sample: hash/dictionary of values
type: complex
lldp:
contains:
enabled:
description: The current status of LLDP.
returned: changed
sample: true
type: bool
max_neighbors_per_port:
description: The maximum number of neighbors per port.
returned: changed
sample: 128
type: int
reinit_delay:
description: The maximum number of seconds to wait before resetting the TTL
timer after reaching the TTL interval.
returned: changed
sample: 30
type: int
tx_delay:
description: The number of seconds to wait for LLDP to initialize on an interface
before sending LLDP message.
returned: changed
sample: 500
type: int
tx_hold:
description: The multiplier that determines the LLDP Time to Live.
returned: changed
sample: 10
type: int
tx_interval:
description: The interval devices use to send LLDP information from each of
their interfaces.
returned: changed
sample: 240
type: int
description: Manage multicast traffic configuration options.
returned: changed
sample: hash/dictionary of values
type: complex
multicast:
contains:
max_pending_packets:
description: The maximum number of packet queued on behalf of a single incomplete
MFC entry.
returned: changed
sample: 3000
type: int
max_pending_routes:
description: The number of incomplete MFC entries each TMM will allow to exist
at one time.
returned: changed
sample: 50
type: int
rate_limit:
description: Enables DB variable control over multicast packet per second rate
limiting in the switch.
returned: changed
sample: true
type: bool
route_lookup_timeout:
description: The maximum lifetime of an incomplete MFC entry, in seconds.
returned: changed
sample: 20
type: int
description: Manage multicast traffic configuration options.
returned: changed
sample: hash/dictionary of values
type: complex
self_allow:
contains:
all:
description: Allows all or none ports and protocols as a system wide self_allow
setting.
returned: changed
sample: true
type: bool
defaults:
contains:
port:
description: The port number to be set.
returned: changed
sample: 443
type: int
protocol:
description: The protocol name to be set.
returned: changed
sample: tcp
type: str
description: The default set of protocols and ports allowed by a self IP.
returned: changed
sample: hash/dictionary of values
type: complex
description: Manages self_allow system wide settings.
returned: changed
sample: hash/dictionary of values
type: complex
stp:
contains:
config_name:
description: The configuration name.
returned: changed
sample: foobar
type: str
config_revision:
description: The revision level of the MSTP configuration.
returned: changed
sample: 2
type: int
description:
description: User-defined description.
returned: changed
sample: My description
type: str
fwd_delay:
description: The number of seconds for which an interface was blocked from forwarding
network traffic.
returned: changed
sample: 4
type: int
hello_time:
description: The time interval at seconds between the periodic transmissions
of spanning tree information.
returned: changed
sample: 2
type: int
max_age:
description: The number of seconds that spanning tree information received from
other bridges is considered valid.
returned: changed
sample: 30
type: int
max_hops:
description: The maximum number of hops an MSTP packet may travel before it
is discarded.
returned: changed
sample: 15
type: int
mode:
description: The spanning tree mode.
returned: changed
sample: mstp
type: str
transmit_hold:
description:
- The limit on the number of STP the traffic management system may transmit
on a port in any hello time interval.
returned: changed
sample: 5
type: int
description: Manage global settings for STP on BIG-IP.
returned: changed
sample: hash/dictionary of values
type: complex