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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.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`. Выбоpы: `false` `true` ← (по умолчанию)
receive string	Строка приема для вызова монитора.
reverse boolean	Инструктирует систему отметить целевой ресурс как недоступный, когда тест успешен. Этот параметр полезен, например, если контент на домашней странице вашего веб-сайта динамичный и часто меняется, вы можете настроить обратный ECV-сервисный чек, который ищет строку Error. Совпадение с этой строкой означает, что веб-сервер был недоступен. Для использования этого параметра необходимо указать значения для `send` и `receive`. Выбоpы: `false` `true`
send string	Строка отправки для вызова монитора. При создании нового монитора, если этот параметр не указан, используется значение по умолчанию `GET /\r\n`.
state string	Когда `present`, гарантирует существование монитора. Когда `absent`, гарантирует удаление монитора. Выбоpы: `"present"` ← (по умолчанию) `"absent"`
target_password string	Указывает пароль, если мониторируемый целевой объект требует аутентификации.
target_username string	Указывает имя пользователя, если мониторируемый целевой объект требует аутентификации.
timeout integer	Количество секунд, в течение которого узел или служба должны ответить на запрос монитора. Если целевой объект отвечает в течение заданного периода времени, он считается доступным. Если целевой объект не отвечает в течение заданного периода времени, он считается недоступным. Вы можете изменить это значение на любое число, однако оно должно быть в 3 раза больше числа интервалов в секундах плюс 1 секунда. Если этот параметр не указан при создании нового монитора, то значение по умолчанию составляет 120.
transparent boolean	Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через ассоциированные члены пула или узлы (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (т. е. зондирует комбинацию `ip`-`port` , указанную в мониторе). Если монитор не может успешно достичь алиасного пункта назначения, член пула или узел, через который был отправлен трафик монитора, отмечается как недоступный. При создании нового монитора, если этот параметр не указан, значение по умолчанию — нет `false`. Выбоpы: `false` `true`
update_password string	`always` обновляет пароли, если задан `target_password`. `on_create` только устанавливает пароль для вновь созданных мониторов. Выбоpы: `"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	Игнорировать ответ о недоступности или нет. Возвращено: изменён Пример: `true`
interval integer	Новый интервал выполнения проверки монитора. Возвращено: изменён Пример: `2`
ip string	Новый IP-адрес определения IP/порт. Возвращено: изменён Пример: `"10.12.13.14"`
parent string	Новая родительская шаблон монитора. Возвращено: изменён Пример: `"http"`
port string	Новый порт, на котором монитор проверяет ресурс. Возвращено: изменён Пример: `"8080"`
probe_timeout integer	Новый таймаут, в котором система будет приостанавливать запрос монитора. Возвращено: изменён Пример: `10`
receive string	Новая строка приема для данного монитора. Возвращено: изменён Пример: `"tcp string to receive"`
reverse boolean	Новое значение для режима работы монитора в обратном направлении. Возвращено: изменён Пример: `false`
send string	Новая отправляемая строка для данного монитора. Возвращено: изменён Пример: `"tcp string to send"`
timeout integer	Новый таймаут, в который удаленная система должна ответить на монитор. Возвращено: изменён Пример: `10`
transparent boolean	Новое значение для режима работы монитора в прозрачном режиме. Возвращено: изменён Пример: `false`

Авторы

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