Deprecated

Removed in 2.11

i

Reason:The bigip_facts module relies on SOAP to communicate with the BIG-IP, and has a large amount of code that does not conform to existing F5 standards. The M(bigip_device_info) module is easier to maintain and use. | Alternative:bigip_device_info

community.network.bigip_facts (0.1.0) — module

Collect facts from F5 BIG-IP devices

Authors: Matt Hite (@mhite), Tim Rupp (@caphrim007)

Install collection

Install with ansible-galaxy collection install community.network:==0.1.0


Add to requirements.yml

  collections:
    - name: community.network
      version: 0.1.0

Description

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


Requirements

Usage examples

  • 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:
    description:
    - Shell-style glob matching string used to filter fact keys. Not applicable for software,
      provision, and system_info fact categories.

include:
    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
    description:
    - Fact category or list of categories to collect
    required: true

session:
    default: false
    description:
    - BIG-IP session support; may be useful to avoid concurrency issues in certain circumstances.
    type: bool

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
      password:
        aliases:
        - pass
        - pwd
        description:
        - The password for the user account used to connect to the BIG-IP.
        - You may omit this option by setting the environment variable C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP 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
      ssh_keyfile:
        description:
        - Specifies the SSH keyfile to use to authenticate the connection to the remote
          device.  This argument is only used for I(cli) transports.
        - You may omit this option by setting the environment variable C(ANSIBLE_NET_SSH_KEYFILE).
        type: path
      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:
        - cli
        - 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 with. 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