Parameter |
Choices/Defaults |
Comments |
access_conflict_policy
string
|
Choices:
- use_bigiq
- use_bigip
- keep_version
|
Sets the conflict resolution policy for Access module apm objects, only used when apm module is specified.
|
access_group_first_device
boolean
|
|
Specifies if the imported device is the first device in the access group to import shared configuration for that access group.
|
access_group_name
string
|
|
Access group name to import Access configuration for devices, once set it cannot be changed.
|
conflict_policy
string
|
Choices:
use_bigiq ←
- use_bigip
|
Sets the conflict resolution policy for shared objects across BIG-IP devices, except LTM profiles and monitors.
|
device_address
string
/ required
|
|
The IP address of the BIG-IP device to be imported/managed.
|
device_conflict_policy
string
|
Choices:
use_bigiq ←
- use_bigip
|
Sets the conflict resolution policy for objects that are specific to a particular to a BIG-IP device and not shared among BIG-IP devices.
|
device_password
string
|
|
The administrator password for the BIG-IP device.
This parameter is only required when adding a new BIG-IP device to be managed.
|
device_port
integer
|
Default:
443
|
The port on which a device trust setup between BIG-IQ and BIG-IP should happen.
|
device_username
string
|
|
The administrator username for the BIG-IP device.
This parameter is only required when adding a new BIG-IP device to be managed.
|
force
boolean
|
|
Forces rediscovery and import of existing modules on the managed BIG-IP
|
ha_name
string
|
|
DSC cluster name of the BIG-IP device to be managed.
This is optional if the managed device is not a part of a cluster group.
When use_bigiq_sync is set to yes then this parameter becomes mandatory.
|
modules
list
|
Choices:
- ltm
- asm
- apm
- afm
- dns
- websafe
- security_shared
|
List of modules to be discovered and imported into the device.
These modules must be provisioned on the target device otherwise operation will fail.
The ltm module must always be specified when performing discovery or re-discovery of the the device.
When asm or afm are specified shared_security module needs to also be declared.
|
provider
dictionary
added in 2.5 |
|
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.
|
|
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 .
|
|
ssh_keyfile
path
|
|
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
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 .
|
state
string
|
Choices:
- absent
present ←
|
The state of the managed device on the system.
When present , enables new device addition as well as device rediscovery/import.
When absent , completely removes the device from the system.
|
statistics
dictionary
|
|
Specify the statistics collection for discovered device.
|
|
enable
boolean
|
|
Enables statistics collection on a device
|
|
interval
integer
|
|
Specify the interval in seconds the data is collected from the discovered device.
|
|
stat_modules
list
|
Choices:
device ←
ltm ←
- dns
Default:
["device", "ltm"]
|
Specifies for which modules the data is being collected.
|
|
zone
string
|
Default:
"default"
|
Specify in which DCD zone is collecting the data from device.
|
use_bigiq_sync
boolean
|
|
When set to true, BIG-IQ will manually synchronize configuration changes between members in a DSC cluster.
|
versioned_conflict_policy
string
|
Choices:
- use_bigiq
- use_bigip
- keep_version
|
Sets the conflict resolution policy for LTM profile and monitor objects that are specific to a BIG-IP software version.
|