Модуль f5networks.f5_modules.bigip_gtm_monitor_tcp_half_open — управление 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_half_open.

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

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

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

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

Параметры

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

Примечания

Примечание

Требуется 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 half-open Monitor
  bigip_gtm_monitor_tcp_half_open:
    state: present
    ip: 10.10.10.10
    name: my_monitor
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

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

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

Ключ	Описание
interval целое число	Новый интервал выполнения проверки монитором. Возвращается: changed Пример: `2`
ip строка	Новый IP-адрес в определении IP/порта. Возвращается: changed Пример: `"10.12.13.14"`
parent строка	Новый родительский шаблон монитора. Возвращается: changed Пример: `"tcp_half_open"`
probe_attempts целое число	Новое количество попыток проверки монитора, выполняемых системой. Возвращается: changed Пример: `10`
probe_interval целое число	Новый интервал выполнения системой проверки монитора. Возвращается: changed Пример: `10`
probe_timeout целое число	Новое время ожидания ответа на проверку монитора, установленное системой. Возвращается: changed Пример: `10`
timeout целое число	Новое время ожидания ответа удаленной системы на запрос монитора. Возвращается: changed Пример: `10`

Авторы

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