bigip_device_group - Manage device groups on a BIG-IP

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

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 configuration across the pair or cluster if auto-sync is disabled.

Requirements

The below requirements are needed on the host that executes this module.

f5-sdk >= 3.0.9

Parameters

Parameter		Choices/Defaults	Comments
auto_sync		Choices: no yes	Indicates whether configuration synchronization occurs manually or automatically. When creating a new device group, this option will default to `false`.
description			Description of the device group.
full_sync		Choices: no yes	Specifies whether the system synchronizes the entire configuration during synchronization operations. When `false`, the system performs incremental synchronization operations, based on the cache size specified in `max_incremental_sync_size`. 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 will default to `false`.
max_incremental_sync_size			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 `full_sync` is `false`.
name required			Specifies the name of the device group.
password required			The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable `F5_PASSWORD` is set. aliases: pass, pwd
provider (added in 2.5)		Default: None	A dict object containing connection details.
	ssh_keyfile		Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
	timeout	Default: 10	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.
	server required		The BIG-IP host. You can omit this option if the environment variable `F5_SERVER` is set.
	user required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable `F5_USER` is set.
	server_port	Default: 443	The BIG-IP server port. You can omit this option if the environment variable `F5_SERVER_PORT` is set.
	password required		The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable `F5_PASSWORD` is set. aliases: pass, pwd
	validate_certs	Choices: no yes ←	If `no`, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable `F5_VALIDATE_CERTS` is set.
	transport required	Choices: rest cli ←	Configures the transport connection to use when connecting to the remote device.
save_on_auto_sync		Choices: no yes	When performing an auto-sync, specifies whether the configuration will be saved or not. If `false`, only the running configuration will be changed on the device(s) being synced to. When creating a new device group, this option will default to `false`.
server required			The BIG-IP host. You can omit this option if the environment variable `F5_SERVER` is set.
server_port (added in 2.2)		Default: 443	The BIG-IP server port. You can omit this option if the environment variable `F5_SERVER_PORT` is set.
state		Choices: present absent	When `state` is `present`, ensures the device group exists. When `state` is `absent`, ensures that the device group is removed.
type		Choices: sync-failover sync-only	Specifies that the type of group. A `sync-failover` device group contains devices that synchronize their configuration data and fail over to one another when a device becomes unavailable. A `sync-only` device group has no such failover. When creating a new device group, this option will default to `sync-only`. This setting cannot be changed once it has been set.
user required			The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable `F5_USER` is set.
validate_certs (added in 2.0)		Choices: no yes ←	If `no`, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable `F5_VALIDATE_CERTS` is set.

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 the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.

Examples

- name: Create a sync-only device group
  bigip_device_group:
    name: foo-group
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  delegate_to: localhost

- name: Create a sync-only device group with auto-sync enabled
  bigip_device_group:
    name: foo-group
    auto_sync: yes
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
auto_sync bool	changed	The new auto_sync value of the device group. Sample: True
description string	changed	The new description of the device group. Sample: this is a device group
full_sync bool	changed	The new full_sync value of the device group.
max_incremental_sync_size int	changed	The new sync size of the device group Sample: 1000
save_on_auto_sync bool	changed	The new save_on_auto_sync value of the device group. Sample: True
type string	changed	The new type of the device group. Sample: sync-failover

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

Tim Rupp (@caphrim007)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/bigip_device_group_module.html