bigip_trunk – Manage trunks on a BIG-IP — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# bigip_trunk – Manage trunks on a BIG-IP

New in version 2.6.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Manages trunks on a BIG-IP.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
description string added in 2.7 |  | Description of the trunk.
frame_distribution_hash string | Choices: destination-mac source-destination-ip source-destination-mac | 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 `source-destination-ip`. When `source-destination-mac`, specifies that the system bases the hash on the combined MAC addresses of the source and the destination. When `destination-mac`, specifies that the system bases the hash on the MAC address of the destination. When `source-destination-ip`, specifies that the system bases the hash on the combined IP addresses of the source and the destination.
interfaces list |  | The interfaces that are part of the trunk. To clear the list of interfaces, specify an empty list.
lacp_enabled boolean | Choices: no yes | When `yes`, specifies that 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 `no`. LACP is disabled by default for backward compatibility. If this does not apply to your network, we recommend that you enable LACP.
lacp_mode string | Choices: active passive | 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 `active`. When `active`, specifies that the system periodically sends control packets regardless of whether the partner system has issued a request. When `passive`, specifies that the system sends control packets only when the partner system has issued a request.
lacp_timeout string | Choices: long short | 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 `long`. When `long`, specifies that the system sends an LACP control packet every 30 seconds. When `short`, specifies that the system sends an LACP control packet every 1 seconds.
link_selection_policy string | Choices: auto maximum-bandwidth | 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 `auto`. When `auto`, specifies that the system automatically determines which interfaces can handle new traffic. For the `auto` option, the member links must all be the same media type and speed. When `maximum-bandwidth`, specifies that the system determines which interfaces can handle new traffic based on the members' maximum bandwidth.
name string / required |  | Specifies the name of the trunk.
provider dictionary added in 2.5 |  | A dict object containing connection details.
| auth_provider string |  | Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices.
| password string / required |  | The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd
| server string / required |  | The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
| server_port integer | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
| ssh_keyfile path |  | 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 `ANSIBLE_NET_SSH_KEYFILE`.
| timeout integer |  | 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 string | Choices: cli rest ← | Configures the transport connection to use when connecting to the remote device.
| user string / 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 `F5_USER`.
| validate_certs boolean | Choices: no yes ← | If `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 `F5_VALIDATE_CERTS`.
qinq_ethertype raw 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; `0x8100`, `0x9100`, `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.
state string | Choices: present ← absent | When `present`, ensures that the resource exists. When `absent`, ensures the resource is removed.

## 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 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)
- Wojciech Wypior (@wojtek0806)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.