Note
This plugin is part of the f5networks.f5_modules collection (version 1.12.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
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
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| active_bonus integer | Specifies the extra value to be added to the HA score of the active unit. When system creates HA group this value is set to 10 by the system. | ||
| description string | User created HA group description. | ||
| enable boolean |
| When set to no, the system disables the HA score feature. | |
| name string / required | Name of the HA group to create/manage. | ||
| pools list / elements=dictionary | Specifies pools to contribute to the HA score. The pools must exist on the BIG-IP, otherwise the operation will fail. | ||
| attribute string |
| The pool attribute that contributes to the HA score. | |
| minimum_threshold integer | Below this value, the selected pool attribute contributes nothing to the HA score. This value must be greater than the number of pool members present in the pool. In TMOS versions 12.x this attribute is named threshold, however it has been deprecated in versions 13.x and above.Specifying this attribute in the module running against v12.x will keep the same behavior as if threshold option was set. | ||
| partition string | Default: "Common" | Device partition where the specified pool exists. This parameter is ignored if the pool_name is specified in full path format. | |
| pool_name string / required | The pool name which is used to contribute to the HA score. Referencing the pool can be done in the full path format for example, /Common/pool_name.When the pool is referenced in full path format, the partition parameter is ignored. | ||
| weight integer / required | Maximum value the selected pool attribute contributes to the HA score. | ||
| provider dictionary added in 1.0.0 of f5networks.f5_modules | 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. | ||
| no_f5_teem boolean |
| If yes, TEEM telemetry data is not sent to F5.You may omit this option by setting the environment variable F5_TELEMETRY_OFF.Previously used variable F5_TEEM is deprecated as its name was confusing. | |
| 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. | |
| 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 |
| 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 |
| 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. | |
| state string |
| When present, ensures the resource exists.When absent, ensures the resource is removed. | |
| trunks list / elements=dictionary | Specifies trunks to contribute to the HA score. The trunks must exist on the BIG-IP, otherwise the operation will fail. | ||
| attribute string |
| The trunk attribute that contributes to the HA score. | |
| minimum_threshold integer | Below this value the selected trunk attribute contributes nothing to the HA score. This value must be greater than the number of trunk members. In TMOS versions 12.x this attribute is named threshold, however it has been deprecated in versions 13.x and above.Specifying this attribute in the module running against v12.x will keep the same behavior as if threshold option was set. | ||
| trunk_name string / required | The trunk name used to contribute to the HA score. | ||
| weight integer / required | Maximum value the selected trunk attribute contributes to the HA score. | ||
Note
- 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
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
| active_bonus integer | changed | The extra value to be added to the HA score of the active unit. Sample: 20 | |
| description string | changed | User created HA group description. Sample: Some Group | |
| enable boolean | changed | Enables or disables the HA score feature. Sample: True | |
| name string | changed | Name of the HA group. Sample: foo_HA | |
| pools complex | changed | The pools to contribute to the HA score. Sample: hash/dictionary of values | |
| attribute string | changed | The pool attribute that contributes to the HA score. Sample: percent-up-members | |
| minimum_threshold integer | changed | Below this value the selected pool attribute contributes nothing to the HA score. Sample: 2 | |
| partition string | changed | Device partition where the specified pool exists. Sample: Common | |
| pool_name string | changed | The pool name which is used to contribute to the HA score. Sample: foo_pool | |
| weight integer | changed | Maximum value the selected pool attribute contributes to the HA score. Sample: 40 | |
| trunks complex | changed | The trunks to contribute to the HA score. Sample: hash/dictionary of values | |
| attribute string | changed | The trunk attribute that contributes to the HA score. Sample: percent-up-members | |
| minimum_threshold integer | changed | Below this value, the selected trunk attribute contributes nothing to the HA score. Sample: 2 | |
| trunk_name string | changed | The trunk name used to contribute to the HA score. Sample: foo_trunk | |
| weight integer | changed | Maximum value the selected trunk attribute contributes to the HA score. Sample: 40 | |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_device_ha_group_module.html