f5networks.f5_modules.bigip_monitor_udp — Управляет мониторами UDP F5 BIG-IP LTM
Примечание
Этот плагин является частью коллекции f5networks.f5_modules (версия 1.7.1).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules
Для использования в playbook, укажите: f5networks.f5_modules.bigip_monitor_udp
Новое в версии 1.0.0: из f5networks.f5_modules
Описание
- Управляет мониторами UDP F5 BIG-IP LTM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description строка |
Описание монитора. |
||
| interval целое число |
Интервал, определяющий частоту выполнения экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию равно 5. Это значение должно быть меньше значения timeout. |
||
| ip строка |
Часть IP-адреса определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — «*». |
||
| name строка / обязательно |
Имя монитора. |
||
| parent строка |
Значение по умолчанию: "/Common/udp" |
Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение — родительский шаблон udp, на разметке Common. |
|
| partition строка |
Значение по умолчанию: "Common" |
Раздел устройства для управления ресурсами. |
|
| port строка |
Адрес порта части определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — «*». Если указан IP-адрес, необходимо указать значение от 1 до 65535. |
||
| provider словарь добавлено в 1.0.0 f5networks.f5_modules |
Объект словаря, содержащий сведения о подключении. |
||
| auth_provider строка |
Настраивает поставщика авторизации для получения маркеров аутентификации от удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. |
||
| no_f5_teem булево |
|
Если yes, данные телеметрии TEEM не отправляются в F5.Можно пропустить этот параметр, задав переменную среды F5_TEEM. |
|
| password строка / обязательно |
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Можно пропустить этот параметр, задав переменную среды F5_PASSWORD.псевдонимы: pass, pwd |
||
| server строка / обязательно |
Хост BIG-IP. Можно пропустить этот параметр, задав переменную среды F5_SERVER. |
||
| server_port целое число |
Значение по умолчанию: 443 |
Порт сервера BIG-IP. Можно пропустить этот параметр, задав переменную среды F5_SERVER_PORT. |
|
| timeout целое число |
Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут превышен до завершения операции, модуль выдаст ошибку. |
||
| transport строка |
|
Настраивает транспортное подключение для использования при подключении к удаленному устройству. |
|
| user строка / обязательно |
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Можно пропустить этот параметр, задав переменную среды F5_USER. |
||
| validate_certs булево |
|
Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах, использующих самоподписанные сертификаты.Можно пропустить этот параметр, задав переменную среды F5_VALIDATE_CERTS. |
|
| receive строка |
Строка «Получить» для вызова монитора. |
||
| receive_disable строка |
Эта настройка работает как receive, за исключением того, что система помечает узел или члена пула как отключенный, когда его ответ соответствует строке receive_disable, но не строке receive. Для использования этой настройки необходимо указать как receive_disable, так и receive. |
||
| send строка |
Строка «Отправить» для вызова монитора. При создании нового монитора, если это значение не указано, используется значение по умолчанию default send string. |
||
| state строка |
|
Когда 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 конфигурация сохранится на диске, включите хотя бы одну задачу, которая использует модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Create UDP Monitor
bigip_monitor_udp:
state: present
ip: 10.10.10.10
name: my_udp_monitor
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Remove UDP Monitor
bigip_monitor_udp:
state: absent
name: my_udp_monitor
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| description строка |
changed | Описание монитора. Пример: Важный монитор |
| interval целое число |
changed | Новый интервал для запуска проверки монитора. Пример: 2 |
| ip строка |
changed | Новый IP определения IP/порт. Пример: 10.12.13.14 |
| parent строка |
changed | Новый родительский шаблон монитора. Пример: http |
| time_until_up целое число |
changed | Новое время для того, чтобы система помечалась как активная после первого успешного ответа. Пример: 2 |
| timeout целое число |
changed | Новый тайм-аут, в течение которого удаленная система должна ответить на монитор. Пример: 10 |
Авторы
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_monitor_udp_module.html