f5networks.f5_modules.bigip_monitor_gateway_icmp модуль — Управляет мониторами ICMP шлюзов 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_gateway_icmp.

Новый в f5networks.f5_modules 1.0.0

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

Обзор

Управляет мониторами ICMP шлюзов на BIG-IP LTM.

Параметры

Параметр	Комментарии
adaptive boolean	Указывает, включен ли адаптивный мониторинг времени отклика для этого монитора. Когда `true`, монитор определяет состояние службы на основе того, насколько сильно отклонение от средней задержки допустимо для зонда монитора для этой службы. Также будут применяться значения для `allowed_divergence`, `adaptive_limit`, и `sampling_timespan`. Когда `disabled`, монитор определяет состояние службы на основе `interval`, `up_interval`, `time_until_up`, и `timeout` параметров монитора. Варианты: `false` `true`
adaptive_limit integer	Указывает абсолютное количество миллисекунд, которое не может быть превышено зондом монитора, независимо от настройки `allowed_divergence`, чтобы зонд считался успешным. Это значение применяется независимо от значения параметра `allowed_divergence`. Хотя это значение может быть настроено, когда `adaptive` равно `false`, оно не будет действовать в системе, пока `adaptive` не будет `true`.
allowed_divergence_type string	При указании нового монитора, если `adaptive` равно `true`, значение по умолчанию равно `relative`. Когда `absolute`, количество миллисекунд, на которое задержка зонда монитора может превышать среднюю задержку зонда монитора для проверяемой службы. В типичных случаях, если монитор обнаруживает три зонда подряд, которые пропускают заданное вами значение задержки, член пула или узел помечается как неработающий. Когда `relative`, процент отклонения, на который задержка зонда монитора может превышать среднюю задержку зонда монитора для проверяемой службы. Варианты: `"relative"` `"absolute"`
allowed_divergence_value integer	При указании нового монитора, если `adaptive` равно `true`, и `type` равно `relative`, значение по умолчанию равно `25` процентов.
description string	Описание монитора.
interval integer	Указывает, в секундах, частоту, с которой система выполняет проверку монитора, когда ресурс не работает или состояние ресурса неизвестно.
ip string	IP-адрес в определении IP/порт. Если этот параметр не указан при создании нового монитора, значение по умолчанию — ‘*’.
manual_resume boolean	Указывает, автоматически ли система изменяет состояние ресурса на enabled при следующей успешной проверке монитора. Если вы установите этот параметр в `true`, вы должны вручную снова включить ресурс, прежде чем система сможет использовать его для подключений балансировки нагрузки. Когда `true`, указывает, что вы должны вручную снова включить ресурс после неудачной проверки монитора. Когда `false`, указывает, что система автоматически изменяет состояние ресурса на enabled при следующей успешной проверке монитора. Варианты: `false` `true`
name string / required	Имя монитора.
parent string	Родительский шаблон этого шаблона монитора. После установки это значение нельзя изменить. По умолчанию это значение — родительский `gateway_icmp` в разделе `Common`. По умолчанию: `"/Common/gateway_icmp"`
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 / required	Пароль для учетной записи пользователя, используемой для подключения к 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` ← (по умолчанию)
sampling_timespan целое число	Указывает длину, в секундах, окна истории запросов, которое система использует для расчета средней задержки и стандартного отклонения зондирования монитора. Хотя это значение может быть настроено, когда `adaptive` равно `false`, оно не вступит в силу на системе до тех пор, пока `adaptive` не станет `true`.
state строка	Когда `present`, гарантирует существование монитора. Когда `absent`, гарантирует удаление монитора. Варианты: `"present"` ← (по умолчанию) `"absent"`
time_until_up целое число	Указывает количество секунд, которые необходимо подождать после того, как ресурс впервые правильно ответит на монитор, прежде чем установить ресурс в «включённое» состояние. В течение этого интервала все ответы от ресурса должны быть корректными. По истечении интервала ресурс отмечается как «включённый». Значение `0` означает, что ресурс отмечается как включённый сразу после получения первого правильного ответа.
timeout целое число	Указывает количество секунд, в течение которых целевой объект должен ответить на запрос монитора. Если целевой объект отвечает в заданный период времени, он считается «включённым». Если целевой объект не отвечает в заданный период времени, он считается «выключенным». При установке этого значения в 0 (ноль) система использует интервал родительского монитора. Обратите внимание, что `timeout` и `time_until_up` комбинируются для управления тем, когда ресурс устанавливается в состояние «включён».
transparent логическое значение	Указывает, работает ли монитор в прозрачном режиме. Монитор в прозрачном режиме направляет трафик через ассоциированных членов пула или узлов (обычно маршрутизатор или брандмауэр) к алиасному пункту назначения (то есть зондирует комбинацию `ip`-`port`, указанную в мониторе). Если монитор не может успешно достичь алиасного пункта назначения, то член пула или узел, через который отправлялся трафик монитора, отмечаются как «выключенные». При создании нового монитора, если этот параметр не указан, то значение по умолчанию будет соответствовать значению, заданному `parent`. Варианты: `false` `true`
up_interval целое число	Указывает интервал, используемый системой для проверки работоспособности, когда ресурс включен. При значении `0`, система использует интервал, указанный в `interval`, для проверки работоспособности ресурса. При любом другом числе вы можете указать другой интервал для проверки работоспособности ресурса, который включён.

Примечания

Примечание

Дополнительную информацию об использовании 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 monitor
  bigip_monitor_gateway_icmp:
    name: gw1
    adaptive: false
    interval: 1
    time_until_up: 0
    timeout: 3
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Описание
adaptive boolean	Включена ли адаптивная функция или нет. Возвращено: changed Пример: `true`
adaptive_limit integer	Абсолютное количество миллисекунд, которое не может быть превышено зондом монитора. Возвращено: changed Пример: `200`
allowed_divergence_type string	Тип расхождения, используемый для адаптивного мониторинга времени отклика. Возвращено: changed Пример: `"absolute"`
allowed_divergence_value integer	Значение типа расхождения, используемого для адаптивного мониторинга времени отклика. Может быть `percent` или `ms` в зависимости от того, `relative` или `absolute`. Возвращено: changed Пример: `25`
description string	Описание монитора. Возвращено: changed Пример: `"Important Monitor"`
interval integer	Новый интервал, с которым будет выполняться проверка монитора. Возвращено: changed Пример: `2`
ip string	Новый IP-адрес определения IP/порт. Возвращено: changed Пример: `"10.12.13.14"`
parent string	Новый родительский шаблон монитора. Возвращено: changed Пример: `"gateway-icmp"`
port string	Псевдоним порта или сервиса, который должен проверять монитор, от имени пулов или членов пулов, с которыми связан монитор. Возвращено: changed Пример: `"80"`
sampling_timespan integer	Абсолютное количество миллисекунд, которое не может быть превышено зондом монитора. Возвращено: changed Пример: `200`
time_until_up integer	Новое время, в течение которого система будет помечена как активная после первого успешного ответа. Возвращено: changed Пример: `2`
timeout integer	Новое время ожидания, в течение которого удаленная система должна ответить на запрос монитора. Возвращено: changed Пример: `10`
transparent boolean	Работает ли монитор в прозрачном режиме. Возвращено: changed Пример: `false`
up_interval integer	Интервал, который система использует для проверки работоспособности, когда ресурс активен. Возвращено: changed Пример: `0`

Авторы

Tim Rupp (@caphrim007)

Ссылки на коллекцию

© 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_gateway_icmp_module.html