f5networks.f5_modules.bigip_monitor_http – Управляет мониторами HTTP F5 BIG-IP LTM

Примечание

Этот плагин является частью коллекции f5networks.f5_modules (версия 1.6.0).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_monitor_http.

Новое в версии 1.0.0: of f5networks.f5_modules

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Управляет мониторами HTTP F5 BIG-IP LTM.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
description строка			Описание монитора.
interval целое число			Интервал, определяющий частоту запуска экземпляра монитора этой шаблона. Если этот параметр не задан при создании нового монитора, значение по умолчанию составляет 5. Это значение должно быть меньше значения `timeout`.
ip строка			Часть IP-адреса в определении IP/порт. Если этот параметр не задан при создании нового монитора, значение по умолчанию — «*».
name строка / обязательно			Имя монитора.
parent строка		Значение по умолчанию: "/Common/http"	Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение — родительский шаблон `http` на раздела `Common`.
partition строка		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
port строка			Адрес порта в определении IP/порт. Если этот параметр не задан при создании нового монитора, значение по умолчанию — «*». Если указан IP-адрес, необходимо указать значение от 1 до 65535.
provider словарь добавлен в 1.0.0 f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика авторизации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem булево	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются на F5. Этот параметр можно опустить, установив переменную среды `F5_TEEM`.
	password строка / обязательно		Пароль учетной записи пользователя для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER_PORT`.
	timeout целое число		Устанавливает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль вернёт ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
	validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на управляемых вами сайтах с самозаверенными сертификатами. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.
receive строка			Строка приема для вызова монитора.
receive_disable строка			Эта настройка работает как `receive`, за исключением того, что система помечает узел или члена пула как неактивный, когда его ответ соответствует строке `receive_disable`, но не строке `receive`. Чтобы использовать эту настройку, необходимо указать как `receive_disable`, так и `receive`.
reverse булево		Варианты: no yes	Определяет, работает ли монитор в обратном режиме. При работе монитора в обратном режиме совпадение строки приема помечает контролируемый объект как выключенный, а не включенный. Этот режим можно использовать только при настройке параметра `receive`. Этот параметр несовместим с параметром `time_until_up`. Если `time_until_up` указан, он должен быть `0`. Или, если он уже существует, он должен быть `0`.
send строка			Строка отправки для вызова монитора. При создании нового монитора, если это значение не задано, используется значение по умолчанию `GET /\r\n`.
state строка		Варианты: present ← absent	При значении `present`, гарантирует существование монитора. При значении `absent`, гарантирует удаление монитора.
target_password строка			Указывает пароль, если контролируемый объект требует аутентификации.
target_username строка			Указывает имя пользователя, если контролируемый объект требует аутентификации.
time_until_up целое число			Указывает количество секунд после первого успешного ответа, прежде чем узел помечается как активный. Значение 0 приводит к тому, что узел помечается как активный сразу после получения действительного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 0.
timeout целое число			Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если цель отвечает в установленный период времени, она считается активной. Если цель не отвечает в установленный период времени, она считается неактивной. Можно изменить это на любое число, однако оно должно быть в 3 раза больше интервала плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию — 16.

Примечания

Примечание

Требуется версия ПО BIG-IP ≥ 12
Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP ≥ 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что специфичная для BIG-IP конфигурация сохраняется на диске, убедитесь, что вы включили хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Create HTTP Monitor
  bigip_monitor_http:
    state: present
    ip: 10.10.10.10
    name: my_http_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove HTTP Monitor
  bigip_monitor_http:
    state: absent
    name: my_http_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Include a username and password in the HTTP monitor
  bigip_monitor_http:
    state: absent
    name: my_http_monitor
    target_username: monitor_user
    target_password: monitor_pass
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Возвращаемые значения

Общие значения возвращаемых данных документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
description string	изменённое	Описание монитора. Пример: Important_Monitor
interval integer	изменённое	Новый интервал, через который нужно запускать проверку монитора. Пример: 2
ip string	изменённое	Новый IP-адрес определения IP/порта. Пример: 10.12.13.14
parent string	изменённое	Новый родительский шаблон монитора. Пример: http
reverse boolean	изменённое	Определяет, работает ли монитор в обратном режиме. Пример: True
time_until_up integer	изменённое	Новое время, в течение которого система должна быть помечена как активная после первого успешного ответа. Пример: 2
timeout integer	изменённое	Новый таймаут, в течение которого удалённая система должна ответить на монитор. Пример: 10

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_monitor_http_module.html