f5networks.f5_modules.bigip_gtm_monitor_http – Управляет HTTP-мониторами F5 BIG-IP GTM
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в книге задач укажите: f5networks.f5_modules.bigip_gtm_monitor_http.
Новый в версии 1.0.0: модуля f5networks.f5_modules
Обзор
- Управляет HTTP-мониторами F5 BIG-IP GTM (теперь BIG-IP DNS).
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ignore_down_response boolean |
| Указывает, что монитор позволяет более одной попытки зондирования за интервал. Когда yes, указывает, что монитор игнорирует ответы о недоступности в течение времени ожидания монитора. Как только время ожидания монитора истечёт, а система не получит ответа о доступности, система помечает объект как недоступный.Когда no, указывает, что монитор сразу помечает объект как недоступный при получении ответа о недоступности.При создании нового монитора, если этот параметр не указан, значение по умолчанию будет no. | |
| interval integer | Интервал, определяющий частоту выполнения экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 30. Это значение должно быть меньше timeout значения. | ||
| ip string | IP-адрес, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение — IP-адрес, то необходимо указать port число. | ||
| name string / обязательно | Имя монитора. | ||
| parent string | По умолчанию: "/Common/http" | Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение — родительский http на Common раздела. | |
| partition string | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| port string | Адрес порта, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если указывается IP-адрес, необходимо использовать значение от 1 до 65535. | ||
| probe_timeout integer | Указывает количество секунд, после которого система отключает запрос зондирования к системе. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет 5. | ||
| provider dictionary добавлен в 1.0.0 f5networks.f5_modules | Объект словаря, содержащий сведения о подключении. | ||
| auth_provider string | Настраивает поставщика аутентификации для получения токенов аутентификации от удалённого устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | ||
| no_f5_teem boolean |
| Если yes, данные телеметрии TEEM не отправляются в F5.Вы можете опустить этот параметр, задав переменную среды F5_TEEM. | |
| password string / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, задав переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| server string / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, задав переменную среды F5_SERVER. | ||
| server_port integer | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, задав переменную среды F5_SERVER_PORT. | |
| timeout integer | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания превышено до завершения операции, модуль вернёт ошибку. | ||
| transport string |
| Настраивает транспортное подключение для использования при подключении к удалённому устройству. | |
| user string / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, задав переменную среды F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющимися сертификатами.Вы можете опустить этот параметр, задав переменную среды F5_VALIDATE_CERTS. | |
| receive string | Строка приёма для вызова монитора. | ||
| reverse boolean |
| Инструктирует систему помечать целевой ресурс как недоступный, когда тест успешен. Эта настройка полезна, например, если содержимое домашней страницы вашего веб-сайта динамичное и часто меняется, вы можете настроить обратный ECV-проверку службы, которая ищет строку "Error". Совпадение с этой строкой означает, что веб-сервер был недоступен. Для использования этого параметра вы должны указать значения для send и receive. | |
| send string | Строка отправки для вызова монитора. При создании нового монитора, если этот параметр не указан, по умолчанию будет использовано значение GET /\r\n. | ||
| state string |
| Когда present, гарантирует, что монитор существует.Когда absent, гарантирует, что монитор удалён. | |
| target_password string | Указывает пароль, если контролируемый целевой объект требует аутентификации. | ||
| target_username string | Указывает имя пользователя, если контролируемый целевой объект требует аутентификации. | ||
| timeout integer | Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение установленного периода времени, он считается доступным. Если целевой объект не отвечает в течение установленного периода времени, он считается недоступным. Вы можете изменить это значение на любое число, однако оно должно быть в 3 раза больше интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 120. | ||
| transparent boolean |
| Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через соответствующие члены пула или узлы (обычно маршрутизатор или брандмауэр) к целевому адресу (то есть он зондирует ip-%-port комбинацию, указанную в мониторе).Если монитор не может успешно достичь целевого адреса, член пула или узел, через который отправлялся трафик монитора, помечается как недоступный. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет no. | |
| update_password string |
| always обновит пароли, если указан target_password.on_create установит пароль только для новых мониторов. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы гарантировать сохранение специфичной для BIG-IP конфигурации на диске, убедитесь, что в задаче используется модуль f5networks.f5_modules.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
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Remove HTTP Monitor
bigip_gtm_monitor_http:
name: my_monitor
state: absent
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Add HTTP monitor for all addresses, port 514
bigip_gtm_monitor_http:
name: my_monitor
port: 514
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ignore_down_response boolean | изменено | Игнорировать ответ о неисправности или нет. Пример: True |
| interval integer | изменено | Новый интервал выполнения проверки мониторинга. Пример: 2 |
| ip string | изменено | Новый IP-адрес для определения IP/порта. Пример: 10.12.13.14 |
| parent string | изменено | Новая родительская шаблон монитора. Пример: http |
| port string | изменено | Новый порт, на котором монитор проверяет ресурс. Пример: 8080 |
| probe_timeout integer | изменено | Новый таймаут для проверки мониторинга. Пример: 10 |
| receive string | изменено | Новая строка приема для этого монитора. Пример: tcp строка приема |
| reverse boolean | изменено | Новое значение для работы монитора в обратном режиме. |
| send string | изменено | Новая строка отправки для этого монитора. Пример: tcp строка отправки |
| timeout integer | изменено | Новый таймаут, в течение которого удаленная система должна ответить на запрос монитора. Пример: 10 |
| transparent boolean | изменено | Новое значение для работы монитора в прозрачном режиме. |
Авторы
- 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_gtm_monitor_http_module.html
