f5networks.f5_modules.bigip_device_connectivity module – Manages device IP configuration settings for HA on a BIG-IP.
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
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_connectivity
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages device IP configuration settings for High Availability (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.
Parameters
Parameter |
Comments |
---|---|
Specifies whether mirroring occurs within the same cluster or between different clusters on a multi-bladed system. This parameter is only supported on platforms that have multiple blades, such as Viprion hardware. It is not supported on Virtual Editions (VEs). Choices:
|
|
Local IP address the system uses for ConfigSync operations. |
|
When When Choices:
|
|
Specifies the primary IP address for the system to use to mirror connections. |
|
Specifies the secondary IP address for the system to use to mirror connections. |
|
IP address for the system to send multicast messages associated with failover. When |
|
Interface over which the system sends multicast messages associated with failover. When |
|
Port for the system to send multicast messages associated with failover. When |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
Addresses to use for failover operations. Options Port specifies the port the system uses for failover operations. If If you are specifying the (recommended) management IP address, use ‘management-ip’ in the address field. When the value is set to empty list, the parameter value is removed from device. |
Notes
Note
This module is primarily used as a component of configuring HA pairs of BIG-IP devices.
Requires BIG-IP >= 12.0.0
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: 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
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Denotes if the F5 configuration was updated. Returned: always |
|
The current cluster-mirroring setting. Returned: changed Sample: |
|
The new value of the Returned: changed Sample: |
|
Whether a failover multicast attribute has been changed or not. Returned: changed |
|
The new value of the Returned: changed Sample: |
|
The new value of the Returned: changed Sample: |
|
The new value of the Returned: changed Sample: |
|
The new value of the Returned: changed Sample: |
|
The new value of the Returned: changed Sample: |
|
The new value of the Returned: changed Sample: |