f5networks.f5_modules.bigiq_device_discovery module – Manage BIG-IP devices through BIG-IQ
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigiq_device_discovery
.
New in f5networks.f5_modules 1.0.0
Synopsis
Discovers and imports BIG-IP device configuration on the BIG-IQ.
Parameters
Parameter |
Comments |
---|---|
Sets the conflict resolution policy for Access module Choices:
|
|
Specifies if the imported device is the first device in the access group to import shared configuration for that access group. Choices:
|
|
Access group name to import Access configuration for devices. Once set it cannot be changed. |
|
Sets the conflict resolution policy for shared objects across BIG-IP devices, except LTM profiles and monitors. Choices:
|
|
The IP address of the BIG-IP device to be imported/managed. For this module, |
|
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. Choices:
|
|
The administrator password for the BIG-IP device. This parameter is only required when adding a new BIG-IP device to be managed. |
|
The port on which a device trust setup between BIG-IQ and BIG-IP should happen. Default: |
|
The administrator username for the BIG-IP device. This parameter is only required when adding a new BIG-IP device to be managed. |
|
Forces rediscovery and import of existing modules on the managed BIG-IP. Choices:
|
|
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 |
|
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 When Choices:
|
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
The state of the managed device on the system. When When Choices:
|
|
Specify the statistics collection for discovered device. |
|
Enables statistics collection on a device. Choices:
|
|
Specifies the interval the data is collected from the discovered device, in seconds. Choices:
|
|
Specifies for which modules the data is being collected. Choices:
Default: |
|
Specifies in which DCD zone is collecting the data from device. Default: |
|
When set to When set to Choices:
|
|
Sets the conflict resolution policy for LTM profile and monitor objects that are specific to a BIG-IP software version. Choices:
|
Notes
Note
BIG-IQ >= 6.1.0.
This module does not support atomic removal of discovered modules on the device.
Provider should point to the BIG-IQ credentials
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- name: Discover a new device and import config, use default conflict policy.
bigiq_device_discovery:
device_address: 192.168.1.1
device_username: bigipadmin
device_password: bigipsecret
modules:
- ltm
- afm
- shared_security
provider:
password: secret
server: cm.mydomain.com
user: admin
delegate_to: localhost
- name: Discover a new device and import config, use non- default conflict policy.
bigiq_device_discovery:
device_address: 192.168.1.1
modules:
- ltm
- dns
conflict_policy: use_bigip
provider:
password: secret
server: cm.mydomain.com
user: admin
delegate_to: localhost
- name: Force full device rediscovery
bigiq_device_discovery:
device_address: 192.168.1.1
modules:
- ltm
- afm
- dns
- shared_security
force: true
provider:
password: secret
server: cm.mydomain.com
user: admin
delegate_to: localhost
- name: Remove discovered device and its config
bigiq_device_discovery:
device_address: 192.168.1.1
state: absent
provider:
password: secret
server: cm.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Sets the conflict resolution policy for Access module Returned: changed Sample: |
|
First device in the access group to import shared configuration for that access group. Returned: changed Sample: |
|
Access group name to import Access configuration for devices. Returned: changed Sample: |
|
Sets the conflict resolution policy for shared objects across BIG-IP devices. Returned: changed Sample: |
|
The IP address of the BIG-IP device to be imported/managed. Returned: changed Sample: |
|
Sets the conflict resolution policy for objects that are specific to a particular to a BIG-IP device. Returned: changed Sample: |
|
The port on which a device trust setup between BIG-IQ and BIG-IP should happen. Returned: changed Sample: |
|
DSC cluster name of the BIG-IP device to be managed. Returned: changed Sample: |
|
List of modules to be discovered and imported into the device. Returned: changed Sample: |
|
Indicates if BIG-IQ should manually synchronize DSC configuration. Returned: changed Sample: |
|
Sets the conflict resolution policy for LTM profile and monitor objects. Returned: changed Sample: |