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

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
description string	Описание монитора.
interval integer	Интервал, определяющий частоту запуска экземпляра монитора на основе этого шаблона. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию — 5. Это значение должно быть меньше значения `timeout`.
ip псевдонимы: alias_address string	IP-адрес в определении IP/порта. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию — ‘’. Если это значение является IP-адресом, а `type` — `tcp` (значение по умолчанию), необходимо указать число `port`. В интерфейсе управления BIG IP это поле называется Alias Address*.
name string / обязательный	Имя монитора.
parent string	Родительский шаблон этого шаблона монитора. После установки это значение нельзя изменить. По умолчанию используется родительский шаблон `tcp` в разделе `Common`. По умолчанию: `"/Common/tcp"`
partition string	Раздел устройства, в котором будут управляться ресурсы. По умолчанию: `"Common"`
port псевдонимы: alias_service_port string	Порт в определении IP/порта. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию — ‘’. Если указан IP-адрес, необходимо задать значение от 1 до 65535. Этот аргумент не поддерживается для типов TCP Echo. В интерфейсе управления BIG IP это поле называется Alias Service Port*.
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	Строка Receive для вызова монитора.
receive_disable string	Строка Receive Disable для вызова монитора. Этот параметр работает так же, как `receive`, но система помечает узел или участника пула как отключённый, если его ответ соответствует строке `receive_disable`, но не `receive`. Чтобы использовать этот параметр, необходимо указать и `receive_disable`, и `receive`.
send string	Строка Send для вызова монитора.
state string	Если `present`, обеспечивает наличие монитора. Если `absent`, обеспечивает удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
time_until_up integer	Задаёт время в секундах после первого успешного ответа, по истечении которого узел будет помечен как доступный. Значение `0` приводит к тому, что узел помечается как доступный сразу после получения корректного ответа. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию `0`.
timeout integer	Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение заданного времени, он считается доступным. Если целевой объект не отвечает в течение заданного времени, он считается недоступным. Это значение можно изменить на любое желаемое, однако оно должно быть равно интервалу, умноженному на 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 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 string	Описание монитора. Возвращается: changed Пример: `"Important Monitor"`
interval integer	Новый интервал запуска проверки монитора. Возвращается: changed Пример: `2`
ip string	Новый IP-адрес в определении IP/порта. Возвращается: changed Пример: `"10.12.13.14"`
parent string	Новый родительский шаблон монитора. Возвращается: changed Пример: `"tcp"`
port string	Новый порт в определении IP/порта. Возвращается: changed Пример: `"admin@root.local"`
receive string	Новая строка Receive для этого монитора. Возвращается: changed Пример: `"tcp string to receive"`
receive_disable string	Новая строка Receive Disable для этого монитора. Возвращается: changed Пример: `"tcp string to receive"`
send string	Новая строка Send для этого монитора. Возвращается: changed Пример: `"tcp string to send"`
time_until_up integer	Новое время, по истечении которого система будет помечена как доступная после первого успешного ответа. Возвращается: changed Пример: `2`
timeout integer	Новое время ожидания ответа удалённой системы на запрос монитора. Возвращается: 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_monitor_tcp_module.html