bigip_gtm_monitor_http – Управляет мониторами HTTP F5 BIG-IP GTM

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

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

Обзор

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

Требования

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

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ignore_down_response boolean		Варианты: no yes	Указывает, что монитор допускает более одной попытки запроса к зонду за интервал. Когда `yes`, указывает, что монитор игнорирует ответы о недоступности (down) в течение времени ожидания монитора. После истечения времени ожидания монитора без получения ответа о доступности (up) система помечает объект как недоступный. Когда `no`, указывает, что монитор сразу помечает объект как недоступный при получении ответа о недоступности. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `no`.
interval -			Интервал, определяющий частоту выполнения экземпляра монитора этого шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 30. Это значение должно быть меньше значения `timeout`.
ip -			Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение - IP-адрес, то необходимо указать числовой `port`.
name - / обязательно			Имя монитора.
parent -		Значение по умолчанию: "/Common/http"	Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это родительский элемент `tcp` на разделе `Common`.
partition -		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
password - / обязательно			Пароль учетной записи пользователя для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
port -			Порт в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если указан IP-адрес, должно быть указано значение от 1 до 65535.
probe_timeout -			Указывает количество секунд, после которых система ожидает ответа на запрос к зонду. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `5`.
provider - добавлено в 2.5		Значение по умолчанию: null	Объект типа dict, содержащий данные подключения.
	password - / обязательно		Пароль учетной записи пользователя для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server - / обязательно		Хост BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER`.
	server_port -	Значение по умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER_PORT`.
	ssh_keyfile -		Указывает SSH-ключевой файл для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Этот параметр можно опустить, установив переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout -	Значение по умолчанию: 10	Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания превышено до завершения операции, модуль выдаст ошибку.
	transport - / обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user - / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.
receive -			Строка для приёма для вызова монитора.
reverse boolean		Варианты: no yes	Указывает системе помечать целевой ресурс как недоступный (down) при успешном тесте. Это полезно, например, если содержимое домашней страницы вашего сайта динамично и часто меняется, вы можете настроить обратный ECV-чек, ищущий строку "Error". Совпадение с этой строкой означает, что веб-сервер был недоступен. Чтобы использовать этот параметр, необходимо указать значения для `send` и `receive`.
send -			Строка для отправки для вызова монитора. При создании нового монитора, если этот параметр не указан, будет использовано значение по умолчанию `GET /\r\n`.
server - / обязательно			Хост BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER`.
server_port - добавлено в 2.2		Значение по умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды `F5_SERVER_PORT`.
state -		Варианты: present ← absent	При `present`, гарантирует, что монитор существует. При `absent`, гарантирует удаление монитора.
target_password -			Указывает пароль, если контролируемый целевой объект требует аутентификации.
target_username -			Указывает имя пользователя, если контролируемый целевой объект требует аутентификации.
timeout -			Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в заданный период времени, он считается доступным. Если целевой объект не отвечает в заданный период времени, он считается недоступным. Вы можете изменить это число на любое, но оно должно быть в 3 раза больше интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 120.

прозрачный boolean	Варианты: нет да	Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через соответствующих членов пула или узлов (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (то есть исследует комбинацию `ip`-`port` указанную в мониторе). Если монитор не может успешно достичь алиасного пункта назначения, член пула или узел, через который был отправлен трафик монитора, помечаются как недоступные. При создании нового монитора, если этот параметр не задан, значение по умолчанию будет `no`.
update_password -	Варианты: всегда ← при_создании	`always` обновит пароли, если `target_password` задан. `on_create` установит пароль только для вновь созданных мониторов.
user - / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, задав переменную окружения `F5_USER`.
validate_certs boolean добавлено в 2.0	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на сайтах, находящихся под вашим контролем, использующих самозаверяющие сертификаты. Этот параметр можно опустить, задав переменную окружения `F5_VALIDATE_CERTS`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 работают только с текущей конфигурацией продукта F5. Чтобы гарантировать, что конфигурация, специфичная для BIG-IP, сохранится на диске, убедитесь, что включён хотя бы один таск, использующий модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения вашей текущей конфигурации.

Примеры

- name: Create a GTM HTTP monitor
  bigip_gtm_monitor_http:
    name: my_monitor
    ip: 1.1.1.1
    port: 80
    send: my send string
    receive: my receive string
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  delegate_to: localhost

- name: Remove HTTP Monitor
  bigip_gtm_monitor_http:
    name: my_monitor
    state: absent
    server: lb.mydomain.com
    user: admin
    password: secret
  delegate_to: localhost

- name: Add HTTP monitor for all addresses, port 514
  bigip_gtm_monitor_http:
    name: my_monitor
    server: lb.mydomain.com
    user: admin
    port: 514
    password: secret
  delegate_to: localhost

Значения возврата

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

Ключ	Возвращённое	Описание
ignore_down_response boolean	изменилось	Игнорировать ли ответ о недоступности. Пример: True
interval целое число	изменилось	Новый интервал для проверки монитора. Пример: 2
ip строка	изменилось	Новый IP адрес определения IP/порта. Пример: 10.12.13.14
parent строка	изменилось	Новая родительская шаблон монитора. Пример: http
port строка	изменилось	Новый порт, на котором монитор проверяет ресурс. Пример: 8080
probe_timeout целое число	изменилось	Новый таймаут, в котором система будет ожидать ответа монитора. Пример: 10
receive строка	изменилось	Новая строка приёма для данного монитора. Пример: tcp строка для приёма
reverse boolean	изменилось	Новое значение для работы монитора в обратном режиме.
send строка	изменилось	Новая строка отправки для данного монитора. Пример: tcp строка для отправки
timeout целое число	изменилось	Новый таймаут, в течение которого удалённая система должна ответить монитору. Пример: 10
прозрачный boolean	изменилось	Новое значение для работы монитора в прозрачном режиме.

Статус

Этот модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается партнёром 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.7/modules/bigip_gtm_monitor_http_module.html