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" | Разбиение устройства для управления ресурсами. | |
| provider словарь добавлено в 2.5 | Объект словаря, содержащий детали подключения. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр реально используется при работе с устройствами BIG-IQ. | ||
| 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 целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное подключение для использования при подключении к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs булево |
| Если no, сертификаты SSL не проверяются. Используйте это только на сайтах, контролируемых вами, которые используют самозаверенные сертификаты.Можно опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| state строка добавлено в 2.5 |
| Если present, гарантирует, что монитор существует.Если absent, гарантирует удаление монитора. | |
| time_until_up целое число | Указывает количество секунд после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 приведет к тому, что узел будет сразу помечен как активный после получения действительного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 0. | ||
| timeout целое число | Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в установленный период времени, он считается активным. Если целевой объект не отвечает в установленный период времени, он считается неактивным. Вы можете изменить это число на любое, однако оно должно быть в 3 раза больше значения интервала в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 16. | ||
Примечания
Примечание
- Требуется версия программного обеспечения 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.9/modules/bigip_monitor_tcp_echo_module.html
