f5networks.f5_modules.bigip_device_ha_group – Manage HA group settings on a BIG-IP system¶
Note
This plugin is part of the f5networks.f5_modules collection (version 1.9.0).
To install it use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_device_ha_group
.
New in version 1.0.0: of f5networks.f5_modules
Parameters¶
Notes¶
Note
This module does not support atomic removal of HA group objects.
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 f5networks.f5_modules.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 HA group no members, not active
bigip_device_ha_group:
name: foo_ha
description: empty_foo
active_bonus: 20
enable: no
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create HA group with pools and trunks
bigip_device_ha_group:
name: baz_ha
description: non_empty_baz
active_bonus: 15
pools:
- pool_name: foopool
weight: 30
minimum_threshold: 1
trunks:
- trunk_name: footrunk
weight: 70
minimum_threshold: 2
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create HA group pools using full_path format
bigip_device_ha_group:
name: bar_ha
description: non_empty_bar
active_bonus: 12
pools:
- pool_name: /Baz/foopool
weight: 30
minimum_threshold: 1
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove HA group
bigip_device_ha_group:
name: foo_ha
state: absent
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:
Authors¶
Wojciech Wypior (@wojtek0806)