bigip_gtm_facts - Сбор фактов с устройств F5 BIG-IP GTM

Новая версия с 2.3.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

Сбор фактов с устройств F5 BIG-IP GTM.

Требования

Ниже перечислены требования, которые необходимы на хосте, на котором выполняется этот модуль.

f5-sdk >= 3.0.9

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
filter			Выполнить фильтрацию ответа с помощью регулярного выражения. Фильтрация выполняется по имени ресурса. Допустимые фильтры — всё, что можно передать в модуль Python `re`.
include обязательно		Варианты: pool wide_ip server	Категория фактов для сбора.
password обязательно			Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, если переменная окружения `F5_PASSWORD` задана. Псевдонимы: pass, pwd
provider (добавлено в 2.5)			Объект словаря, содержащий сведения о подключении.
	password обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, если переменная окружения `F5_PASSWORD` задана. Псевдонимы: pass, pwd
	server обязательно		Хост BIG-IP. Этот параметр можно опустить, если переменная окружения `F5_SERVER` задана.
	server_port	По умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, если переменная окружения `F5_SERVER_PORT` задана.
	user обязательно		Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно опустить, если переменная окружения `F5_USER` задана.
	validate_certs bool	Варианты: нет да ←	Если `no`, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами. Этот параметр можно опустить, если переменная окружения `F5_VALIDATE_CERTS` задана.
	timeout	По умолчанию: 10	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт, прежде чем операция будет завершена, модуль выдаст ошибку.
	ssh_keyfile		Указывает файл SSH-ключа для аутентификации соединения с удалённым устройством. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	transport обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для подключения к удалённому устройству.
server обязательно			Хост BIG-IP. Этот параметр можно опустить, если переменная окружения `F5_SERVER` задана.
server_port (добавлено в 2.2)		По умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, если переменная окружения `F5_SERVER_PORT` задана.
user обязательно			Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно опустить, если переменная окружения `F5_USER` задана.
validate_certs bool (добавлено в 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': [{'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 список	changed	Содержит состояние включения и доступности виртуального сервера, а также адрес. Пример: {'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 список	changed	Содержит метод lb для широкого IP-адреса и пулы, которые находятся в широком IP-адресе. Пример: {'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'}]}

Статус

Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантирует обратной совместимости.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. в разделе Техническое обслуживание и поддержка модулей.

Для списка других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/bigip_gtm_facts_module.html