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

Примечание

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

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

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_gtm_monitor_tcp.

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

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

Описание

Управляет мониторами TCP (сейчас BIG-IP DNS) F5 BIG-IP GTM.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ignore_down_response boolean		Варианты: no yes	Указывает, что монитор допускает более одной попытки опроса за интервал. Когда `yes`, указывает, что монитор игнорирует ответы о недоступности в течение времени ожидания монитора. После того, как время ожидания монитора истечет без получения ответа об активном состоянии, система отмечает объект как недоступный. Когда `no`, указывает, что монитор сразу отмечает объект как недоступный при получении ответа о недоступности. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `no`.
interval integer			Интервал, определяющий частоту выполнения экземпляра монитора данного шаблона. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 30. Это значение должно быть меньше значения `timeout`.
ip string			IP-адрес, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Если это значение IP-адрес, необходимо указать значение типа `port`.
name string / required			Имя монитора.
parent string		Значение по умолчанию: "/Common/tcp"	Родительский шаблон этого шаблона монитора. После установки этого значения его изменить нельзя. По умолчанию это родительский `tcp` на `Common` разделе.
partition string		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
port string			Порт, часть определения IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет '*'. Обратите внимание, что если используется IP-адрес, вы должны указать значение от 1 до 65535.
probe_timeout integer			Указывает количество секунд, по истечении которых система приостанавливает запрос на опрос устройства. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `5`.
provider dictionary добавлен в 1.0.0 f5networks.f5_modules			Объект словаря, содержащий детали подключения.
	auth_provider string		Настраивает поставщика авторизации для получения маркеров авторизации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem boolean	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TEEM`.
	password string / required		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server string / required		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port integer	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	timeout integer		Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истекает до завершения операции, модуль возвращает ошибку.
	transport string	Варианты: rest ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	user string / required		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
receive string			Строка приема для вызова монитора.
reverse boolean		Варианты: no yes	Инструктирует систему отмечать целевой ресурс как недоступный, когда тест успешен. Эта настройка полезна, например, если контент на домашней странице вашего веб-сайта динамичен и часто меняется, вы можете настроить обратный ECV-проверка сервиса, которая ищет строку Error. Совпадение с этой строкой означает, что веб-сервер был недоступен. Для использования этого параметра необходимо указать значения для `send` и `receive`.
send string			Строка отправки для вызова монитора.
state string		Варианты: present ← absent	Когда `present`, гарантирует существование монитора. Когда `absent`, гарантирует удаление монитора.
timeout integer			Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение установленного периода времени, он считается доступным. Если целевой объект не отвечает в течение установленного периода времени, он считается недоступным. Вы можете изменить это число на любое, но оно должно быть в 3 раза больше числа интервалов секунд плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию будет 120.
transparent boolean		Варианты: no yes	Указывает, работает ли монитор в режиме прозрачности. Монитор в режиме прозрачности перенаправляет трафик через связанные члены пула или узлы (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (то есть, он опрашивает комбинацию `ip`-`port`, указанную в мониторе). Если монитор не может успешно достичь алиасного пункта назначения, член пула или узел, через который был отправлен трафик монитора, помечается как недоступный. При создании нового монитора, если этот параметр не указан, значение по умолчанию будет `no`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 изменяют только рабочую конфигурацию продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохранится на диске, убедитесь, что включен хотя бы один этап, использующий модуль f5networks.f5_modules.bigip_config для сохранения рабочей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения вашей рабочей конфигурации.

Примеры

- name: Create a GTM TCP monitor
  bigip_gtm_monitor_tcp:
    name: my_monitor
    ip: 1.1.1.1
    port: 80
    send: my send string
    receive: my receive string
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

- name: Add TCP monitor for all addresses, port 514
  bigip_gtm_monitor_tcp:
    name: my_monitor
    port: 514
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

Значения возврата

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

Ключ	Возвращённое значение	Описание
ignore_down_response boolean	изменённое	Игнорировать ли ответ о недоступности. Пример: True
interval integer	изменённое	Новый интервал для проверки монитора. Пример: 2
ip string	изменённое	Новый IP-адрес определения IP/порта. Пример: 10.12.13.14
parent string	изменённое	Новая родительская шаблон монитора. Пример: tcp
port string	изменённое	Новый порт, на котором монитор проверяет ресурс. Пример: 8080
probe_timeout integer	изменённое	Новый интервал ожидания для проверки монитора. Пример: 10
receive string	изменённое	Новая строка приёма для этого монитора. Пример: tcp строка для приёма
reverse boolean	изменённое	Новое значение для режима работы монитора в обратном направлении.
send string	изменённое	Новая строка отправки для этого монитора. Пример: tcp строка для отправки
timeout integer	изменённое	Новый интервал ожидания ответа удалённой системы монитору. Пример: 10
transparent boolean	изменённое	Новое значение для режима работы монитора в прозрачном режиме.

Авторы

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_gtm_monitor_tcp_module.html