Модуль f5networks.f5_modules.bigip_monitor_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 процентов.

app_service

string

Служба iApp, связанная с этим профилем. Если служба не указана, по умолчанию используется None.

description

string

Описание монитора.

interval

integer

Указывает интервал в секундах, с которым система выполняет проверку монитора, если ресурс недоступен или его состояние неизвестно.

ip

string

Указывает IP-адрес ресурса, являющегося целевым объектом этого монитора.

Если задано значение *, устройство проверяет работоспособность IP-адреса узла.

Если задано значение <IP>, устройство проверяет работоспособность этого IP-адреса и по результатам ответа помечает связанный узел как доступный или недоступный. Если этот параметр не задан при создании монитора, устройство устанавливает его по умолчанию.

Если задано значение <IP>, а transparent имеет значение true, устройство проверяет работоспособность этого IP-адреса, направляет проверку через IP-адрес связанного узла и соответственно помечает этот IP-адрес узла как доступный или недоступный.

manual_resume

boolean

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

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

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

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

Варианты:

• false
• true

name

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

Указывает имя монитора.

parent

string

Родительский шаблон этого шаблона монитора. После задания этого значения его нельзя изменить.

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

partition

string

Раздел устройства, в котором выполняется управление ресурсами.

По умолчанию: "Common"

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

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

Включен ли адаптивный режим.

Возвращается: при изменении

Пример: true

adaptive_limit

integer

Абсолютное количество миллисекунд, которое не должен превышать запрос проверки монитора.

Возвращается: при изменении

Пример: 200

allowed_divergence_type

string

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

Возвращается: при изменении

Пример: "absolute"

allowed_divergence_value

integer

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

Может быть percent или ms в зависимости от того, relative или absolute.

Возвращается: при изменении

Пример: 25

app_service

string

Сервис iApp, связанный с этим монитором.

Возвращается: при изменении

Пример: "/Common/good_service.app/good_service"

description

string

Описание монитора.

Возвращается: при изменении

Пример: "Important Monitor"

interval

integer

Новый интервал выполнения проверки монитора.

Возвращается: при изменении

Пример: 2

ip

string

Новый IP-адрес в определении IP/порта.

Возвращается: при изменении

Пример: "10.12.13.14"

parent

string

Новый родительский шаблон монитора.

Возвращается: при изменении

Пример: "gateway-icmp"

port

string

Псевдоним порта или службы, которые монитор проверяет от имени связанных с ним пулов или участников пулов.

Возвращается: при изменении

Пример: "80"

sampling_timespan

integer

Абсолютное количество миллисекунд, которое не должен превышать запрос проверки монитора.

Возвращается: при изменении

Пример: 200

time_until_up

integer

Новое время, по истечении которого система будет отмечена как работоспособная после первого успешного ответа.

Возвращается: при изменении

Пример: 2

timeout

integer

Новый интервал ожидания, в течение которого удаленная система должна ответить монитору.

Возвращается: при изменении

Пример: 10

transparent

boolean

Работает ли монитор в прозрачном режиме.

Возвращается: при изменении

Пример: false

up_interval

integer

Интервал выполнения проверки работоспособности ресурса, когда он доступен.

Возвращается: при изменении

Пример: 0