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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
description строка добавлено в 2.7			Описание монитора.
interval целое число			Интервал, определяющий частоту выполнения экземпляра монитора данной шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 5. Это значение обязательно должно быть меньше значения `timeout`.
ip строка			Часть IP-адреса в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение - IP-адрес, и `type` равно `tcp` (значение по умолчанию), то необходимо указать значение `port`.
name строка / обязательно			Имя монитора.
parent строка		По умолчанию: "/Common/tcp"	Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это родительский шаблон в разделе `Common`.
partition строка добавлено в 2.5		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
port строка			Адрес порта в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если указан IP-адрес, необходимо указать значение от 1 до 65535. Этот аргумент не поддерживается для типов TCP Echo.
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 строка			Строка приема для вызова монитора.
send строка			Строка отправки для вызова монитора.
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 сохраняется на диске, обязательно включите по крайней мере одну задачу, которая использует модуль 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 строка	изменено	Описание монитора. Пример: Важный монитор
interval целое число	изменено	Новый интервал, в котором будет выполняться проверка монитора. Пример: 2
ip строка	изменено	Новый IP-адрес для определения IP/порта. Пример: 10.12.13.14
parent строка	изменено	Новая родительская шаблон монитора. Пример: tcp
port строка	изменено	Новый порт для определения IP/порта. Пример: admin@root.local
receive строка	изменено	Новая строка приёма для этого монитора. Пример: tcp строка для приёма
send строка	изменено	Новая строка отправки для этого монитора. Пример: tcp строка для отправки
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_tcp_module.html