New in version 2.4.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
device_group
-
/ required
|
The device group that you want to perform config-sync actions on.
|
||
overwrite_config
boolean
|
|
Indicates that the sync operation overwrites the configuration on the target.
|
|
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.
|
|
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 |
||
server
-
/ required
|
The BIG-IP host.
You may omit this option by setting the environment variable
F5_SERVER . |
||
server_port
-
|
Default: 443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT . |
|
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.
|
|
transport
-
/ required
|
|
Configures the transport connection to use when connecting to the remote device.
|
|
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
boolean
|
|
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 . |
|
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 . |
|
sync_device_to_group
boolean
|
|
Specifies that 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_most_recent_to_device
boolean
|
|
Specifies that 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. |
|
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
boolean
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 objectpath
.pip install f5-sdk
.- name: Sync configuration from device to group
bigip_configsync_action:
device_group: foo-group
sync_device_to_group: yes
server: lb.mydomain.com
user: admin
password: secret
validate_certs: no
delegate_to: localhost
- name: Sync configuration from most recent device to the current host
bigip_configsync_action:
device_group: foo-group
sync_most_recent_to_device: yes
server: lb.mydomain.com
user: admin
password: secret
validate_certs: no
delegate_to: localhost
- 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: yes
server: lb.mydomain.com
user: admin
password: secret
validate_certs: no
delegate_to: localhost
Hint
If you notice any issues in this documentation you can edit this document to improve it.