f5networks.f5_modules.bigip_configsync_action module – Perform different actions related to config-sync
Note
This module is part of the f5networks.f5_modules collection (version 1.30.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_configsync_action
.
New in f5networks.f5_modules 1.0.0
Synopsis
Allows running different config-sync actions. These actions allow you to manually sync your configuration across multiple BIG-IPs when those devices are in an HA pair.
Parameters
Parameter |
Comments |
---|---|
The device group on which you want to perform config-sync actions. |
|
Indicates the sync operation overwrites the configuration on the target. Choices:
|
|
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:
|
|
Specifies the system synchronizes configuration data from this device to other members of the device group. In this case, the device performs a “push” to all the other devices in the group. This option is mutually exclusive with the Choices:
|
|
Specifies the system synchronizes configuration data from the device with the most recent configuration. In this case, the device performs a “pull” from the most recently updated device. This option is mutually exclusive with the Choices:
|
Notes
Note
Requires the objectpath Python package on the host. This is as easy as running
pip install objectpath
.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: Sync configuration from device to group
bigip_configsync_action:
device_group: foo-group
sync_device_to_group: true
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Sync configuration from most recent device to the current host
bigip_configsync_action:
device_group: foo-group
sync_group_to_device: true
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Perform an initial sync of a device to a new device group
bigip_configsync_action:
device_group: new-device-group
sync_device_to_group: true
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Authors
Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)