bigip_gtm_monitor_http - Управляет мониторами http F5 BIG-IP GTM
Новая версия с 2.6.
Обзор
- Управляет мониторами http F5 BIG-IP GTM.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ignore_down_response bool |
| Указывает, что монитор допускает более одной попытки зондирования за интервал. Когда yes, указывает, что монитор игнорирует ответы о недоступности в течение времени ожидания монитора. После истечения времени ожидания монитора без получения ответа о доступности система помечает объект как недоступный.Когда 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) | Объект типа dict, содержащий данные подключения. | ||
| 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 обязательно |
| Настраивает транспортное подключение для использования при подключении к удалённому устройству. | |
| receive | Строка приёма для вызова монитора. | ||
| reverse bool |
| Инструктирует систему помечать целевой ресурс как недоступный, когда тест успешен. Эта настройка полезна, например, если содержимое домашней страницы вашего веб-сайта динамично и часто меняется, вы можете настроить обратный ECV-проверка, ищущий строку Ошибка. Совпадение с этой строкой означает, что веб-сервер был недоступен. Для использования этого параметра необходимо указать значения для send и receive. | |
| send | Строка отправки для вызова монитора. При создании нового монитора, если этот параметр не указан, будет использоваться значение по умолчанию GET /\r\n. | ||
| server обязательно | Хост BIG-IP. Этот параметр можно опустить, если установлена переменная окружения F5_SERVER. | ||
| server_port (добавлено в 2.2) | Значение по умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, если установлена переменная окружения F5_SERVER_PORT. | |
| state |
| Когда present, гарантирует, что монитор существует.Когда absent, гарантирует удаление монитора. | |
| target_password | Указывает пароль, если контролируемый объект требует аутентификации. | ||
| target_username | Указывает имя пользователя, если контролируемый объект требует аутентификации. | ||
| timeout | Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если цель отвечает в установленный период времени, она считается доступной. Если цель не отвечает в установленный период времени, она считается недоступной. Вы можете изменить это значение на любое, но оно должно быть в 3 раза больше значения интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 120. | ||
| transparent bool |
| Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через соответствующие члены пула или узлы (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (то есть он зондирует комбинацию ip-port , указанную в мониторе).Если монитор не может успешно достичь алиасного пункта назначения, член пула или узел, через который проходил трафик монитора, помечаются как недоступные. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет no. | |
| update_password |
| always обновит пароли, если указан target_password. on_create установит пароль только для вновь созданных мониторов. | |
| 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: 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 bool | изменено | Игнорировать ли ответ о снижении производительности. Пример: True |
| interval int | изменено | Новый интервал для выполнения проверки мониторинга. Пример: 2 |
| ip string | изменено | Новый IP-адрес для определения IP/порта. Пример: 10.12.13.14 |
| parent string | изменено | Новая родительская шаблон монитора. Пример: http |
| port string | изменено | Новый порт, на котором монитор проверяет ресурс. Пример: 8080 |
| probe_timeout int | изменено | Новый таймаут, в течение которого система будет ожидать ответа зонда монитора. Пример: 10 |
| receive string | изменено | Новая строка приёма для этого монитора. Пример: tcp строка для приёма |
| reverse bool | изменено | Новое значение для работы монитора в обратном режиме. |
| send string | изменено | Новая строка отправки для этого монитора. Пример: tcp строка для отправки |
| timeout int | изменено | Новый таймаут, в течение которого удаленная система должна ответить на запрос монитора. Пример: 10 |
| transparent bool | изменено | Новое значение для работы монитора в прозрачном режиме. |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет совместим со старыми версиями.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество 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_monitor_http_module.html