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

Примечание

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

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

Для использования в playbook, укажите: f5networks.f5_modules.bigip_monitor_tcp

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

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

Описание

Управляет мониторами F5 BIG-IP LTM TCP через iControl REST API.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
description строка			Описание монитора.
interval целое число			Интервал, определяющий частоту выполнения экземпляра монитора этой шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию равно 5. Это значение должно быть меньше значения `timeout`
ip строка			Часть IP-адреса определения IP/порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию — ''. Если это значение — IP-адрес, и `type` равно `tcp` (значение по умолчанию), то необходимо указать `port` число. В пользовательском интерфейсе BIG IP Management это поле — Alias Address*. псевдонимы: alias_address
name строка / обязательно			Имя монитора.
parent строка		По умолчанию: "/Common/tcp"	Родительский шаблон этого шаблона монитора. После установки этого значения его изменить нельзя. По умолчанию это значение — родительский `tcp` на `Common` разделе.
partition строка		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
port строка			Адрес порта, часть определения IP/порта. Если этот параметр не указан при создании нового монитора, значение по умолчанию — ''. Если вы указываете IP-адрес, вы должны указать значение от 1 до 65535. Этот аргумент не поддерживается для типов TCP Echo. В пользовательском интерфейсе BIG IP Management это поле — Alias Service Port*. псевдонимы: alias_service_port
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`
receive строка			Строка "Принять" для вызова монитора.
receive_disable строка			Строка "Отключить прием" для вызова монитора. Это свойство работает как `receive`, за исключением того, что система помечает узел или участника пула как отключенный, когда его ответ соответствует строке `receive_disable`, но не строке `receive`. Для использования этого параметра необходимо указать оба `receive_disable` и `receive`
send строка			Строка "Отправить" для вызова монитора.
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 Monitor
  bigip_monitor_tcp:
    state: present
    name: my_tcp_monitor
    send: tcp string to send
    receive: tcp string to receive
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove TCP Monitor
  bigip_monitor_tcp:
    state: absent
    name: my_tcp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для этого модуля:

Ключ	Возвращаемое	Описание
description string	изменён	Описание монитора. Пример: Важный монитор
interval integer	изменён	Новый интервал, с которым нужно выполнять проверку монитора. Пример: 2
ip string	изменён	Новый IP-адрес определения IP/порта. Пример: 10.12.13.14
parent string	изменён	Новая родительская шаблон монитора. Пример: tcp
port string	изменён	Новый порт определения IP/порта. Пример: admin@root.local
receive string	изменён	Новая строка Приёма для этого монитора. Пример: tcp строка для приёма
receive_disable string	изменён	Новая строка Отключить приём для этого монитора. Пример: tcp строка для приёма
send string	изменён	Новая строка Отправки для этого монитора. Пример: tcp строка для отправки
time_until_up integer	изменён	Новое время, в течение которого система будет считаться активной после первого успешного ответа. Пример: 2
timeout integer	изменён	Новый таймаут, в течение которого удалённая система должна ответить на мониторинг. Пример: 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_tcp_module.html