New in version 2.5.
bigip_configsync_actions
to sync configuration across the pair or cluster if auto-sync is disabled.The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
auto_sync bool |
| Indicates whether configuration synchronization occurs manually or automatically. When creating a new device group, this option will default to no . | |
description | Description of the device group. | ||
full_sync bool |
| Specifies whether the system synchronizes the entire configuration during synchronization operations. When no , 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 no . | |
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 no . | ||
name required | Specifies the name of the device group. | ||
network_failover bool (added in 2.7) |
| Indicates whether failover occurs over the network or is hard-wired. This parameter is only valid for type 's that are sync-failover . | |
password required | The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable F5_PASSWORD .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. You may omit this option by setting the environment variable ANSIBLE_NET_SSH_KEYFILE . | ||
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 may omit this option by setting the environment variable F5_SERVER . | ||
user required | The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable F5_USER . | ||
server_port | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
password required | The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable F5_PASSWORD .aliases: pass, pwd | ||
validate_certs bool |
| If 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 F5_VALIDATE_CERTS . | |
transport required |
| Configures the transport connection to use when connecting to the remote device. | |
save_on_auto_sync bool |
| When performing an auto-sync, specifies whether the configuration will be saved or not. When no , 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 no . | |
server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
server_port (added in 2.2) | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
state |
| When state is present , ensures the device group exists.When state is absent , ensures that the device group is removed. | |
type |
| 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 may omit this option by setting the environment variable F5_USER . | ||
validate_certs bool (added in 2.0) |
| If 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 F5_VALIDATE_CERTS . |
Note
pip install f5-sdk
.- 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
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 |
network_failover bool | changed | Whether or not network failover is enabled. Sample: True |
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 |
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_device_group_module.html