bigip_trunk – Manage trunks on a BIG-IP
bigip_trunk – Manage trunks on a BIG-IP
New in version 2.6.
Synopsis
- Manages trunks on a BIG-IP.
Requirements
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.16
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
description - added in 2.7 |
Description of the trunk. | ||
frame_distribution_hash - |
|
Specifies the basis for the hash that 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 | |
interfaces - |
The interfaces that are part of the trunk. To clear the list of interfaces, specify an empty list. | ||
lacp_enabled boolean |
|
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. | |
lacp_mode - |
|
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 | |
lacp_timeout - |
|
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 | |
link_selection_policy - |
|
Specifies, once the trunk is configured, the policy that the trunk uses to determine which member link (interface) can handle new traffic. When creating a new trunk, if this value is not specific, the default is When When | |
name - / required |
Specifies the name of the trunk. | ||
password - / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
provider - added in 2.5 |
Default: null |
A dict object containing connection details. | |
password - / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
ssh_keyfile - |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable | ||
timeout - |
Default: 10 |
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. | |
transport - / required |
|
Configures the transport connection to use when connecting to the remote device. | |
user - / required |
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 | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
qinq_ethertype - added in 2.7 |
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. | ||
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - added in 2.2 |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
state - |
|
When When | |
user - / required |
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 | ||
validate_certs boolean added in 2.0 |
|
If You may omit this option by setting the environment variable |
Notes
Note
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires the f5-sdk Python package on the host. This is as easy as
pip install f5-sdk
. - 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 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 | Returned | Description |
---|---|---|
description string |
changed |
Description of the trunk.
Sample: My trunk |
frame_distribution_hash string |
changed |
Hash that the system uses as the frame distribution algorithm.
Sample: src-dst-ipport |
interfaces list |
changed |
Interfaces that are part of the trunk.
Sample: ['int1', 'int2'] |
lacp_enabled boolean |
changed |
Whether the system supports the link aggregation control protocol (LACP) or not.
Sample: True |
lacp_mode string |
changed |
Operation mode for LACP if the lacp option is enabled for the trunk.
Sample: active |
lacp_timeout string |
changed |
Rate at which the system sends the LACP control packets.
Sample: long |
link_selection_policy string |
changed |
LACP policy that the trunk uses to determine which member link (interface) can handle new traffic.
Sample: auto |
qinq_ethertype string |
changed |
Ether-type value used for the packets handled on this trunk when it is a member in a QinQ vlan.
Sample: 37120 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Tim Rupp (@caphrim007)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_trunk_module.html