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

Примечание

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

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

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

Новое в версии 1.0.0: модуля f5networks.f5_modules

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

Обзор

Управляет мониторами TCP F5 BIG-IP LTM через 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	изменённое	Новая строка Receive для данного монитора. Пример: tcp строка для приёма
receive_disable string	изменённое	Новая строка Receive Disable для данного монитора. Пример: tcp строка для приёма
send string	изменённое	Новая строка Send для данного монитора. Пример: tcp строка для отправки
time_until_up integer	изменённое	Новое время, в течение которого система будет отмечена как активная после первого успешного ответа. Пример: 2
timeout integer	изменённое	Новый таймаут, в течение которого удалённая система должна ответить на запрос монитора. Пример: 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_module.html