bigip_gtm_facts - Сбор фактов с устройств F5 BIG-IP GTM
Новая версия с 2.3.
Обзор
- Сбор фактов с устройств F5 BIG-IP GTM.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| filter | Выполнить фильтрацию ответа с использованием регулярного выражения. Фильтрация выполняется по имени ресурса. Допустимые фильтры — все, что можно передать модулю Python re. | ||
| include обязательно |
| Категория фактов для сбора. | |
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить этот параметр, если установлена переменная среды F5_PASSWORD. Псевдонимы: pass, pwd | ||
| provider (добавлен в 2.5) | Значение по умолчанию: None | Объект dict, содержащий данные подключения. | |
| ssh_keyfile | Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. | |
| server обязательно | Хост BIG-IP. Можно опустить этот параметр, если установлена переменная среды F5_SERVER. | ||
| user обязательно | Имя пользователя для подключения к BIG-IP. Пользователь должен иметь административные права на устройстве. Можно опустить этот параметр, если установлена переменная среды F5_USER. | ||
| server_port | Значение по умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, если установлена переменная среды F5_SERVER_PORT. | |
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить этот параметр, если установлена переменная среды F5_PASSWORD. Псевдонимы: pass, pwd | ||
| validate_certs |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах с собственными сертификатами, контролируемых вами. Можно опустить этот параметр, если установлена переменная среды F5_VALIDATE_CERTS. | |
| transport обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| server обязательно | Хост BIG-IP. Можно опустить этот параметр, если установлена переменная среды F5_SERVER. | ||
| server_port (добавлен в 2.2) | Значение по умолчанию: 443 | Порт сервера BIG-IP. Можно опустить этот параметр, если установлена переменная среды F5_SERVER_PORT. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Пользователь должен иметь административные права на устройстве. Можно опустить этот параметр, если установлена переменная среды F5_USER. | ||
| validate_certs (добавлен в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах с собственными сертификатами, контролируемых вами. Можно опустить этот параметр, если установлена переменная среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
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
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| pool список | changed | Содержит состояние объекта пула и состояние включения. Пример: {'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 список | changed | Содержит состояние включения и доступности виртуальных серверов, а также адрес. Пример: {'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 список | changed | Содержит метод сбалансированной загрузки для широкого IP и пулы, которые находятся в широком IP. Пример: {'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'}]} |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.
Автор
- Tim Rupp (@caphrim007)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.
© 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