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

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в плейбуке укажите: 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 строка	Варианты: rest ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	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	При значении `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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_monitor_udp_module.html