bigip_monitor_tcp_echo - Управляет мониторами F5 BIG-IP LTM tcp.
Новое в версии 2.4.
- Обзор
- Требования (для хоста, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Управляет
- мониторами
- F5
- BIG-IP
- LTM
- tcp
- через
- API
- Control
- SOAP
- API.
Требования (для хоста, на котором выполняется модуль)
- f5-sdk >= 2.2.3
Параметры
| параметр | обязательно | значение по умолчанию | возможные значения | примечания |
|---|---|---|---|---|
| interval | нет | Интервал, определяющий частоту запуска экземпляра монитора этой темы. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 5. Это значение должно быть меньше значения timeout. | ||
| ip | нет | Часть IP-адреса определения IP/порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение — IP-адрес, и type равно tcp (значение по умолчанию), то необходимо указать port число. | ||
| name | да | Имя монитора. псевдонимы: monitor | ||
| parent | нет | /Common/tcp | Родительская тема этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это родительская тема tcp на разделе Common. | |
| password | да | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, если переменная среды F5_PASSWORD установлена. | ||
| server | да | Хост BIG-IP. Этот параметр можно опустить, если переменная среды F5_SERVER установлена. | ||
| server_port (добавлено в 2.2)
| нет | 443 | Порт сервера BIG-IP. Этот параметр можно опустить, если переменная среды F5_SERVER_PORT установлена. | |
| time_until_up | нет | Указывает время в секундах после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения действительного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 0. | ||
| timeout | нет | Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение установленного периода времени, он считается активным. Если целевой объект не отвечает в течение установленного периода времени, он считается неактивным. Вы можете изменить это число на любое, но оно должно быть в 3 раза больше интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 16. | ||
| user | да | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, если переменная среды F5_USER установлена. | ||
| validate_certs (добавлено в 2.0)
| нет | True |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, которые используют самозаверяющие сертификаты. Этот параметр можно опустить, если переменная среды F5_VALIDATE_CERTS установлена. |
Примеры
- name: Create TCP Echo Monitor
bigip_monitor_tcp_echo:
state: "present"
server: "lb.mydomain.com"
user: "admin"
ip: 10.10.10.10
password: "secret"
name: "my_tcp_monitor"
delegate_to: localhost
- name: Remove TCP Echo Monitor
bigip_monitor_tcp_echo:
state: "absent"
server: "lb.mydomain.com"
user: "admin"
password: "secret"
name: "my_tcp_monitor"
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие являются полями, уникальными для этого модуля:
| название | описание | возвращается | тип | пример |
|---|---|---|---|---|
| interval | Новый интервал для выполнения проверки монитора. | изменено | int | 2 |
| ip | Новый IP-адрес определения IP/порта. | изменено | строка | 10.12.13.14 |
| parent | Новый родительский шаблон монитора. | изменено | строка | tcp |
| time_until_up | Новое время, в течение которого система будет помечена как активная после первого успешного ответа. | изменено | int | 2 |
| timeout | Новый таймаут, в течение которого удаленная система должна ответить на мониторинг. | изменено | int | 10 |
Примечания
Примечание
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.
- Требуется версия программного обеспечения BIG-IP >= 12
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется как обратный.
Для получения помощи в разработке модулей, если у вас есть желание, ознакомьтесь с Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/bigip_monitor_tcp_echo_module.html