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

Примечание

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

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

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

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

Управляет HTTP-мониторами F5 BIG-IP GTM (теперь BIG-IP DNS).

Параметры

Параметр	Комментарии
ignore_down_response boolean	Указывает, что монитор допускает более одной попытки проверки за интервал. Если задано значение `true`, монитор игнорирует ответы о недоступности в течение времени ожидания монитора. Если по истечении времени ожидания система не получила ответ о доступности, она помечает объект как недоступный. Если задано значение `false`, монитор сразу помечает объект как недоступный при получении соответствующего ответа. При создании нового монитора, если этот параметр не указан, используется значение по умолчанию `false`. Варианты: `false` `true`
interval integer	Интервал, определяющий частоту запуска экземпляра монитора на основе этого шаблона. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию 30. Это значение должно быть меньше значения `timeout`.
ip string	IP-адрес в определении IP/порта. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию «*». Если это значение является IP-адресом, необходимо указать номер `port`.
name string / обязательный	Имя монитора.
parent string	Родительский шаблон этого шаблона монитора. После установки это значение изменить нельзя. По умолчанию используется родительский шаблон `http` в разделе `Common`. По умолчанию: `"/Common/http"`
partition string	Раздел устройства, в котором будут управляться ресурсы. По умолчанию: `"Common"`
port string	Порт в определении IP/порта. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию «*». При указании IP-адреса необходимо использовать значение от 1 до 65535.
probe_timeout integer	Указывает число секунд, по истечении которого система прекращает ожидание ответа на запрос проверки. При создании нового монитора, если этот параметр не указан, используется значение по умолчанию `5`.
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	Строка получения для вызова монитора.
reverse boolean	Указывает системе помечать целевой ресурс как недоступный при успешном прохождении проверки. Этот параметр полезен, например, если содержимое главной страницы вашего веб-сайта динамическое и часто меняется: можно настроить обратную проверку службы ECV на наличие строки Error. Наличие этой строки означает, что веб-сервер недоступен. Для использования этого параметра необходимо указать значения для `send` и `receive`. Варианты: `false` `true`
send string	Строка отправки для вызова монитора. При создании нового монитора, если этот параметр не указан, используется значение по умолчанию `GET /\r\n`.
state string	Если задано значение `present`, обеспечивает наличие монитора. Если задано значение `absent`, обеспечивает удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
target_password string	Указывает пароль, если для контролируемого целевого объекта требуется аутентификация.
target_username string	Указывает имя пользователя, если для контролируемого целевого объекта требуется аутентификация.
timeout integer	Количество секунд, за которое узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение заданного времени, он считается доступным. Если целевой объект не отвечает в течение заданного времени, он считается недоступным. Значение можно изменить на любое число, однако оно должно равняться трём интервалам в секундах плюс одна секунда. Если при создании нового монитора этот параметр не указан, используется значение по умолчанию 120.
transparent boolean	Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через связанные с ним участники пула или узлы (обычно маршрутизатор или брандмауэр) к псевдонимному целевому объекту (то есть проверяет комбинацию `ip`-`port`, указанную в мониторе). Если монитор не может успешно связаться с псевдонимным целевым объектом, участник пула или узел, через который передавался трафик монитора, помечается как недоступный. При создании нового монитора, если этот параметр не указан, по умолчанию используется значение «нет» `false`. Варианты: `false` `true`
update_password string	`always` обновляет пароли, если указан параметр `target_password`. `on_create` задаёт пароль только для вновь созданных мониторов. Варианты: `"always"` ← (по умолчанию) `"on_create"`

Примечания

Примечание

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

Примеры

- name: Create a GTM HTTP monitor
  bigip_gtm_monitor_http:
    name: my_monitor
    ip: 1.1.1.1
    port: 80
    send: my send string
    receive: my receive string
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

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

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

Ключ	Описание
ignore_down_response boolean	Указывает, следует ли игнорировать ответ о недоступности. Возвращается: changed Пример: `true`
interval integer	Новый интервал запуска проверки монитора. Возвращается: changed Пример: `2`
ip string	Новый IP-адрес в определении IP/порта. Возвращается: changed Пример: `"10.12.13.14"`
parent string	Новый родительский шаблон монитора. Возвращается: changed Пример: `"http"`
port string	Новый порт, по которому монитор проверяет ресурс. Возвращается: changed Пример: `"8080"`
probe_timeout integer	Новое время ожидания, по истечении которого система прекращает ожидание проверки монитора. Возвращается: changed Пример: `10`
receive string	Новая строка получения для этого монитора. Возвращается: changed Пример: `"tcp string to receive"`
reverse boolean	Новое значение, указывающее, работает ли монитор в обратном режиме. Возвращается: changed Пример: `false`
send string	Новая строка отправки для этого монитора. Возвращается: changed Пример: `"tcp string to send"`
timeout integer	Новое время ожидания ответа удалённой системы на запрос монитора. Возвращается: changed Пример: `10`
transparent boolean	Новое значение, указывающее, работает ли монитор в прозрачном режиме. Возвращается: changed Пример: `false`

Авторы

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