bigip_gtm_monitor_tcp – Управляет F5 BIG-IP GTM мониторами tcp
Новое в версии 2.6.
Обзор
- Управляет F5 BIG-IP GTM мониторами tcp.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ignore_down_response boolean |
| Указывает, что монитор позволяет более одной попытки зондирования за интервал. Когда yes, указывает, что монитор игнорирует ответы о недоступности на период таймаута монитора. После истечения таймаута монитора без получения ответа о доступности система помечает объект как недоступный.Когда no, указывает, что монитор сразу отмечает объект как недоступный при получении ответа о недоступности.При создании нового монитора, если этот параметр не указан, значение по умолчанию будет no. | |
| interval integer | Интервал, определяющий частоту выполнения экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 30. Это значение должно быть меньше значения timeout. | ||
| ip string | IP-адрес, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение — IP-адрес, то должно быть указано port число. | ||
| name string / обязательно | Имя монитора. | ||
| parent string | По умолчанию: "/Common/tcp" | Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это родительский tcp в Common разделе. | |
| partition string | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| port string | Адрес порта, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если вы указываете IP-адрес, должно быть указано значение от 1 до 65535 | ||
| probe_timeout integer | Устанавливает количество секунд, после которых система отменяет запрос зондирования к системе. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет 5. | ||
| provider dictionary добавлено в 2.5 | Объект dict, содержащий данные подключения. | ||
| auth_provider string | Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ. | ||
| password string / обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_PASSWORD.псевдонимы: pass, pwd | ||
| server string / обязательно | Хост BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_SERVER. | ||
| server_port integer | По умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Этот параметр можно опустить, установив переменную окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| 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 | Строка отправки для вызова монитора. | ||
| state string |
| Когда present, гарантирует, что монитор существует.Когда absent, гарантирует удаление монитора. | |
| timeout integer | Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение установленного времени, он считается доступным. Если целевой объект не отвечает в течение установленного времени, он считается недоступным. Вы можете изменить это число на любое нужное вам число, однако оно должно быть в 3 раза больше числа секунд интервала плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 120. | ||
| transparent boolean |
| Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через соответствующие члены пула или узлы (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (то есть, зондирует комбинацию ip-port, указанную в мониторе).Если монитор не может успешно достичь алиасного пункта назначения, член пула или узел, через который был отправлен трафик монитора, помечается как недоступный. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет no. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохранится на диске, обязательно включите хотя бы одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Create a GTM TCP monitor
bigip_gtm_monitor_tcp:
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 TCP Monitor
bigip_gtm_monitor_tcp:
name: my_monitor
state: absent
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Add TCP monitor for all addresses, port 514
bigip_gtm_monitor_tcp:
name: my_monitor
port: 514
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ignore_down_response boolean | changed | Игнорировать ответ о состоянии «выключено» или нет. Пример: True |
| interval integer | changed | Новый интервал для проверки монитора. Пример: 2 |
| ip string | changed | Новый IP-адрес определения IP/порта. Пример: 10.12.13.14 |
| parent string | changed | Новая родительская шаблон монитора. Пример: tcp |
| port string | changed | Новый порт, на котором монитор проверяет ресурс. Пример: 8080 |
| probe_timeout integer | changed | Новый таймаут, через который система отслеживает запрос монитора. Пример: 10 |
| receive string | changed | Новая строка приема для данного монитора. Пример: tcp строка для приема |
| reverse boolean | changed | Новое значение, определяющее работу монитора в обратном режиме. |
| send string | changed | Новая строка отправки для данного монитора. Пример: tcp строка для отправки |
| timeout integer | changed | Новый таймаут, через который удаленная система должна ответить на запрос монитора. Пример: 10 |
| transparent boolean | changed | Новое значение, определяющее работу монитора в прозрачном режиме. |
Состояние
- Гарантированно обратная совместимость данного модуля не поддерживается. [preview]
- Этот модуль поддерживается партнером Ansible. [certified]
Авторы
- 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.9/modules/bigip_gtm_monitor_tcp_module.html
