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

Примечание

Этот модуль входит в коллекцию 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_bigip.

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

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

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

Управляет мониторами F5 BIG-IP GTM (теперь BIG-IP DNS) BIG-IP. Этот монитор используется GTM для проверки самих устройств BIG-IP.

Параметры

Параметр	Комментарии
aggregate_dynamic_ratios строка	Задает способ объединения системой значений модуля для формирования пропорции (оценки) при балансировке нагрузки. Оценка отражает предполагаемую пропускную способность модуля при обработке трафика. Усредненные значения подходят для последующих виртуальных серверов Web Accelerator или Application Security Manager (ASM). При создании монитора, если этот параметр не указан, используется значение по умолчанию `none`, означающее, что система не использует оценки при балансировке нагрузки. Если задано `none`, монитор игнорирует оценки узлов и участников пула. Если задано `average-nodes`, система усредняет динамические коэффициенты узлов, связанных с целевыми виртуальными серверами монитора, и возвращает это среднее значение в качестве оценки виртуальных серверов. Если задано `sum-nodes`, система суммирует оценки узлов, связанных с целевыми виртуальными серверами монитора, и использует эту сумму при балансировке нагрузки. Если задано `average-members`, система усредняет динамические коэффициенты участников пулов, связанных с целевыми виртуальными серверами монитора, и возвращает это среднее значение в качестве оценки виртуальных серверов. Если задано `sum-members`, система суммирует оценки участников пулов, связанных с целевыми виртуальными серверами монитора, и использует эту сумму при балансировке нагрузки. Варианты: `"none"` `"average-nodes"` `"sum-nodes"` `"average-members"` `"sum-members"`
ignore_down_response логическое значение	Указывает, что монитор может выполнять более одной попытки проверки за интервал. Если задано `true`, монитор игнорирует ответы о недоступности в течение времени ожидания монитора. Если по истечении времени ожидания система не получит ответ о доступности, она помечает объект как недоступный. Если задано `false`, монитор немедленно помечает объект как недоступный при получении соответствующего ответа. При создании монитора, если этот параметр не указан, используется значение по умолчанию `false`. Варианты: `false` `true`
interval целое число	Задает в секундах частоту выполнения системой проверки монитора, когда ресурс недоступен или его состояние неизвестно. При создании монитора, если этот параметр не указан, используется значение по умолчанию `30`. Это значение должно быть меньше значения `timeout`.
ip строка	Часть определения IP/порта, содержащая IP-адрес. Если при создании монитора этот параметр не указан, используется значение по умолчанию «*».
name строка / обязательный	Имя монитора.
parent строка	Родительский шаблон этого шаблона монитора. После задания это значение нельзя изменить. По умолчанию используется родительский шаблон `bigip` в разделе `Common`. По умолчанию: `"/Common/bigip"`
partition строка	Раздел устройства, в котором будут управляться ресурсы. По умолчанию: `"Common"`
port строка	Часть определения IP/порта, содержащая номер порта. Если при создании монитора этот параметр не указан, используется значение по умолчанию «*». Обратите внимание: при указании IP-адреса необходимо использовать значение от 1 до 65535.
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 (ноль), система использует интервал родительского монитора. При создании монитора, если этот параметр не указан, используется значение по умолчанию `90`.

Примечания

Примечание

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

- name: Remove BIG-IP Monitor
  bigip_gtm_monitor_bigip:
    state: absent
    name: my_monitor
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

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

Ключ	Описание
aggregate_dynamic_ratios строка	Новое агрегированное значение для монитора. Возвращается: при изменении Пример: `"sum-members"`
ignore_down_response логическое значение	Указывает, следует ли игнорировать ответ о недоступности. Возвращается: при изменении Пример: `true`
interval целое число	Новый интервал выполнения проверки монитора. Возвращается: при изменении Пример: `2`
ip строка	Новый IP-адрес в определении IP/порта. Возвращается: при изменении Пример: `"10.12.13.14"`
parent строка	Новый родительский шаблон монитора. Возвращается: при изменении Пример: `"bigip"`
timeout целое число	Новое время ожидания ответа удаленной системы на запрос монитора. Возвращается: при изменении Пример: `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_bigip_module.html