New in version 2.3.
Removed in Ansible: | |
---|---|
version: 2.11 | |
Why: | The bigip_gtm_facts module is an outlier as all facts are being collected in the bigip_device_facts module. Additionally, the bigip_device_facts module is easier to maintain and use. |
Alternative: | bigip_device_facts |
The below requirements are needed on the host that executes this module.
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 may omit this option by setting the environment variable
F5_PASSWORD .aliases: pass, pwd |
||
provider
(added in 2.5) |
Default: None
|
A dict object containing connection details.
|
|
password
required |
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable
F5_PASSWORD .aliases: pass, pwd |
||
server
required |
The BIG-IP host.
You may omit this option by setting the environment variable
F5_SERVER . |
||
server_port |
Default: 443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT . |
|
user
required |
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
F5_USER . |
||
validate_certs
bool |
|
If
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
F5_VALIDATE_CERTS . |
|
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.
|
|
ssh_keyfile |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports.
You may omit this option by setting the environment variable
ANSIBLE_NET_SSH_KEYFILE . |
||
transport
required |
|
Configures the transport connection to use when connecting to the remote device.
|
|
server
required |
The BIG-IP host.
You may omit this option by setting the environment variable
F5_SERVER . |
||
server_port
(added in 2.2) |
Default: 443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT . |
|
user
required |
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
F5_USER . |
||
validate_certs
bool (added in 2.0) |
|
If
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
F5_VALIDATE_CERTS . |
Note
bigip_device_facts
module instead.pip install f5-sdk
.- name: Get pool facts
bigip_gtm_facts:
server: lb.mydomain.com
user: admin
password: secret
include: pool
filter: my_pool
delegate_to: localhost
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': [{'alternate_mode': 'round-robin', 'dynamic_ratio': 'disabled', 'enabled': True, 'fallback_mode': 'return-to-dns', 'full_path': '/Common/d3qw', 'load_balancing_mode': 'round-robin', 'manual_resume': 'disabled', 'max_answers_returned': 1, 'members': [{'disabled': True, 'flags': 'a', 'full_path': 'ok3.com', 'member_order': 0, 'name': 'ok3.com', 'order': 10, 'preference': 10, 'ratio': 1, 'service': 80}], 'name': 'd3qw', 'partition': 'Common', 'qos_hit_ratio': 5, 'qos_hops': 0, 'qos_kilobytes_second': 3, 'qos_lcs': 30, 'qos_packet_rate': 1, 'qos_rtt': 50, 'qos_topology': 0, 'qos_vs_capacity': 0, 'qos_vs_score': 0, 'availability_state': 'offline', 'enabled_state': 'disabled', 'ttl': 30, 'type': 'naptr', 'verify_member_availability': 'disabled'}]}
|
server
list
|
changed |
Contains the virtual server enabled and availability status, and address.
Sample:
{'server': [{'addresses': [{'device_name': '/Common/qweqwe', 'name': '10.10.10.10', 'translation': 'none'}], 'datacenter': '/Common/xfxgh', 'enabled': True, 'expose_route_domains': False, 'full_path': '/Common/qweqwe', 'iq_allow_path': True, 'iq_allow_service_check': True, 'iq_allow_snmp': True, 'limit_cpu_usage': 0, 'limit_cpu_usage_status': 'disabled', 'limit_max_bps': 0, 'limit_max_bps_status': 'disabled', 'limit_max_connections': 0, 'limit_max_connections_status': 'disabled', 'limit_max_pps': 0, 'limit_max_pps_status': 'disabled', 'limit_mem_avail': 0, 'limit_mem_avail_status': 'disabled', 'link_discovery': 'disabled', 'monitor': '/Common/bigip', 'name': 'qweqwe', 'partition': 'Common', 'product': 'single-bigip', 'virtual_server_discovery': 'disabled', 'virtual_servers': [{'destination': '10.10.10.10:0', 'enabled': True, 'full_path': 'jsdfhsd', 'limit_max_bps': 0, 'limit_max_bps_status': 'disabled', 'limit_max_connections': 0, 'limit_max_connections_status': 'disabled', 'limit_max_pps': 0, 'limit_max_pps_status': 'disabled', 'name': 'jsdfhsd', 'translation_address': 'none', 'translation_port': 0}]}]}
|
wide_ip
list
|
changed |
Contains the lb method for the wide ip and the pools that are within the wide ip.
Sample:
{'wide_ip': [{'enabled': True, 'failure_rcode': 'noerror', 'failure_rcode_response': 'disabled', 'failure_rcode_ttl': 0, 'full_path': '/Common/foo.ok.com', 'last_resort_pool': '', 'minimal_response': 'enabled', 'name': 'foo.ok.com', 'partition': 'Common', 'persist_cidr_ipv4': 32, 'persist_cidr_ipv6': 128, 'persistence': 'disabled', 'pool_lb_mode': 'round-robin', 'pools': [{'name': 'd3qw', 'order': 0, 'partition': 'Common', 'ratio': 1}], 'ttl_persistence': 3600, 'type': 'naptr'}]}
|
This module is flagged as deprecated and will be removed in version 2.11. For more information see DEPRECATED.
Hint
If you notice any issues in this documentation you can edit this document to improve it.