f5networks.f5_modules.bigip_device_group module – Manage device groups on a BIG-IP
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_device_group
.
New in f5networks.f5_modules 1.0.0
Synopsis
Managing device groups allows you to create HA pairs and clusters of BIG-IP devices. Usage of this module should be done in conjunction with the
bigip_configsync_actions
to sync the configuration across the pair or cluster if auto-sync is disabled.
Parameters
Parameter |
Comments |
---|---|
Specifies whether to synchronize ASM configurations of device group members. A device can be a member of only one ASM-enabled device group. When creating a new device group, this option defaults to Choices:
|
|
Indicates whether configuration synchronization occurs manually or automatically. When creating a new device group, this option defaults to Choices:
|
|
Description of the device group. |
|
Specifies whether the system synchronizes the entire configuration during synchronization operations. When Incremental configuration synchronization is a mechanism for synchronizing a device-group’s configuration among its members, without requiring a full configuration load for each configuration change. In order for this to work, all devices in the device-group must initially agree on the configuration. Typically this requires at least one full configuration load to each device. When creating a new device group, this option defaults to Choices:
|
|
Specifies the size of the changes cache for incremental sync. For example, using the default, if you make more than 1024 KB worth of incremental changes, the system performs a full synchronization operation. Using incremental synchronization operations can reduce the per-device sync/load time for configuration changes. This setting is relevant only when |
|
Specifies the name of the device group. |
|
Indicates whether failover occurs over the network or is hard-wired. This parameter is only valid for 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:
|
|
When performing an auto-sync, specifies whether the configuration is saved or not. When When creating a new device group, this option defaults to Choices:
|
|
When When Choices:
|
|
Specifies the type of group. A A This setting cannot be changed once it has been set. Choices:
|
Notes
Note
This module is primarily used as a component of configuring HA pairs of BIG-IP devices.
Requires BIG-IP >= 12.1.x.
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: Create a sync-only device group
bigip_device_group:
name: foo-group
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create a sync-only device group with auto-sync enabled
bigip_device_group:
name: foo-group
auto_sync: true
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create a sync-only device group with auto-sync and asm-sync enabled
bigip_device_group:
name: foo-group
auto_sync: true
asm_sync: true
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The new asm_sync value of the device group. Returned: changed Sample: |
|
The new auto_sync value of the device group. Returned: changed Sample: |
|
The new description of the device group. Returned: changed Sample: |
|
The new full_sync value of the device group. Returned: changed Sample: |
|
The new sync size of the device group. Returned: changed Sample: |
|
Whether or not network failover is enabled. Returned: changed Sample: |
|
The new save_on_auto_sync value of the device group. Returned: changed Sample: |
|
The new type of the device group. Returned: changed Sample: |