F5 Modules for Ansible

  • Overview
  • F5 BIG-IP modules Ansible collections
  • F5OS modules Ansible collection
  • BIG-IP Next modules Ansible collection

On this page:
  • bigip_configsync_action – Perform different actions related to config-sync
    • Synopsis
    • Parameters
    • Notes
    • Examples
    • Status
      • Authors
  • CloudDocs Home > F5 Modules for Ansible > bigip_configsync_action – Perform different actions related to config-sync

Version notice:

bigip_configsync_action – Perform different actions related to config-sync¶

New in version 1.0.0.

  • Synopsis
  • Parameters
  • Notes
  • Examples
  • Status

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 Choices/Defaults Configuration Comments
device_group
string / required
The device group on which you want to perform config-sync actions.
overwrite_config
boolean
    Choices:
  • no ←
  • yes
Indicates the sync operation overwrites the configuration on the target.
sync_device_to_group
boolean
    Choices:
  • no
  • yes
Specifies the system synchronizes configuration data from this device to other members of the device group. In this case, the device will do a "push" to all the other devices in the group. This option is mutually exclusive with the sync_group_to_device option.
sync_group_to_device
boolean
    Choices:
  • no
  • yes
Specifies the system synchronizes configuration data from the device with the most recent configuration. In this case, the device will do a "pull" from the most recently updated device. This option is mutually exclusive with the sync_device_to_group options.

Notes¶

Note

  • Requires the objectpath Python package on the host. This is as easy as running pip install objectpath.

Examples¶

- name: Sync configuration from device to group
  bigip_configsync_action:
    device_group: foo-group
    sync_device_to_group: true

- name: Sync configuration from most recent device to the current host
  bigip_configsync_action:
    device_group: foo-group
    sync_group_to_device: true

- 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

Status¶

Authors¶

  • Wojciech Wypior (@wojtek0806)