ansible / ansible.builtin / v2.5.6 / module / bigip_device_group Manage device groups on a BIG-IP | "added in version" 2.5 of ansible.builtin" Authors: Tim Rupp (@caphrim007) preview | supported by communityansible.builtin.bigip_device_group (v2.5.6) — module
pip
Install with pip install ansible==2.5.6
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 C(bigip_configsync_actions) to sync configuration across the pair or cluster if auto-sync is disabled.
- 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
name: description: - Specifies the name of the device group. required: true type: choices: - sync-failover - sync-only description: - Specifies that the type of group. A C(sync-failover) device group contains devices that synchronize their configuration data and fail over to one another when a device becomes unavailable. A C(sync-only) device group has no such failover. When creating a new device group, this option will default to C(sync-only). This setting cannot be changed once it has been set. state: choices: - present - absent description: - When C(state) is C(present), ensures the device group exists. - When C(state) is C(absent), ensures that the device group is removed. provider: description: - A dict object containing connection details. suboptions: auth_provider: description: - Configures the auth provider for to obtain authentication tokens from the remote device. - This option is really used when working with BIG-IQ devices. type: str no_f5_teem: default: false description: - If C(yes), TEEM telemetry data is not sent to F5. - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF). - Previously used variable C(F5_TEEM) is deprecated as its name was confusing. type: bool password: aliases: - pass - pwd description: - 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 C(F5_PASSWORD). required: true type: str server: description: - The BIG-IP host or the BIG-IQ host. - You may omit this option by setting the environment variable C(F5_SERVER). required: true type: str server_port: default: 443 description: - The BIG-IP server port. - You may omit this option by setting the environment variable C(F5_SERVER_PORT). type: int timeout: description: - 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. type: int transport: choices: - rest default: rest description: - Configures the transport connection to use when connecting to the remote device. type: str user: description: - 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 C(F5_USER). required: true type: str validate_certs: default: true description: - If C(no), SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. - You may omit this option by setting the environment variable C(F5_VALIDATE_CERTS). type: bool type: dict version_added: 1.0.0 version_added_collection: f5networks.f5_modules auto_sync: description: - Indicates whether configuration synchronization occurs manually or automatically. When creating a new device group, this option will default to C(false). type: bool full_sync: description: - Specifies whether the system synchronizes the entire configuration during synchronization operations. When C(false), the system performs incremental synchronization operations, based on the cache size specified in C(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 C(false). type: bool description: description: - Description of the device group. save_on_auto_sync: description: - When performing an auto-sync, specifies whether the configuration will be saved or not. If C(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 C(false). type: bool max_incremental_sync_size: description: - 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 C(full_sync) is C(false).
auto_sync: description: The new auto_sync value of the device group. returned: changed sample: true type: bool description: description: The new description of the device group. returned: changed sample: this is a device group type: string full_sync: description: The new full_sync value of the device group. returned: changed sample: false type: bool max_incremental_sync_size: description: The new sync size of the device group returned: changed sample: 1000 type: int save_on_auto_sync: description: The new save_on_auto_sync value of the device group. returned: changed sample: true type: bool type: description: The new type of the device group. returned: changed sample: sync-failover type: string