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

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

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

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

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

Параметры

Параметр	Комментарии
description string	Описание монитора.
interval integer	Интервал, определяющий частоту запуска экземпляра монитора на основе этого шаблона. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию 5. Это значение должно быть меньше значения `timeout`.
ip string	IP-адрес в определении IP/порта. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию ‘*’.
name string / обязательный	Имя монитора.
parent string	Родительский шаблон этого шаблона монитора. После установки это значение нельзя изменить. По умолчанию используется родительский шаблон `http` в разделе `Common`. По умолчанию: `"/Common/http"`
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`.
reverse boolean	Определяет, работает ли монитор в обратном режиме. В обратном режиме совпадение со строкой Receive означает, что проверяемый объект помечается как недоступный, а не как доступный. Этот режим можно использовать, только если настроен параметр `receive`. Этот параметр несовместим с параметром `time_until_up`. Если указан `time_until_up`, он должен быть `0`. Если он уже существует, его значение должно быть `0`. Варианты: `false` `true`
send string	Строка Send для вызова монитора. При создании нового монитора, если это значение не указано, используется значение по умолчанию `GET /\r\n`.
state string	Если указано `present`, обеспечивает наличие монитора. Если указано `absent`, обеспечивает удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
target_password string	Задаёт пароль, если для проверяемого целевого объекта требуется аутентификация.
target_username string	Задаёт имя пользователя, если для проверяемого целевого объекта требуется аутентификация.
time_until_up integer	Задаёт время в секундах после первого успешного ответа, по истечении которого узел помечается как доступный. Значение 0 означает, что узел помечается как доступный сразу после получения корректного ответа. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию 0.
timeout integer	Количество секунд, в течение которых узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в заданный период, он считается доступным. Если целевой объект не отвечает в заданный период, он считается недоступным. Можно задать любое значение, однако оно должно равняться трём интервалам в секундах плюс 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 на диск, добавьте как минимум одну задачу, использующую модуль 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 string	Описание монитора. Возвращается: если были изменения Пример: `"Important_Monitor"`
interval integer	Новый интервал запуска проверки монитора. Возвращается: если были изменения Пример: `2`
ip string	Новый IP-адрес в определении IP/порта. Возвращается: если были изменения Пример: `"10.12.13.14"`
parent string	Новый родительский шаблон монитора. Возвращается: если были изменения Пример: `"http"`
reverse boolean	Определяет, работает ли монитор в обратном режиме. Возвращается: если были изменения Пример: `true`
time_until_up integer	Новое время, по истечении которого система помечается как доступная после первого успешного ответа. Возвращается: если были изменения Пример: `2`
timeout integer	Новое время ожидания ответа удалённой системы на запрос монитора. Возвращается: если были изменения Пример: `10`
up_interval integer	Интервал, с которым система выполняет проверку работоспособности ресурса, когда он доступен. Возвращается: если были изменения Пример: `0`

Авторы

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