bigip_monitor_udp – Управляет мониторами UDP F5 BIG-IP LTM

Новая версия 2.5.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Управляет мониторами UDP F5 BIG-IP LTM.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
description строка добавлен в 2.7			Описание монитора.
interval целое число			Интервал, определяющий частоту выполнения экземпляра монитора данной шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 5. Это значение должно быть меньше значения `timeout`.
ip строка			IP-адрес, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'.
name строка / обязательно			Имя монитора.
parent строка		Значение по умолчанию: "/Common/udp"	Родительский шаблон данного шаблона монитора. После установки этого значения его изменить нельзя. По умолчанию это значение является родительским `udp` на `Common` раздела.
partition строка добавлен в 2.5		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
port строка			Адрес порта, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если указывается IP-адрес, должно быть указано значение от 1 до 65535.
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 строка	Варианты: cli rest ←	Настраивает транспортное подключение для использования при подключении к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, установив переменную окружения `F5_USER`.
	validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Можно опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
receive строка			Строка приема для вызова монитора.
receive_disable строка			Эта настройка работает как `receive`, за исключением того, что система помечает узел или члена пула как отключенный, когда его ответ соответствует строке `receive_disable`, но не `receive`. Для использования этой настройки необходимо указать как `receive_disable`, так и `receive`.
send строка			Строка отправки для вызова монитора. При создании нового монитора, если это значение не указано, будет использовано значение по умолчанию `default send string`.
state строка добавлен в 2.5		Варианты: present ← absent	Когда `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 на диске убедитесь, что включен хотя бы один task, использующий модуль 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 строка	изменено	Описание монитора. Пример: Важный монитор
interval целое число	изменено	Новый интервал для выполнения проверки монитора. Пример: 2
ip строка	изменено	Новый IP-адрес определения IP/порта. Пример: 10.12.13.14
parent строка	изменено	Новая родительская шаблон монитора. Пример: http
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_udp_module.html