bigip_gtm_monitor_tcp – Управление мониторами F5 BIG-IP GTM tcp
Новая версия с 2.6.
Описание
- Управляет мониторами F5 BIG-IP GTM tcp.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ignore_down_response boolean |
| Указывает, что монитор допускает более одной попытки запроса к зонду за интервал. Когда yes, указывает, что монитор игнорирует ответы о недоступности (down) в течение времени ожидания монитора. После истечения времени ожидания монитора без получения ответа о доступности (up), система помечает объект как недоступный.Когда 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 | По умолчанию: 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 - / обязательно |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, которые используют самозаверяющие сертификаты.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| receive - | Строка приема для вызова монитора. | ||
| reverse boolean |
| Инструктирует систему помечать целевой ресурс как недоступный (down), когда тест успешен. Эта настройка полезна, например, если контент на домашней странице вашего веб-сайта динамический и часто меняется, вы можете настроить обратный ECV-чек, который ищет строку Ошибка. Совпадение с этой строкой означает, что веб-сервер был недоступен. Для использования этого параметра, необходимо указать значения для 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 boolean |
| Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через соответствующих членов пула или узлы (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (то есть зондирует комбинацию ip-port, указанную в мониторе).Если монитор не может успешно достичь алиасного пункта назначения, член пула или узел, через который был отправлен трафик монитора, помечаются как недоступные. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет no. | |
| пользователь - / обязательно | Имя пользователя для подключения к 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 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 boolean | изменено | Игнорировать ответ о недоступности или нет. Пример: True |
| interval целое число | изменено | Новый интервал для проверки монитора. Пример: 2 |
| ip строка | изменено | Новый IP-адрес определения IP/порта. Пример: 10.12.13.14 |
| parent строка | изменено | Новая родительская шаблон монитора. Пример: tcp |
| port строка | изменено | Новый порт, на котором монитор проверяет ресурс. Пример: 8080 |
| probe_timeout целое число | изменено | Новый интервал ожидания для зонда монитора. Пример: 10 |
| receive строка | изменено | Новая строка приема для этого монитора. Пример: tcp строка для приема |
| reverse boolean | изменено | Новое значение для того, работает ли монитор в обратном режиме. |
| send строка | изменено | Новая строка отправки для этого монитора. Пример: tcp строка для отправки |
| timeout целое число | изменено | Новый интервал ожидания ответа удаленного устройства для монитора. Пример: 10 |
| transparent 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_tcp_module.html
