Модуль f5networks.f5_modules.bigip_monitor_tcp_half_open — Управление мониторами F5 BIG-IP LTM TCP с открытым соединением

Примечание

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

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

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

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

Новое в f5networks.f5_modules 1.0.0

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

Обзор

Управление мониторами F5 BIG-IP LTM TCP с открытым соединением.

Параметры

Параметр	Комментарии
description строка	Описание монитора.
interval целое число	Интервал, определяющий частоту запуска экземпляра монитора этой шаблона. Если этот параметр не задан при создании нового монитора, значение по умолчанию равно 5. Это значение должно быть меньше значения `timeout`.
ip строка	Часть определения IP/порт — IP-адрес. Если этот параметр не задан при создании нового монитора, значение по умолчанию равно ‘*’. Если это значение — IP-адрес, и `type` равно `tcp` (по умолчанию), то необходимо указать число `port`.
name строка / обязательно	Имя монитора.
parent строка	Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение является родительским элементом `tcp_half_open` в разделе `Common`. Значение по умолчанию: `"/Common/tcp_half_open"`
partition строка	Раздел устройства для управления ресурсами. Значение по умолчанию: `"Common"`
port строка	Адрес порта, часть определения IP/порт. Если этот параметр не задан при создании нового монитора, значение по умолчанию равно ‘*’. Если вы указываете IP-адрес, вы должны указать значение от 1 до 65535.
provider словарь добавлен в f5networks.f5_modules 1.0.0	Объект словаря, содержащий детали подключения.
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"`

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 half-open Monitor
  bigip_monitor_tcp_half_open:
    state: present
    ip: 10.10.10.10
    name: my_tcp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

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

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

Ключ	Описание
description строка	Описание монитора. Возвращаемое значение: изменён Пример: `"Important Monitor"`
interval целое число	Новый интервал для проверки монитора. Возвращаемое значение: изменён Пример: `2`
ip строка	Новый IP-адрес определения IP/порта. Возвращаемое значение: изменён Пример: `"10.12.13.14"`
parent строка	Новая родительская шаблон монитора. Возвращаемое значение: изменён Пример: `"tcp"`
time_until_up целое число	Новое время, в течение которого система будет считаться активной после первого успешного ответа. Возвращаемое значение: изменён Пример: `2`
timeout целое число	Новый тайм-аут, в течение которого удалённая система должна ответить на запрос монитора. Возвращаемое значение: изменён Пример: `10`

Авторы

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

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

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