f5networks / f5networks.f5_modules / 1.28.0 / module / bigip_device_ha_group Manage HA group settings on a BIG-IP system | "added in version" 1.0.0 of f5networks.f5_modules" Authors: Wojciech Wypior (@wojtek0806)f5networks.f5_modules.bigip_device_ha_group (1.28.0) — module
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections: - name: f5networks.f5_modules version: 1.28.0
Manage HA (High Availability) group settings on a BIG-IP system.
- name: Create HA group no members, not active bigip_device_ha_group: name: foo_ha description: empty_foo active_bonus: 20 enable: false 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
name: description: - Name of the HA group to create/manage. required: true type: str pools: description: - Specifies pools to contribute to the HA score. - The pools must exist on the BIG-IP, otherwise the operation will fail. elements: dict suboptions: attribute: choices: - percent-up-members default: percent-up-members description: - The pool attribute that contributes to the HA score. type: str minimum_threshold: description: - 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 C(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 C(threshold) option was set. type: int partition: default: Common description: - Device partition where the specified pool exists. - This parameter is ignored if the C(pool_name) is specified in full path format. type: str pool_name: description: - 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, C(/Common/pool_name). - When the pool is referenced in full path format, the C(partition) parameter is ignored. required: true type: str weight: description: - Maximum value the selected pool attribute contributes to the HA score. required: true type: int type: list state: choices: - present - absent default: present description: - When C(present), ensures the resource exists. - When C(absent), ensures the resource is removed. type: str enable: default: true description: - When set to C(false), the system disables the HA score feature. type: bool trunks: description: - Specifies trunks to contribute to the HA score. - The trunks must exist on the BIG-IP, otherwise the operation will fail. elements: dict suboptions: attribute: choices: - percent-up-members default: percent-up-members description: - The trunk attribute that contributes to the HA score. type: str minimum_threshold: description: - 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 C(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 C(threshold) option was set. type: int trunk_name: description: - The trunk name used to contribute to the HA score. required: true type: str weight: description: - Maximum value the selected trunk attribute contributes to the HA score. required: true type: int 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 description: description: - User created HA group description. type: str active_bonus: description: - 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 C(10) by the system. type: int
active_bonus: description: The extra value to be added to the HA score of the active unit. returned: changed sample: 20 type: int description: description: User created HA group description. returned: changed sample: Some Group type: str enable: description: Enables or disables the HA score feature. returned: changed sample: true type: bool name: description: Name of the HA group. returned: changed sample: foo_HA type: str pools: contains: attribute: description: The pool attribute that contributes to the HA score. returned: changed sample: percent-up-members type: str minimum_threshold: description: Below this value the selected pool attribute contributes nothing to the HA score. returned: changed sample: 2 type: int partition: description: Device partition where the specified pool exists. returned: changed sample: Common type: str pool_name: description: The pool name which is used to contribute to the HA score. returned: changed sample: foo_pool type: str weight: description: Maximum value the selected pool attribute contributes to the HA score. returned: changed sample: 40 type: int description: The pools to contribute to the HA score. returned: changed sample: hash/dictionary of values type: complex trunks: contains: attribute: description: The trunk attribute that contributes to the HA score. returned: changed sample: percent-up-members type: str minimum_threshold: description: Below this value, the selected trunk attribute contributes nothing to the HA score. returned: changed sample: 2 type: int trunk_name: description: The trunk name used to contribute to the HA score. returned: changed sample: foo_trunk type: str weight: description: Maximum value the selected trunk attribute contributes to the HA score. returned: changed sample: 40 type: int description: The trunks to contribute to the HA score. returned: changed sample: hash/dictionary of values type: complex