bigip_gtm_facts - Collect facts from F5 BIG-IP GTM devices
New in version 2.3.
Synopsis
- Collect facts from F5 BIG-IP GTM devices.
Requirements
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.9
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
filter | Perform regex filter of response. Filtering is done on the name of the resource. Valid filters are anything that can be provided to Python's re module. | ||
include required |
| Fact category 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) | Default: None | 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 |
| 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 |
| 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. | |
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 (added in 2.0) |
| 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
- 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: Get pool facts bigip_gtm_facts: server: lb.mydomain.com user: admin password: secret include: pool filter: my_pool delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
pool list | changed | Contains the pool object status and enabled status. Sample: {'pool': [{'verify_member_availability': 'disabled', 'partition': 'Common', 'qos_packet_rate': 1, 'qos_hit_ratio': 5, 'alternate_mode': 'round-robin', 'members': [{'ratio': 1, 'name': 'ok3.com', 'service': 80, 'member_order': 0, 'disabled': True, 'flags': 'a', 'preference': 10, 'order': 10, 'full_path': 'ok3.com'}], 'ttl': 30, 'enabled_state': 'disabled', 'qos_vs_score': 0, 'qos_topology': 0, 'load_balancing_mode': 'round-robin', 'max_answers_returned': 1, 'fallback_mode': 'return-to-dns', 'qos_rtt': 50, 'name': 'd3qw', 'qos_hops': 0, 'qos_kilobytes_second': 3, 'qos_lcs': 30, 'enabled': True, 'qos_vs_capacity': 0, 'availability_state': 'offline', 'manual_resume': 'disabled', 'full_path': '/Common/d3qw', 'type': 'naptr', 'dynamic_ratio': 'disabled'}]} |
server list | changed | Contains the virtual server enabled and availability status, and address. Sample: {'server': [{'product': 'single-bigip', 'virtual_servers': [{'limit_max_pps_status': 'disabled', 'name': 'jsdfhsd', 'destination': '10.10.10.10:0', 'enabled': True, 'translation_address': 'none', 'limit_max_pps': 0, 'limit_max_bps': 0, 'limit_max_bps_status': 'disabled', 'limit_max_connections': 0, 'limit_max_connections_status': 'disabled', 'full_path': 'jsdfhsd', 'translation_port': 0}], 'addresses': [{'translation': 'none', 'name': '10.10.10.10', 'device_name': '/Common/qweqwe'}], 'datacenter': '/Common/xfxgh', 'limit_cpu_usage': 0, 'expose_route_domains': False, 'virtual_server_discovery': 'disabled', 'iq_allow_snmp': True, 'iq_allow_service_check': True, 'limit_max_bps_status': 'disabled', 'limit_max_connections': 0, 'limit_cpu_usage_status': 'disabled', 'limit_max_pps_status': 'disabled', 'link_discovery': 'disabled', 'iq_allow_path': True, 'monitor': '/Common/bigip', 'limit_mem_avail_status': 'disabled', 'limit_mem_avail': 0, 'partition': 'Common', 'enabled': True, 'name': 'qweqwe', 'limit_max_pps': 0, 'limit_max_bps': 0, 'limit_max_connections_status': 'disabled', 'full_path': '/Common/qweqwe'}]} |
wide_ip list | changed | Contains the lb method for the wide ip and the pools that are within the wide ip. Sample: {'wide_ip': [{'pool_lb_mode': 'round-robin', 'last_resort_pool': '', 'persist_cidr_ipv4': 32, 'persist_cidr_ipv6': 128, 'name': 'foo.ok.com', 'failure_rcode_response': 'disabled', 'failure_rcode': 'noerror', 'partition': 'Common', 'enabled': True, 'failure_rcode_ttl': 0, 'ttl_persistence': 3600, 'full_path': '/Common/foo.ok.com', 'pools': [{'partition': 'Common', 'ratio': 1, 'name': 'd3qw', 'order': 0}], 'minimal_response': 'enabled', 'type': 'naptr', 'persistence': 'disabled'}]} |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Tim Rupp (@caphrim007)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/bigip_gtm_facts_module.html