bigip_trunk - Manage trunks on a BIG-IP

New in version 2.6.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

Synopsis

Manages trunks on a BIG-IP.

Requirements

The below requirements are needed on the host that executes this module.

f5-sdk >= 3.0.9

Parameters

Parameter		Choices/Defaults	Comments
frame_distribution_hash		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			The interfaces that are part of the trunk. To clear the list of interfaces, specify an empty list.
lacp_enabled bool		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		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		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		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 required			Specifies the name of the trunk.
password required			The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable `F5_PASSWORD` is set. aliases: pass, pwd
provider (added in 2.5)			A dict object containing connection details.
	password required		The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable `F5_PASSWORD` is set. aliases: pass, pwd
	server required		The BIG-IP host. You can omit this option if the environment variable `F5_SERVER` is set.
	server_port	Default: 443	The BIG-IP server port. You can omit this option if the environment variable `F5_SERVER_PORT` is set.
	user required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable `F5_USER` is set.
	validate_certs bool	Choices: no yes ←	If `no`, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable `F5_VALIDATE_CERTS` is set.
	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.
	ssh_keyfile		Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
	transport required	Choices: rest cli ←	Configures the transport connection to use when connecting to the remote device.
server required			The BIG-IP host. You can omit this option if the environment variable `F5_SERVER` is set.
server_port (added in 2.2)		Default: 443	The BIG-IP server port. You can omit this option if the environment variable `F5_SERVER_PORT` is set.
state		Choices: present ← absent	When `present`, ensures that the resource exists. When `absent`, ensures the resource is removed.
user required			The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable `F5_USER` is set.
validate_certs bool (added in 2.0)		Choices: no yes ←	If `no`, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable `F5_VALIDATE_CERTS` is set.

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.

Examples

- name: Create a ...
  bigip_trunk:
    name: foo
    password: secret
    server: lb.mydomain.com
    state: present
    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
param1 bool	changed	The new param1 value of the resource. Sample: True
param2 string	changed	The new param2 value of the resource. Sample: Foo is bar

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

Tim Rupp (@caphrim007)

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/bigip_trunk_module.html