W3cubDocs

/Ansible

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, provision, and system_info fact categories.
include
 yes
  • 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
Fact category or list of categories to collect
password
 yes
The password for the user account used to connect to the BIG-IP.
server
 yes
The BIG-IP host.
server_port
(added in 2.2)
 no 443
The BIG-IP server port.
session
 no True
BIG-IP session support; may be useful to avoid concurrency issues in certain circumstances.
user
 yes
The username to connect to the BIG-IP with. This user must have administrative privileges on the device.
validate_certs
(added in 2.0)
 no True
  • True
  • False
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Examples

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

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

Note

provision facts were added in 2.2

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, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/bigip_facts_module.html