f5networks.f5_bigip.bigiq_device_discovery (3.4.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5_bigip:==3.4.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_bigip
      version: 3.4.0

Description

Discovers and imports BIG-IP device configuration on the BIG-IQ.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
force:
    default: false
    description:
    - Forces rediscovery and import of existing modules on the managed BIG-IP.
    type: bool

state:
    choices:
    - absent
    - present
    default: present
    description:
    - The state of the managed device on the system.
    - When C(present), enables new device addition as well as device rediscovery/import.
    - When C(absent), completely removes the device from the system.
    type: str

ha_name:
    description:
    - 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 C(use_bigiq_sync) is set to C(yes), this parameter is required.
    type: str

modules:
    choices:
    - ltm
    - asm
    - apm
    - afm
    - dns
    - websafe
    - security_shared
    description:
    - 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 C(ltm) module must always be specified when performing discovery or re-discovery
      of the the device.
    - When C(asm) or C(afm) are specified, the C(shared_security) module also needs to
      be declared.
    elements: str
    type: list

statistics:
    description:
    - Specify the statistics collection for discovered device.
    suboptions:
      enable:
        default: false
        description:
        - Enables statistics collection on a device.
        type: bool
      interval:
        choices:
        - 30
        - 60
        - 120
        - 500
        default: 60
        description:
        - Specifies the interval the data is collected from the discovered device, in
          seconds.
        type: int
      stat_modules:
        choices:
        - device
        - ltm
        - dns
        default:
        - device
        - ltm
        description:
        - Specifies for which modules the data is being collected.
        elements: str
        type: list
      zone:
        default: default
        description:
        - Specifies in which DCD zone is collecting the data from device.
        type: str
    type: dict

device_port:
    default: 443
    description:
    - The port on which a device trust setup between BIG-IQ and BIG-IP should happen.
    type: int

device_address:
    description:
    - The IP address of the BIG-IP device to be imported/managed.
    required: true
    type: str

use_bigiq_sync:
    default: false
    description:
    - When set to true, BIG-IQ manually synchronizes configuration changes between members
      in a DSC cluster.
    type: bool

conflict_policy:
    choices:
    - use_bigiq
    - use_bigip
    default: use_bigiq
    description:
    - Sets the conflict resolution policy for shared objects across BIG-IP devices, except
      LTM profiles and monitors.
    type: str

device_password:
    description:
    - The administrator password for the BIG-IP device.
    - This parameter is only required when adding a new BIG-IP device to be managed.
    type: str

device_username:
    description:
    - The administrator username for the BIG-IP device.
    - This parameter is only required when adding a new BIG-IP device to be managed.
    type: str

access_group_name:
    description:
    - Access group name to import Access configuration for devices. Once set it cannot
      be changed.
    type: str

access_conflict_policy:
    choices:
    - use_bigiq
    - use_bigip
    - keep_version
    description:
    - Sets the conflict resolution policy for Access module C(apm) objects. Only used
      when the C(apm) module is specified.
    type: str

device_conflict_policy:
    choices:
    - use_bigiq
    - use_bigip
    default: use_bigiq
    description:
    - 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.
    type: str

access_group_first_device:
    default: true
    description:
    - Specifies if the imported device is the first device in the access group to import
      shared configuration for that access group.
    type: bool

versioned_conflict_policy:
    choices:
    - use_bigiq
    - use_bigip
    - keep_version
    description:
    - Sets the conflict resolution policy for LTM profile and monitor objects that are
      specific to a BIG-IP software version.
    type: str

Outputs

access_conflict_policy:
  description: Sets the conflict resolution policy for Access module C(apm) objects.
  returned: changed
  sample: keep_version
  type: str
access_group_first_device:
  description: First device in the access group to import shared configuration for
    that access group.
  returned: changed
  sample: true
  type: bool
access_group_name:
  description: Access group name to import Access configuration for devices.
  returned: changed
  sample: foo_group
  type: str
conflict_policy:
  description: Sets the conflict resolution policy for shared objects across BIG-IP
    devices.
  returned: changed
  sample: use_bigip
  type: str
device_address:
  description: The IP address of the BIG-IP device to be imported/managed.
  returned: changed
  sample: 192.168.1.1
  type: str
device_conflict_policy:
  description: Sets the conflict resolution policy for objects that are specific to
    a particular to a BIG-IP device.
  returned: changed
  sample: use_bigip
  type: str
device_port:
  description: The port on which a device trust setup between BIG-IQ and BIG-IP should
    happen.
  returned: changed
  sample: 10443
  type: int
ha_name:
  description: DSC cluster name of the BIG-IP device to be managed.
  returned: changed
  sample: GROUP_1
  type: str
modules:
  description: List of modules to be discovered and imported into the device.
  returned: changed
  sample:
  - ltm
  - dns
  type: list
use_bigiq_sync:
  description: Indicates if BIG-IQ should manually synchronize DSC configuration.
  returned: changed
  sample: true
  type: bool
versioned_conflict_policy:
  description: Sets the conflict resolution policy for LTM profile and monitor objects.
  returned: changed
  sample: keep_version
  type: str