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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: f5networks.f5_modules.bigip_monitor_tcp_echo.

Новое в версии 1.0.0: из f5networks.f5_modules

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
description строка			Описание монитора.
interval целое число			Интервал, определяющий частоту выполнения монитора данного шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию — 5. Это значение должно быть меньше значения `timeout`.
ip строка			IP-адрес, часть определения IP/порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию — '*'.
name строка / обязательно			Имя монитора.
parent строка		По умолчанию: "/Common/tcp_echo"	Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение — родительский шаблон `tcp_echo` на разделяемой `Common` папке.
partition строка		По умолчанию: "Common"	Разделяемая папка устройства для управления ресурсами.
provider словарь добавлен в 1.0.0 f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации с удалённого устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem булево	Варианты: no yes	Если `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 yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Вы можете опустить этот параметр, задав переменную среды `F5_VALIDATE_CERTS`.
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 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 строка	changed	Описание монитора. Пример: Важный монитор
interval целое число	changed	Новый интервал выполнения проверки монитора. Пример: 2
ip строка	changed	Новый IP адрес для определения IP/порта. Пример: 10.12.13.14
parent строка	changed	Новый родительский шаблон монитора. Пример: tcp
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_tcp_echo_module.html