Модуль f5networks.f5_modules.bigip_gtm_monitor_tcp — управление мониторами TCP F5 BIG-IP GTM

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_gtm_monitor_tcp.

Добавлено в f5networks.f5_modules 1.0.0

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

Краткое описание

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

Параметры

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

Примечания

Примечание

Дополнительные сведения об использовании 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	Указывает, игнорировать ли ответ о недоступности. Возвращается: changed Пример: `true`
interval integer	Новый интервал запуска проверки монитора. Возвращается: changed Пример: `2`
ip string	Новый IP-адрес в определении IP/порта. Возвращается: changed Пример: `"10.12.13.14"`
parent string	Новый родительский шаблон монитора. Возвращается: changed Пример: `"tcp"`
port string	Новый порт, на котором монитор проверяет ресурс. Возвращается: changed Пример: `"8080"`
probe_timeout integer	Новое время ожидания, по истечении которого система прекращает проверку монитора. Возвращается: changed Пример: `10`
receive string	Новая строка, ожидаемая в ответе этого монитора. Возвращается: changed Пример: `"tcp string to receive"`
reverse boolean	Новое значение, указывающее, работает ли монитор в обратном режиме. Возвращается: changed Пример: `false`
send string	Новая строка, отправляемая этим монитором. Возвращается: changed Пример: `"tcp string to send"`
timeout integer	Новое время ожидания ответа удалённой системы на запрос монитора. Возвращается: changed Пример: `10`
transparent boolean	Новое значение, указывающее, работает ли монитор в прозрачном режиме. Возвращается: changed Пример: `false`

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_gtm_monitor_tcp_module.html