Модуль f5networks.f5_modules.bigip_monitor_udp — управление UDP-мониторами 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_udp.

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

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

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

Управление UDP-мониторами F5 BIG-IP LTM.

Параметры

Параметр	Комментарии
description string	Описание монитора.
interval integer	Интервал, определяющий частоту запуска экземпляра монитора на основе этого шаблона. Если при создании нового монитора этот параметр не задан, используется значение по умолчанию 5. Это значение должно быть меньше значения `timeout`.
ip string	Часть определения IP/порта, содержащая IP-адрес. Если при создании нового монитора этот параметр не задан, используется значение по умолчанию ‘*’.
name string / обязательный	Имя монитора.
parent string	Родительский шаблон этого шаблона монитора. После задания этого значения его нельзя изменить. По умолчанию используется родительский шаблон `udp` в разделе `Common`. По умолчанию: `"/Common/udp"`
partition string	Раздел устройства, в котором выполняется управление ресурсами. По умолчанию: `"Common"`
port string	Часть определения IP/порта, содержащая номер порта. Если при создании нового монитора этот параметр не задан, используется значение по умолчанию ‘*’. При указании IP-адреса необходимо задать значение от 1 до 65535.
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения для подключения.
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`, но система помечает узел или участника пула как отключённый, если его ответ соответствует строке `receive_disable`, но не `receive`. Чтобы использовать этот параметр, необходимо указать и `receive_disable`, и `receive`.
send string	Строка Send для вызова монитора. При создании нового монитора, если это значение не задано, используется значение по умолчанию `default send string`.
state string	Если задано значение `present`, гарантирует наличие монитора. Если задано значение `absent`, гарантирует удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
time_until_up integer	Задаёт время в секундах после первого успешного ответа, по истечении которого узел будет помечен как доступный. Значение `0` приводит к немедленной пометке узла как доступного после получения корректного ответа от него. Если при создании нового монитора этот параметр не задан, используется значение по умолчанию `0`.
timeout integer	Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в заданный период времени, он считается доступным. Если целевой объект не отвечает в заданный период времени, он считается недоступным. Можно задать любое значение, однако оно должно быть равно трём интервалам в секундах плюс 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 UDP Monitor
  bigip_monitor_udp:
    state: present
    ip: 10.10.10.10
    name: my_udp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove UDP Monitor
  bigip_monitor_udp:
    state: absent
    name: my_udp_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 Пример: `"http"`
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_udp_module.html