Try SpotterManages device IP configuration settings for HA on a BIG-IP
| "added in version" 2.5 of ansible.builtin"
Authors: Tim Rupp (@caphrim007)
preview | supported by community
pipInstall with pip install ansible==2.5.6
Manages device IP configuration settings for HA on a BIG-IP. Each BIG-IP device has synchronization and failover connectivity information (IP addresses) that you define as part of HA pairing or clustering. This module allows you to configure that information.
- name: Configure device connectivity for standard HA pair
bigip_device_connectivity:
config_sync_ip: 10.1.30.1
mirror_primary_address: 10.1.30.1
unicast_failover:
- address: management-ip
- address: 10.1.30.1
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
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
config_sync_ip:
description:
- Local IP address that the system uses for ConfigSync operations.
multicast_port:
description:
- Port for the system to send multicast messages associated with failover. When C(failover_multicast)
is C(yes) and this option is not provided, a default of C(62960) will be used. This
value must be between 0 and 65535.
unicast_failover:
description:
- Desired addresses to use for failover operations. Options C(address) and C(port)
are supported with dictionary structure where C(address) is the local IP address
that the system uses for failover operations. Port specifies the port that the system
uses for failover operations. If C(port) is not specified, the default value C(1026)
will be used. If you are specifying the (recommended) management IP address, use
'management-ip' in the address field.
multicast_address:
description:
- IP address for the system to send multicast messages associated with failover. When
C(failover_multicast) is C(yes) and this option is not provided, a default of C(224.0.0.245)
will be used.
failover_multicast:
choices:
- true
- false
description:
- When C(yes), ensures that the Failover Multicast configuration is enabled and if
no further multicast configuration is provided, ensures that C(multicast_interface),
C(multicast_address) and C(multicast_port) are the defaults specified in each option's
description. When C(no), ensures that Failover Multicast configuration is disabled.
multicast_interface:
description:
- Interface over which the system sends multicast messages associated with failover.
When C(failover_multicast) is C(yes) and this option is not provided, a default
of C(eth0) will be used.
mirror_primary_address:
description:
- Specifies the primary IP address for the system to use to mirror connections.
mirror_secondary_address:
description:
- Specifies the secondary IP address for the system to use to mirror connections.
changed:
description: Denotes if the F5 configuration was updated.
returned: always
type: bool
config_sync_ip:
description: The new value of the C(config_sync_ip) setting.
returned: changed
sample: 10.1.1.1
type: string
failover_multicast:
description: Whether a failover multicast attribute has been changed or not.
returned: changed
type: bool
mirror_primary_address:
description: The new value of the C(mirror_primary_address) setting.
returned: changed
sample: 10.1.1.2
type: string
mirror_secondary_address:
description: The new value of the C(mirror_secondary_address) setting.
returned: changed
sample: 10.1.1.3
type: string
multicast_address:
description: The new value of the C(multicast_address) setting.
returned: changed
sample: 224.0.0.245
type: string
multicast_interface:
description: The new value of the C(multicast_interface) setting.
returned: changed
sample: eth0
type: string
multicast_port:
description: The new value of the C(multicast_port) setting.
returned: changed
sample: 1026
type: string
unicast_failover:
description: The new value of the C(unicast_failover) setting.
returned: changed
sample:
- address: 10.1.1.2
port: 1026
type: list