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

Указывает, будет ли система автоматически переводить ресурс в состояние включён после следующей успешной проверки монитора.

Если задать для этого параметра значение true, необходимо вручную повторно включить ресурс, прежде чем система сможет использовать его для балансировки нагрузки соединений.

Если true, указывает, что после неудачной проверки монитора необходимо вручную повторно включить ресурс.

Если false, указывает, что после следующей успешной проверки монитора система автоматически переводит ресурс в состояние включён.

Варианты:

• false
• true

name

string / обязательный

Имя монитора.

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

Словарь с параметрами подключения.

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 ← (по умолчанию)

sampling_timespan

integer

Задаёт в секундах продолжительность окна истории проверок, используемого системой для вычисления средней задержки и стандартного отклонения проверки монитора.

Это значение можно настроить, когда adaptive равно false, однако оно не начнёт действовать в системе, пока adaptive не будет равно true.

state

string

Если present, обеспечивает наличие монитора.

Если absent, обеспечивает удаление монитора.

Варианты:

• "present" ← (по умолчанию)
• "absent"

time_until_up

integer

Задаёт количество секунд ожидания после первого корректного ответа ресурса на запрос монитора, прежде чем перевести ресурс в состояние «доступен».

В течение этого интервала все ответы ресурса должны быть корректными.

По истечении интервала ресурс помечается как «доступен».

Значение 0 означает, что ресурс будет помечен как доступный сразу после получения первого корректного ответа.

timeout

integer

Задаёт количество секунд, в течение которых целевой объект должен ответить на запрос монитора.

Если целевой объект отвечает в течение заданного периода, он считается «доступным». Если целевой объект не отвечает в течение заданного периода, он считается «недоступным». Если задать значение 0 (ноль), система использует интервал родительского монитора.

Обратите внимание: параметры timeout и time_until_up совместно определяют, когда ресурс переводится в состояние «доступен».

transparent

boolean

Указывает, работает ли монитор в прозрачном режиме.

В прозрачном режиме монитор направляет трафик через связанные с ним участники пула или узлы (обычно маршрутизатор или межсетевой экран) к псевдонимному адресу назначения (то есть проверяет комбинацию ip-port, заданную в мониторе).

Если монитору не удаётся связаться с псевдонимным адресом назначения, участник пула или узел, через который проходил трафик монитора, помечается как недоступный.

При создании нового монитора, если этот параметр не задан, используется значение, заданное в parent.

Варианты:

• false
• true

up_interval

integer

Задаёт интервал, который система использует для проверки работоспособности доступного ресурса.

Если 0, система использует для проверки работоспособности ресурса интервал, заданный в interval.

При любом другом значении можно задать отдельный интервал для проверки работоспособности доступного ресурса.

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