f5networks.f5_modules.bigip_trunk module – Manage trunks on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.17.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install f5networks.f5_modules.
To use it in a playbook, specify: f5networks.f5_modules.bigip_trunk.
New in version 1.0.0: of f5networks.f5_modules
Parameters
Parameter |
Comments |
|---|---|
Description of the trunk. |
|
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 When When When Choices:
|
|
The interfaces that are part of the trunk. To clear the list of interfaces, specify an empty list. |
|
When 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 LACP is disabled by default for backward compatibility. If this does not apply to your network, we recommend that you enable LACP. Choices:
|
|
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 When When Choices:
|
|
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 When When Choices:
|
|
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 When When Choices:
|
|
Specifies the name of the trunk. |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable |
|
The BIG-IP host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: 443 |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable |
|
If You may omit this option by setting the environment variable Choices:
|
|
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; 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. |
|
When When Choices:
|
Notes
Note
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- 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: yes
lacp_mode: passive
lacp_timeout: short
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Description of the trunk. Returned: changed Sample: “My trunk” |
|
Hash the system uses as the frame distribution algorithm. Returned: changed Sample: “src-dst-ipport” |
|
Interfaces that are part of the trunk. Returned: changed Sample: [“int1”, “int2”] |
|
Whether the system supports the link aggregation control protocol (LACP) or not. Returned: changed Sample: true |
|
Operation mode for LACP if the lacp option is enabled for the trunk. Returned: changed Sample: “active” |
|
Rate at which the system sends the LACP control packets. Returned: changed Sample: “long” |
|
LACP policy the trunk uses to determine which member link (interface) can handle new traffic. Returned: changed Sample: “auto” |
|
Ether-type value used for the packets handled on this trunk when it is a member in a QinQ VLAN. Returned: changed Sample: 37120 |
Authors
Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)