bigip_gtm_monitor_tcp - Управляет мониторами F5 BIG-IP GTM tcp
Новая версия 2.6.
Обзор
- Управляет мониторами F5 BIG-IP GTM tcp.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ignore_down_response bool |
| Указывает, что монитор допускает более одной попытки зондирования в интервал. Когда yes, указывает, что монитор игнорирует ответы о недоступности в течение времени ожидания монитора. После истечения времени ожидания монитора без получения ответа о доступности система помечает объект как недоступный.Когда no, указывает, что монитор сразу помечает объект как недоступный при получении ответа о недоступности.При создании нового монитора, если этот параметр не указан, то значение по умолчанию будет no. | |
| interval | Интервал, указывающий, как часто будет выполняться экземпляр монитора этого шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 30. Это значение должно быть меньше значения timeout. | ||
| ip | IP-адрес, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение - IP-адрес, то должно быть указано значение port. | ||
| name обязательно | Имя монитора. | ||
| parent | Значение по умолчанию: "/Common/tcp" | Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение является родительским tcp на Common разделе. | |
| partition | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| port | Порт, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если указан IP-адрес, должно быть указано значение от 1 до 65535. | ||
| probe_timeout | Указывает количество секунд, после которых система отключает запрос зондирования к системе. При создании нового монитора, если этот параметр не указан, то значение по умолчанию будет 5. | ||
| provider (добавлен в 2.5) | Объект словаря, содержащий данные подключения. | ||
| 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-сервиса, которая ищет строку Error. Совпадение со строкой означает, что веб-сервер был недоступен. Для использования этого параметра необходимо указать значения для send и receive. | |
| send | Строка отправки для вызова монитора. | ||
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER установлена. | ||
| server_port (добавлен в 2.2) | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена. | |
| state |
| Когда present, гарантирует, что монитор существует.Когда absent, гарантирует удаление монитора. | |
| timeout | Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный временной период, он считается доступным. Если целевой объект не отвечает в установленный временной период, он считается недоступным. Вы можете изменить это число на любое необходимое значение, однако оно должно быть в 3 раза больше числа секунд интервала плюс 1 секунда. Если этот параметр не указан при создании нового монитора, то значение по умолчанию будет 120. | ||
| transparent bool |
| Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через соответствующих членов пула или узлов (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (то есть он зондирует ip-port комбинацию, указанную в мониторе).Если монитор не может успешно достичь алиасного пункта назначения, член пула или узел, через который отправлялся трафик монитора, помечается как недоступный. При создании нового монитора, если этот параметр не указан, то значение по умолчанию будет no. | |
| 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 TCP monitor
bigip_gtm_monitor_tcp:
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 TCP Monitor
bigip_gtm_monitor_tcp:
name: my_monitor
state: absent
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add TCP monitor for all addresses, port 514
bigip_gtm_monitor_tcp:
name: my_monitor
server: lb.mydomain.com
user: admin
port: 514
password: secret
delegate_to: localhost
Значения возврата
Общие значения возврата документированы здесь, а следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ignore_down_response bool | changed | Игнорировать ответ о недоступности или нет. Пример: True |
| interval int | changed | Новый интервал, в котором выполняется проверка монитора. Пример: 2 |
| ip string | changed | Новый IP-адрес для определения IP/порта. Пример: 10.12.13.14 |
| parent string | changed | Новая родительская шаблон монитора. Пример: tcp |
| port string | changed | Новый порт, на котором монитор проверяет ресурс. Пример: 8080 |
| probe_timeout int | changed | Новый таймаут, в течение которого система ожидает ответа от зонда монитора. Пример: 10 |
| receive string | changed | Новая строка приема для этого монитора. Пример: tcp строка для приема |
| reverse bool | changed | Новое значение для того, работает ли монитор в обратном режиме. |
| send string | changed | Новая отправляемая строка для этого монитора. Пример: tcp строка для отправки |
| timeout int | changed | Новый таймаут, в течение которого удаленная система должна ответить монитору. Пример: 10 |
| transparent bool | changed | Новое значение для того, работает ли монитор в прозрачном режиме. |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом 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_tcp_module.html
