New in version 2.5.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
|
mac_address
(added in 2.6) |
Specifies the floating Media Access Control (MAC) address associated with the floating IP addresses defined for a traffic group.
Primarily, a MAC masquerade address minimizes ARP communications or dropped packets as a result of failover.
A MAC masquerade address ensures that any traffic destined for a specific traffic group reaches an available device after failover, which happens because along with the traffic group, the MAC masquerade address floats to the available device.
Without a MAC masquerade address, the sending host must learn the MAC address for a newly-active device, either by sending an ARP request or by relying on the gratuitous ARP from the newly-active device.
To unset the MAC address, specify an empty value (
"") to this parameter. |
||
|
name
required |
The name of the traffic group.
|
||
| partition |
Default: Common
|
Device partition to manage resources on.
|
|
|
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.
|
||
| 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. |
||
| 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.
|
|
|
server
required |
The BIG-IP host. You can omit this option if the environment variable
F5_SERVER 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. |
||
| server_port |
Default: 443
|
The BIG-IP server port. You can omit this option if the environment variable
F5_SERVER_PORT is set. |
|
|
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 |
||
|
validate_certs
bool |
|
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. |
|
|
transport
required |
|
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 |
|
When
present, ensures that the traffic group exists.When
absent, ensures the traffic group 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) |
|
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. |
|
Note
pip install f5-sdk.- name: Create a traffic group
bigip_traffic_group:
name: foo
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.