ansible.builtin.bigip_facts (v2.5.6) — module

Install Ansible via pip

Install with pip install ansible==2.5.6

Description

Collect facts from F5 BIG-IP devices via iControl SOAP API

Requirements

• bigsuds

Usage examples

Scanned by Steampunk Spotter

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

- name: Collect BIG-IP facts
  bigip_facts:
    server: lb.mydomain.com
    user: admin
    password: secret
    include: interface,vlan
  delegate_to: localhost

Inputs

    
filter:
    aliases: []
    choices: []
    default: null
    description:
    - Shell-style glob matching string used to filter fact keys. Not applicable for software,
      provision, and system_info fact categories.
    required: false

include:
    aliases: []
    choices:
    - address_class
    - certificate
    - client_ssl_profile
    - device
    - device_group
    - interface
    - key
    - node
    - pool
    - provision
    - rule
    - self_ip
    - software
    - system_info
    - traffic_group
    - trunk
    - virtual_address
    - virtual_server
    - vlan
    default: null
    description:
    - Fact category or list of categories to collect
    required: true

session:
    aliases: []
    choices: []
    default: true
    description:
    - BIG-IP session support; may be useful to avoid concurrency issues in certain circumstances.
    required: false

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      auth_provider:
        description:
        - Configures the auth provider for to obtain authentication tokens from the remote
          device.
        - This option is really used when working with BIG-IQ devices.
        type: str
      no_f5_teem:
        default: false
        description:
        - If C(yes), TEEM telemetry data is not sent to F5.
        - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
        - Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
        type: bool
      password:
        aliases:
        - pass
        - pwd
        description:
        - 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 C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP host or the BIG-IQ host.
        - You may omit this option by setting the environment variable C(F5_SERVER).
        required: true
        type: str
      server_port:
        default: 443
        description:
        - The BIG-IP server port.
        - You may omit this option by setting the environment variable C(F5_SERVER_PORT).
        type: int
      timeout:
        description:
        - 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.
        type: int
      transport:
        choices:
        - rest
        default: rest
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      user:
        description:
        - 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 C(F5_USER).
        required: true
        type: str
      validate_certs:
        default: true
        description:
        - If C(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 C(F5_VALIDATE_CERTS).
        type: bool
    type: dict
    version_added: 1.0.0
    version_added_collection: f5networks.f5_modules