bigip_facts - Collect facts from F5 BIG-IP devices¶

New in version 1.6.

Synopsis
- Requirements
Parameters
Notes
Examples
Status
Maintenance
- Author

Synopsis ¶

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

Requirements ¶

The below requirements are needed on the host that executes this module.

bigsuds
f5-sdk >= 3.0.9

Parameters ¶

Parameter		Choices/Defaults	Comments
filter			Shell-style glob matching string used to filter fact keys. Not applicable for software, provision, and system_info fact categories.
include required		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	Fact category or list of categories to collect
password required			The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable `F5_PASSWORD` is set. aliases: pass, pwd
provider (added in 2.5)			A dict object containing connection details.
	ssh_keyfile		Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
	timeout	Default: 10	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.
	server required		The BIG-IP host. You can omit this option if the environment variable `F5_SERVER` is set.
	user required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable `F5_USER` is set.
	server_port	Default: 443	The BIG-IP server port. You can omit this option if the environment variable `F5_SERVER_PORT` is set.
	password required		The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable `F5_PASSWORD` is set. aliases: pass, pwd
	validate_certs bool	Choices: no yes ←	If `no`, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable `F5_VALIDATE_CERTS` is set.
	transport required	Choices: rest cli ←	Configures the transport connection to use when connecting to the remote device.
server required			The BIG-IP host. You can omit this option if the environment variable `F5_SERVER` is set.
server_port (added in 2.2)		Default: 443	The BIG-IP server port. You can omit this option if the environment variable `F5_SERVER_PORT` is set.
session bool		Choices: no ← yes	BIG-IP session support; may be useful to avoid concurrency issues in certain circumstances.
user required			The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable `F5_USER` is set.
validate_certs bool (added in 2.0)		Choices: no yes ←	If `no`, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable `F5_VALIDATE_CERTS` is set.

Notes ¶

Note

Requires BIG-IP software version >= 11.4
F5 developed module ‘bigsuds’ required (see http://devcentral.f5.com)
Best run as a local_action in your playbook
Tested with manager and above account privilege level
provision facts were added in 2.2
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.

Examples ¶

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

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

Matt Hite (@mhite)
Tim Rupp (@caphrim007)

Hint

If you notice any issues in this documentation you can edit this document to improve it.