bigip_monitor_tcp_echo – Управляет мониторами F5 BIG-IP LTM tcp echo
Новая версия 2.4.
Описание
- Управляет мониторами F5 BIG-IP LTM tcp echo.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description строка добавлено в 2.7 | Описание монитора. | ||
| interval целое число | Интервал, определяющий частоту запуска экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 5. Это значение должно быть меньше timeout значения. | ||
| ip строка | Часть IP-адреса определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. | ||
| name строка / обязательно | Имя монитора. | ||
| parent строка | По умолчанию: "/Common/tcp_echo" | Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение — tcp_echo родительский элемент на Common раздела. | |
| partition строка добавлено в 2.5 | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| password строка / обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| provider словарь добавлено в 2.5 | Объект 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 булево |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов.Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS. | |
| server строка / обязательно | Хост BIG-IP. Этот параметр можно опустить, установив переменную среды F5_SERVER. | ||
| server_port целое число добавлено в 2.2 | По умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную среды F5_SERVER_PORT. | |
| state строка добавлено в 2.5 |
| Когда present, гарантирует, что монитор существует.Когда absent, гарантирует удаление монитора. | |
| time_until_up целое число | Указывает количество секунд после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 приведет к тому, что узел будет помечен как активный сразу после получения действительного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 0. | ||
| timeout целое число | Количество секунд, в течение которого узел или служба должны отвечать на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается активным. Если целевой объект не отвечает в установленный период времени, он считается неактивным. Вы можете изменить это число на любое нужное вам число, однако оно должно быть в 3 раза больше числа интервалов в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 16. | ||
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды F5_USER. | ||
| validate_certs булево добавлено в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов.Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Требуется версия ПО BIG-IP >= 12
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 обрабатывают только текущую конфигурацию продукта F5. Чтобы гарантировать, что специфичная для BIG-IP конфигурация сохранится на диске, обязательно включите хотя бы одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Create TCP Echo Monitor
bigip_monitor_tcp_echo:
state: present
ip: 10.10.10.10
name: my_tcp_monitor
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove TCP Echo Monitor
bigip_monitor_tcp_echo:
state: absent
name: my_tcp_monitor
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Значения возврата
Общие значения возвращаемых данных описаны здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| description строка | изменено | Описание монитора. Пример: Важный монитор |
| interval целое число | изменено | Новый интервал, в котором будет выполняться проверка монитора. Пример: 2 |
| ip строка | изменено | Новый IP-адрес определения IP/порта. Пример: 10.12.13.14 |
| parent строка | изменено | Новый родительский шаблон монитора. Пример: tcp |
| time_until_up целое число | изменено | Новое время, в течение которого система будет считаться активной после первого успешного ответа. Пример: 2 |
| timeout целое число | изменено | Новый таймаут, в течение которого удаленная система должна ответить на монитор. Пример: 10 |
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается партнером Ansible. [сертифицировано]
Авторы
- 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.8/modules/bigip_monitor_tcp_echo_module.html
