Try SpotterManage trunks on a BIG-IP
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Tim Rupp (@caphrim007), Wojciech Wypior (@wojtek0806)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Manages trunks on a BIG-IP.
- name: Create a trunk on hardware
bigip_trunk:
name: trunk1
interfaces:
- 1.1
- 1.2
link_selection_policy: maximum-bandwidth
frame_distribution_hash: destination-mac
lacp_enabled: true
lacp_mode: passive
lacp_timeout: short
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
name:
description:
- Specifies the name of the trunk.
required: true
type: str
state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the resource exists.
- When C(absent), ensures the resource is removed.
type: str
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
lacp_mode:
choices:
- active
- passive
description:
- Specifies the operation mode for link aggregation control protocol (LACP), if LACP
is enabled for the trunk.
- When creating a new trunk, if this parameter is not specified, the default is C(active).
- When C(active), specifies the system periodically sends control packets regardless
of whether the partner system has issued a request.
- When C(passive), specifies the system sends control packets only when the partner
system has issued a request.
type: str
interfaces:
description:
- The interfaces that are part of the trunk.
- To clear the list of interfaces, specify an empty list.
elements: str
type: list
description:
description:
- Description of the trunk.
type: str
lacp_enabled:
description:
- When C(true), specifies the system supports the link aggregation control protocol
(LACP), which monitors the trunk by exchanging control packets over the member links
to determine the health of the links.
- If LACP detects a failure in a member link, it removes the link from the link aggregation.
- When creating a new trunk, if this parameter is not specified, LACP is C(false).
- LACP is disabled by default for backward compatibility. If this does not apply to
your network, we recommend that you enable LACP.
type: bool
lacp_timeout:
choices:
- long
- short
description:
- Specifies the rate at which the system sends the LACP control packets.
- When creating a new trunk, if this parameter is not specified, the default is C(long).
- When C(long), specifies the system sends an LACP control packet every 30 seconds.
- When C(short), specifies the system sends an LACP control packet every second.
type: str
qinq_ethertype:
description:
- Specifies the ether-type value used for the packets handled on this trunk when it
is a member in a QinQ VLAN.
- The ether-type can be set to any string containing a valid hexadecimal 16 bits number,
or any of the well known ether-types; C(0x8100), C(0x9100), C(0x88a8).
- This parameter is not supported on Virtual Editions.
- You should always wrap this value in quotes to prevent Ansible from interpreting
the value as a literal hexadecimal number and converting it to an integer.
type: raw
link_selection_policy:
choices:
- auto
- maximum-bandwidth
description:
- Once the trunk is configured, specifies the policy the trunk uses to determine which
member link (interface) can handle new traffic.
- When creating a new trunk, if this value is not specified, the default is C(auto).
- When C(auto), specifies the system automatically determines which interfaces can
handle new traffic. For the C(auto) option, the member links must all be the same
media type and speed.
- When C(maximum-bandwidth), specifies the system determines which interfaces can
handle new traffic based on the members' maximum bandwidth.
type: str
frame_distribution_hash:
choices:
- destination-mac
- source-destination-ip
- source-destination-mac
description:
- Specifies the basis for the hash the system uses as the frame distribution algorithm.
The system uses the resulting hash to determine which interface to use for forwarding
traffic.
- When creating a new trunk, if this parameter is not specified, the default is C(source-destination-ip).
- When C(source-destination-mac), specifies the system bases the hash on the combined
MAC addresses of the source and the destination.
- When C(destination-mac), specifies the system bases the hash on the MAC address
of the destination.
- When C(source-destination-ip), specifies the system bases the hash on the combined
IP addresses of the source and the destination.
type: str
description:
description: Description of the trunk.
returned: changed
sample: My trunk
type: str
frame_distribution_hash:
description: Hash the system uses as the frame distribution algorithm.
returned: changed
sample: src-dst-ipport
type: str
interfaces:
description: Interfaces that are part of the trunk.
returned: changed
sample:
- int1
- int2
type: list
lacp_enabled:
description: Whether the system supports the link aggregation control protocol (LACP)
or not.
returned: changed
sample: true
type: bool
lacp_mode:
description: Operation mode for LACP if the lacp option is enabled for the trunk.
returned: changed
sample: active
type: str
lacp_timeout:
description: Rate at which the system sends the LACP control packets.
returned: changed
sample: long
type: str
link_selection_policy:
description:
- LACP policy the trunk uses to determine which member link (interface) can handle
new traffic.
returned: changed
sample: auto
type: str
qinq_ethertype:
description: Ether-type value used for the packets handled on this trunk when it
is a member in a QinQ VLAN.
returned: changed
sample: 37120
type: str