Documentation

bigip_facts - Collect facts from F5 BIG-IP devices

New in version 1.6.

Synopsis

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

Requirements (on host that executes module)

  • bigsuds

Options

parameter required default choices comments
filter
 no
    Shell-style glob matching string used to filter fact keys. Not applicable for software and system_info fact categories.
    include
    		 yes
    • address_class
    • certificate
    • client_ssl_profile
    • device
    • device_group
    • interface
    • key
    • node
    • pool
    • rule
    • self_ip
    • software
    • system_info
    • traffic_group
    • trunk
    • virtual_address
    • virtual_server
    • vlan
    Fact category or list of categories to collect
    password
    		 yes
      BIG-IP password
      server
      		 yes
        BIG-IP host
        session
        		 no True
          BIG-IP session support; may be useful to avoid concurrency issues in certain circumstances.
          user
          		 yes
            BIG-IP username
            validate_certs
            (added in 2.0)
            		 no yes
            • yes
            • no
            If no, SSL certificates will not be validated. This should only be used on personally controlled sites. Prior to 2.0, this module would always validate on python >= 2.7.9 and never validate on python <= 2.7.8

            Examples

            ## playbook task examples:

---
# file bigip-test.yml
# ...
- hosts: bigip-test
  tasks:
  - name: Collect BIG-IP facts
    local_action: >
      bigip_facts
      server=lb.mydomain.com
      user=admin
      password=mysecret
      include=interface,vlan

            Notes

            Note

            Requires BIG-IP software version >= 11.4

            Note

            F5 developed module ‘bigsuds’ required (see http://devcentral.f5.com)

            Note

            Best run as a local_action in your playbook

            Note

            Tested with manager and above account privilege level

            This is an Extras Module

            For more information on what this means please read Extras Modules

            For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.