Parameter |
Choices/Defaults |
Comments |
auto_sync
boolean
|
|
Indicates whether configuration synchronization occurs manually or automatically.
When creating a new device group, this option will default to no .
|
description
string
|
|
Description of the device group.
|
full_sync
boolean
|
|
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
integer
|
|
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
string
/ required
|
|
Specifies the name of the device group.
|
network_failover
boolean
|
|
Indicates whether failover occurs over the network or is hard-wired.
This parameter is only valid for type s that are sync-failover .
|
provider
dictionary
added in 1.0.0 of f5networks.f5_modules
|
|
A dict object containing connection details.
|
|
auth_provider
string
|
|
Configures the auth provider for to obtain authentication tokens from the remote device.
This option is really used when working with BIG-IQ devices.
|
|
no_f5_teem
boolean
|
|
If yes , TEEM telemetry data is not sent to F5.
You may omit this option by setting the environment variable F5_TEEM .
|
|
password
string
/ 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
string
/ required
|
|
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER .
|
|
server_port
integer
|
Default:
443
|
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT .
|
|
timeout
integer
|
|
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
string
|
|
Configures the transport connection to use when connecting to the remote device.
|
|
user
string
/ 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 .
|
save_on_auto_sync
boolean
|
|
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 .
|
state
string
|
Choices:
present ←
- absent
|
When state is present , ensures the device group exists.
When state is absent , ensures the device group is removed.
|
type
string
|
Choices:
- sync-failover
- sync-only
|
Specifies 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.
|