Last updated on: 2024-04-01 03:24:20.
bigiq_device_discovery – Manage BIG-IP devices through BIG-IQ¶
New in version 1.0.0.
Parameters¶
| Parameter | Choices/Defaults | Configuration | Comments | |
|---|---|---|---|---|
|
access_conflict_policy
string
|
|
Sets the conflict resolution policy for Access module
apm objects. Only used when the 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
|
|
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
|
|
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, this parameter is required. |
|||
|
modules
list
/ elements=string
|
|
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, the shared_security module also needs to be declared. |
||
|
state
string
|
|
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
|
|
Specifies the interval the data is collected from the discovered device, in seconds.
|
||
|
stat_modules
list
/ elements=string
|
["device", "ltm"]
|
Specifies for which modules the data is being collected.
|
||
|
zone
string
|
Default: "default"
|
Specifies in which DCD zone is collecting the data from device.
|
||
|
use_bigiq_sync
boolean
|
|
When set to true, BIG-IQ manually synchronizes configuration changes between members in a DSC cluster.
|
||
|
versioned_conflict_policy
string
|
|
Sets the conflict resolution policy for LTM profile and monitor objects that are specific to a BIG-IP software version.
|
||
Notes¶
Note
- BIG-IQ >= 6.1.0.
- This module does not support atomic removal of discovered modules on the device.
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
- 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
- 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
- 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
Return Values¶
The following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
access_conflict_policy
string
|
changed |
Sets the conflict resolution policy for Access module
apm objects.Sample:
keep_version
|
|
access_group_first_device
boolean
|
changed |
First device in the access group to import shared configuration for that access group.
Sample:
True
|
|
access_group_name
string
|
changed |
Access group name to import Access configuration for devices.
Sample:
foo_group
|
|
conflict_policy
string
|
changed |
Sets the conflict resolution policy for shared objects across BIG-IP devices.
Sample:
use_bigip
|
|
device_address
string
|
changed |
The IP address of the BIG-IP device to be imported/managed.
Sample:
192.168.1.1
|
|
device_conflict_policy
string
|
changed |
Sets the conflict resolution policy for objects that are specific to a particular to a BIG-IP device.
Sample:
use_bigip
|
|
device_port
integer
|
changed |
The port on which a device trust setup between BIG-IQ and BIG-IP should happen.
Sample:
10443
|
|
ha_name
string
|
changed |
DSC cluster name of the BIG-IP device to be managed.
Sample:
GROUP_1
|
|
modules
list
|
changed |
List of modules to be discovered and imported into the device.
Sample:
['ltm', 'dns']
|
|
use_bigiq_sync
boolean
|
changed |
Indicates if BIG-IQ should manually synchronize DSC configuration.
Sample:
True
|
|
versioned_conflict_policy
string
|
changed |
Sets the conflict resolution policy for LTM profile and monitor objects.
Sample:
keep_version
|