Try SpotterManages traffic groups on BIG-IP
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Tim Rupp (@caphrim007), Wojciech Wypior (@wojtek0806)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Supports managing traffic groups and their attributes on a BIG-IP.
- name: Create a traffic group
bigip_device_traffic_group:
name: foo1
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Create a traffic group with ha_group failover
bigip_device_traffic_group:
name: foo2
state: present
ha_group: foo_HA_grp
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Create a traffic group with ha_order failover
bigip_device_traffic_group:
name: foo3
state: present
ha_order:
- /Common/bigip1.lab.local
- /Common/bigip2.lab.local
auto_failback: true
auto_failback_time: 40
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Change traffic group ha_order to ha_group
bigip_device_traffic_group:
name: foo3
state: present
ha_group: foo_HA_grp
ha_order: ""
auto_failback: false
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Remove traffic group
bigip_device_traffic_group:
name: foo
state: absent
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
name:
description:
- The name of the traffic group.
required: true
type: str
state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the traffic group exists.
- When C(absent), ensures the traffic group is removed.
type: str
ha_group:
description:
- Specifies a configured C(HA group) to be associated with the traffic group.
- Once you create an HA group on a device and associate the HA group with a traffic
group, you must create an HA group and associate it with that same traffic group
on every device in the device group.
- To disable an HA group failover method, specify an empty string value (C("")) to
this parameter.
- Disabling an HA group will revert the device back to using C(Load Aware) method
(the default), unless C(ha_order) setting is also configured.
- The C(auto_failback) and C(auto_failback_time) are not compatible with C(ha_group).
type: str
ha_order:
description:
- Specifies the order in which you would like to assign devices for failover.
- If you configure this setting, you must configure the setting on every traffic group
in the device group.
- The values should be device names of the devices that belong to the failover group
configured previously.
- The order in which the devices are placed as arguments to this parameter determines
their HA order on the device. Meaning that changing the order of the same elements
will cause a change on the unit.
- To disable an HA order failover method, specify an empty string value (C("")) to
this parameter.
- Disabling an HA order will revert the device back to using the Load Aware method
(the default), unless the C(ha_group) setting is also configured.
- Device names will be prepended with a partition by the module, so you can provide
either the full path format name C(/Common/bigip1) or just the name string C(bigip1).
elements: str
type: list
provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- The password for the user account used to connect to the BIG-IP or the BIG-IQ.
- You may omit this option by setting the environment variable C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- 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.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative
privileges on the device.
- You may omit this option by setting the environment variable C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(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 C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules
partition:
default: Common
description:
- Device partition to manage resources on.
type: str
mac_address:
description:
- 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 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 (C("")) to this parameter.
type: str
auto_failback:
description:
- Specifies whether the traffic group fails back to the initial device specified in
C(ha_order).
type: bool
ha_load_factor:
description:
- The value of the load the traffic-group presents the system relative to other traffic
groups.
- This parameter only takes effect when C(Load Aware) failover method is in use.
- The correct value range is C(1 - 1000) inclusive.
type: int
auto_failback_time:
description:
- Specifies the number of seconds the system delays before failing back to the initial
device specified in C(ha_order).
- The correct value range is C(0 - 300) inclusive.
type: int
auto_failback:
description: Specifies whether the traffic group fails back to the initial device
specified in ha_order.
returned: changed
sample: true
type: bool
auto_failback_time:
description: Specifies the number of seconds the system delays before failing back.
returned: changed
sample: 60
type: int
ha_group:
description: The configured HA group associated with traffic group.
returned: changed
sample: foo_HA_grp
type: str
ha_load_factor:
description: The value of the load the traffic-group presents the system relative
to other traffic groups.
returned: changed
sample: 20
type: int
ha_order:
description: Specifies the order in which the devices will failover.
returned: changed
sample:
- /Common/bigip1
- /Common/bigip2
type: list
mac_address:
description: The MAC masquerade address
returned: changed
sample: 02:01:d7:93:35:08
type: str