f5networks.f5_modules.bigip_monitor_http модуль — Управляет мониторами HTTP F5 BIG-IP LTM

Примечание

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
description строка	Описание монитора.
interval целое число	Интервал, определяющий частоту выполнения экземпляра монитора этой шаблона. Если этот параметр не задан при создании нового монитора, значение по умолчанию составляет 5. Это значение должно быть меньше значения `timeout`.
ip строка	Часть IP-адреса в определении IP/порт. Если этот параметр не задан при создании нового монитора, значение по умолчанию равно ‘*’.
name строка / обязательно	Имя монитора.
parent строка	Родительский шаблон этого шаблона монитора. После установки этого значения его нельзя изменить. По умолчанию это значение — `http` родительский шаблон в `Common` разделе. По умолчанию: `"/Common/http"`
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` ← (по умолчанию)
receive строка	Строка приема для вызова монитора.
receive_disable строка	Эта настройка работает как `receive`, за исключением того, что система помечает узел или члена пула как отключенный, когда его ответ соответствует строке `receive_disable`, но не строке `receive`. Чтобы использовать эту настройку, необходимо указать как `receive_disable`, так и `receive`.

reverse boolean	Указывает, работает ли монитор в обратном режиме. Когда монитор работает в обратном режиме, совпадение успешного полученного значения строки отмечает контролируемый объект как неактивный, а не активный. Этот режим можно использовать только при настройке параметра `receive`. Этот параметр несовместим с параметром `time_until_up`. Если параметр `time_until_up` указан, он должен быть `0`. Или, если он уже существует, он должен быть `0`. Варианты: `false` `true`
send string	Строка отправки для вызова монитора. При создании нового монитора, если это значение не указано, используется значение по умолчанию `GET /\r\n`.
state string	При значении `present`, гарантирует существование монитора. При значении `absent`, гарантирует удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
target_password string	Указывает пароль, если контролируемый целевой ресурс требует аутентификации.
target_username string	Указывает имя пользователя, если контролируемый целевой ресурс требует аутентификации.
time_until_up integer	Указывает количество секунд после первого успешного ответа, прежде чем узел будет помечен как активный. Значение 0 приводит к тому, что узел помечается как активный сразу после получения действительного ответа от узла. Если этот параметр не указан при создании нового монитора, значение по умолчанию равно 0.
timeout integer	Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой ресурс отвечает в течение заданного периода времени, он считается активным. Если целевой ресурс не отвечает в течение заданного периода времени, он считается неактивным. Это значение можно изменить на любое число, однако оно должно быть в 3 раза больше числа интервалов в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, значение по умолчанию равно 16.
up_interval integer добавлен в f5networks.f5_modules 1.22.0	Указывает интервал, который система использует для проверки состояния ресурса, когда ресурс активен. При значении `0`, система использует интервал, указанный в `interval`, для проверки состояния ресурса. При любом другом числе вы можете указать другой интервал для проверки состояния активного ресурса.

Примечания

Примечание

Требуется версия программного обеспечения BIG-IP >= 12
Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только рабочую конфигурацию продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохранится на диске, убедитесь, что включен хотя бы один task, использующий модуль f5networks.f5_modules.bigip_config для сохранения рабочей конфигурации. Обратитесь к документации модуля за правильным использованием модуля для сохранения рабочей конфигурации.

Примеры

- name: Create HTTP Monitor
  bigip_monitor_http:
    state: present
    ip: 10.10.10.10
    name: my_http_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove HTTP Monitor
  bigip_monitor_http:
    state: absent
    name: my_http_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Include a username and password in the HTTP monitor
  bigip_monitor_http:
    state: absent
    name: my_http_monitor
    target_username: monitor_user
    target_password: monitor_pass
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

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

Авторы

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