Модуль community.network.netscaler_lb_monitor – Управление балансировщиками нагрузки

acctapplicationid

string

Список пар значений атрибута Acct-Application-Id (AVP) для сообщения Capabilities-Exchange-Request (CER), используемого для мониторинга серверов Diameter. В сообщении мониторинга поддерживается максимум восемь таких пар AVP.

Минимальное значение = 0

Максимальное значение = 4294967295

action

string

Действие, выполняемое, когда ответ на встроенный монитор (монитор типа HTTP-INLINE) указывает на то, что служба не работает. Служба, контролируемая встроенным монитором, считается DOWN, если код ответа не является одним из кодов, указанных для параметра Код ответа.

Доступные настройки работают следующим образом:

* NONE - Не предпринимать никаких действий. Однако команды show service и show lb monitor указывают общее количество проверенных ответов и количество последовательных ошибочных ответов, полученных после последнего успешного опроса.

* LOG - Записать событие в NSLOG или SYSLOG.

* DOWN - Отметить службу как неработающую и не направлять на нее трафик, пока не истечет настроенное время простоя. Постоянные соединения с сервисом разрываются, как только сервис помечается как DOWN. Также записать событие в NSLOG или SYSLOG.

Варианты:

• "NONE"
• "LOG"
• "DOWN"

alertretries

string

Количество последовательных сбоев зондирования, после которых устройство генерирует SNMP-ловушку monProbeFailed.

Минимальное значение = 0

Максимальное значение = 32

application

string

Имя приложения, используемого для определения состояния службы. Применимо к мониторам типа CITRIX-XML-SERVICE.

Минимальная длина = 1

attribute

string

Атрибут для оценки, когда LDAP-сервер отвечает на запрос. Успех или неудача зондирования мониторинга зависит от того, существует ли атрибут в ответе. Необязательно.

Минимальная длина = 1

authapplicationid

string

Список пар значений атрибута Auth-Application-Id (AVP) для сообщения Capabilities-Exchange-Request (CER), используемого для мониторинга серверов Diameter. В сообщении мониторинга CER поддерживается максимум восемь таких пар AVP.

Минимальное значение = 0

Максимальное значение = 4294967295

basedn

string

Базовое различающееся имя службы LDAP, с которого LDAP-сервер может начать поиск атрибутов в запросе мониторинга. Требуется для мониторинга службы LDAP.

Минимальная длина = 1

binddn

string

Различающееся имя, с помощью которого монитор LDAP может выполнить операцию Bind на LDAP-сервере. Необязательно. Применимо к мониторам LDAP.

Минимальная длина = 1

customheaders

string

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

database

string

Имя базы данных для подключения во время аутентификации.

Минимальная длина = 1

destip

string

IP-адрес службы, на которую следует отправлять зонды. Если параметр установлен в 0, IP-адрес сервера, к которому привязан монитор, считается целевым IP-адресом.

destport

string

TCP- или UDP-порт, на который следует отправлять зонд. Если параметр установлен в 0, номер порта службы, к которой привязан монитор, считается целевым портом. Однако для монитора типа USER, целевой порт — это номер порта, который включен в HTTP-запрос, отправленный диспетчеру. Не применяется к мониторам типа PING.

deviation

string

Значение времени, добавляемое к вычисленному среднему времени ответа в динамическом мониторинге времени ответа (DRTM). Когда указано отклонение, устройство узнает среднее время ответа привязанных служб и добавляет отклонение к среднему. Затем окончательное значение постоянно корректируется, чтобы учитывать изменения времени отклика во времени. Указывается в миллисекундах, секундах или минутах.

Минимальное значение = 0

Максимальное значение = 20939

dispatcherip

string

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

dispatcherport

string

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

domain

string

Домен, в котором находятся серверы XenDesktop Desktop Delivery Controller (DDC) или серверы веб-интерфейса. Требуется мониторами CITRIX-XD-DDC и CITRIX-WI-EXTENDED для входа на серверы DDC и серверы веб-интерфейса соответственно.

downtime

string

Продолжительность времени ожидания перед проверкой службы, помеченной как НЕРАБОЧАЯ. Выражается в миллисекундах, секундах или минутах.

Минимальное значение = 1

Максимальное значение = 20939

evalrule

string

Выражение синтаксиса по умолчанию, которое оценивает ответ сервера базы данных на запрос мониторинга MYSQL-ECV или MSSQL-ECV. Должно давать логический результат. Результат определяет состояние сервера. Если выражение возвращает TRUE, зондирование завершается успешно.

Например, если вы хотите, чтобы устройство оценивало сообщение об ошибке для определения состояния сервера, используйте правило MYSQL.RES.ROW(10 .TEXT_ELEM(2).EQ(“MySQL”)).

failureretries

string

Количество попыток, которые должны завершиться неудачей из числа, указанного для параметра «Попытки», чтобы служба была помечена как НЕРАБОЧАЯ. Например, если параметр «Попытки» установлен в 10, а параметр «Сбои при повторных попытках» — в 6, то из десяти отправленных зондов по крайней мере шесть зондов должны завершиться неудачей, чтобы служба была помечена как НЕРАБОЧАЯ. Значение по умолчанию 0 означает, что все повторные попытки должны завершиться неудачей, чтобы служба была помечена как НЕРАБОЧАЯ.

Минимальное значение = 0

Максимальное значение = 32

filename

string

Имя файла на FTP-сервере. Устройство отслеживает FTP-службу, периодически проверяя наличие файла на сервере. Применимо к мониторам FTP-EXTENDED.

Минимальная длина = 1

filter

string

Критерии фильтрации для запроса LDAP. Необязательно.

Минимальная длина = 1

firmwarerevision

string

Значение Firmware-Revision для сообщения Capabilities-Exchange-Request (CER), используемого для мониторинга серверов Diameter.

group

string

Имя доступной в службе NNTP новостной группы, которую необходимо отслеживать. Устройство периодически формирует запрос NNTP для имени новостной группы и оценивает ответ. Если новостная группа найдена на сервере, служба помечается как РАБОЧАЯ. Если новостная группа не существует или поиск завершается неудачей, служба помечается как НЕРАБОЧАЯ. Применимо к мониторам NNTP.

Минимальная длина = 1

hostipaddress

string

Значение Host-IP-Address для сообщения Capabilities-Exchange-Request (CER), используемого для мониторинга серверов Diameter. Если Host-IP-Address не указан, устройство вставляет сопоставленный IP-адрес (MIP) или IP-адрес подсети (SNIP), с которого отправляется запрос CER (контрольный зонд).

Минимальная длина = 1

hostname

string

Имя хоста в формате FQDN (Пример: porche.cars.org). Применимо к мониторам STOREFRONT.

Минимальная длина = 1

httprequest

string

HTTP-запрос для отправки на сервер (например, "HEAD /file.html").

inbandsecurityid

string

Inband-Security-Id для сообщения Capabilities-Exchange-Request (CER), используемого для мониторинга серверов Diameter.

Варианты:

• "NO_INBAND_SECURITY"
• "TLS"

interval

string

Временной интервал между двумя последовательными зондами. Должно быть больше, чем значение тайм-аута ответа.

Минимальное значение = 1

Максимальное значение = 20940

ipaddress

string

Набор IP-адресов, ожидаемых в ответе мониторинга от DNS-сервера, если тип записи — A или AAAA. Применимо к мониторам DNS.

Минимальная длина = 1

iptunnel

boolean

Отправить контрольный зонд в службу через IP-туннель. Необходимо указать целевой IP-адрес.

Варианты:

• false
• true

kcdaccount

string

Учетная запись KCD, используемая монитором MSSQL.

Минимальная длина = 1

Максимальная длина = 32

lasversion

string

Номер версии агента входа Citrix Advanced Access Control Logon Agent. Требуется монитору CITRIX-AAC-LAS.

logonpointname

string

Имя точки входа, настроенной для программного обеспечения Citrix Access Gateway Advanced Access Control. Требуется, если вы хотите отслеживать связанную страницу входа или агент входа. Применимо к мониторам CITRIX-AAC-LAS и CITRIX-AAC-LOGINPAGE.

lrtm

string

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

Варианты:

• "enabled"
• "disabled"

maxforwards

string

Максимальное количество переходов, которые может совершить запрос SIP, используемый для мониторинга, чтобы добраться до сервера. Применимо только к мониторам типа SIP-UDP.

Минимальное значение = 0

Максимальное значение = 255

metrictable

string

Таблица метрик, к которой необходимо привязать метрики.

Минимальная длина = 1

Максимальная длина = 99

monitorname

string

Имя для монитора. Должно начинаться с буквенно-цифрового символа ASCII или символа подчеркивания _, и должно содержать только буквенно-цифровые символы ASCII, символ подчеркивания, символ решётки #, точку ., пробел, двоеточие :, символ «@» @, знак равенства = и дефис -.

Минимальная длина = 1

mssqlprotocolversion

string

Версия сервера MSSQL, который подлежит мониторингу.

Варианты:

• "70"
• "2000"
• "2000SP1"
• "2005"
• "2008"
• "2008R2"
• "2012"
• "2014"

netprofile

string

Имя сетевого профиля.

Минимальная длина = 1

Максимальная длина = 127

nitro_pass

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

Пароль для аутентификации на узле netscaler.

nitro_protocol

string

Протокол для доступа к объектам API nitro.

Варианты:

• "http" ← (по умолчанию)
• "https"

nitro_timeout

float

Время в секундах до сбрасывания таймаута при установлении нового сеанса с Netscaler

По умолчанию: 310.0

nitro_user

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

Имя пользователя для аутентификации на узле netscaler.

nsip

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

IP-адрес устройства netscaler, на котором будут выполняться вызовы API nitro.

Порт можно указать с использованием двоеточия (:). Например, 192.168.1.1:555.

oraclesid

string

Имя идентификатора службы, используемого для подключения к базе данных Oracle во время аутентификации.

Минимальная длина = 1

originhost

string

Значение Origin-Host для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter.

Минимальная длина = 1

originrealm

string

Значение Origin-Realm для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter.

Минимальная длина = 1

password

string

Пароль, необходимый для входа на сервер RADIUS, NNTP, FTP, FTP-EXTENDED, MYSQL, MSSQL, POP3, CITRIX-AG, CITRIX-XD-DDC, CITRIX-WI-EXTENDED, CITRIX-XNC-ECV или CITRIX-XDM. Используется совместно с именем пользователя, указанным для параметра username.

Минимальная длина = 1

productname

string

Значение Product-Name для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter.

Минимальная длина = 1

query

string

Имя домена для разрешения в рамках мониторинга службы DNS (например, example.com).

querytype

string

Тип записи DNS для отправки запросов мониторинга. Устанавливается в Address для запроса записей A, AAAA для запроса записей AAAA и Zone для запроса записи SOA.

Варианты:

• "Address"
• "Zone"
• "AAAA"

radaccountsession

string

Идентификатор сеанса учетной записи RADIUS для использования в пакете запроса учетной записи. Применимо к мониторам типа RADIUS_ACCOUNTING.

Минимальная длина = 1

radaccounttype

string

Тип учетной записи RADIUS для использования в пакете запроса учетной записи. Применимо к мониторам типа RADIUS_ACCOUNTING.

Минимальное значение = 0

Максимальное значение = 15

radapn

string

Идентификатор вызывающей стороны для использования в пакете запроса учетной записи. Применимо к мониторам типа RADIUS_ACCOUNTING.

Минимальная длина = 1

radframedip

string

Исходный IP-адрес, с которого пакет будет отправлен. Применимо к мониторам типа RADIUS_ACCOUNTING.

radkey

string

Ключ аутентификации (текстовая строка общего секрета) для обмена между клиентами и серверами RADIUS. Применимо к мониторам типа RADIUS и RADIUS_ACCOUNTING.

Минимальная длина = 1

radmsisdn

string

Идентификатор вызывающей стороны для использования в пакете запроса учетной записи. Применимо к мониторам типа RADIUS_ACCOUNTING.

Минимальная длина = 1

radnasid

string

NAS-идентификатор для отправки в пакете Access-Request. Применимо к мониторам типа RADIUS.

Минимальная длина = 1

radnasip

string

IP-адрес сервера сетевого доступа (NAS), который будет использоваться в качестве исходного IP-адреса при мониторинге RADIUS-сервера. Применимо к мониторам типа RADIUS и RADIUS_ACCOUNTING.

recv

string

Строка, ожидаемая от сервера для того, чтобы служба была помечена как UP. Применимо к мониторам TCP-ECV, HTTP-ECV и UDP-ECV.

respcode

string

Коды ответов, при которых служба помечается как UP. Для любого другого кода ответа выполняемое действие зависит от типа монитора. Мониторы HTTP и RADIUS помечают службу как DOWN, а мониторы HTTP-INLINE выполняют действие, указанное параметром Action.

resptimeout

string

Время, в течение которого устройство должно ждать, прежде чем пометить зонд как FAILED. Должно быть меньше значения, указанного для параметра Interval.

Примечание: Для мониторов UDP-ECV, для которых не настроена принимающая строка, время ожидания ответа не применяется. Для мониторов UDP-ECV без принимающей строки сбой зонда указывается ошибкой ICMP «порт недоступен», полученной от службы.

Минимальное значение = 1

Максимальное значение = 20939

resptimeoutthresh

string

Пороговое значение времени отклика, указанное в процентах от параметра Response Time-out. Если ответ на зондирование монитора не получен, когда достигается пороговое значение, устройство генерирует SNMP-ловушку monRespTimeoutAboveThresh. После того, как время отклика вернется к значению ниже порогового, устройство генерирует SNMP-ловушку monRespTimeoutBelowThresh. Для генерации ловушек также должна быть включена тревога «MONITOR-RTO-THRESHOLD».

Минимальное значение = 0

Максимальное значение = 100

retries

string

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

Минимальное значение = 1

Максимальное значение = 127

reverse

boolean

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

Варианты:

• false
• true

rtsprequest

string

RTSP-запрос для отправки на сервер (например, "OPTIONS *").

save_config

boolean

Если yes, модуль сохранит конфигурацию на узле NetScaler, если он внесет какие-либо изменения.

Модуль не будет сохранять конфигурацию на узле NetScaler, если он не внес никаких изменений.

Варианты:

• false
• true ← (по умолчанию)

scriptargs

string

Строка аргументов для скрипта. Строка копируется дословно в запрос.

scriptname

string

Путь и имя скрипта для выполнения. Скрипт должен быть доступен на устройстве NetScaler в каталоге /nsconfig/monitors/.

Минимальная длина = 1

secondarypassword

string

Дополнительный пароль, который пользователям может потребоваться предоставить для входа на сервер Access Gateway. Применимо к мониторам CITRIX-AG.

secure

boolean

Использовать защищенное SSL-соединение при мониторинге службы. Применимо только к мониторам на основе TCP. Опция secure не может использоваться с монитором CITRIX-AG, так как монитор CITRIX-AG по умолчанию использует защищенное соединение.

Варианты:

• false
• true

send

string

Строка для отправки службе. Применимо к мониторам TCP-ECV, HTTP-ECV и UDP-ECV.

sipmethod

string

SIP-метод, который нужно использовать для запроса. Применимо только к мониторам типа SIP-UDP.

Варианты:

• "OPTIONS"
• "INVITE"
• "REGISTER"

sipreguri

string

SIP-пользователь для регистрации. Применимо только в том случае, если монитор имеет тип SIP-UDP и параметр SIP Method установлен в REGISTER.

Минимальная длина = 1

sipuri

string

Строка SIP URI для отправки службе (например, sip:sip.test). Применимо только к мониторам типа SIP-UDP.

Минимальная длина = 1

sitepath

string

URL-адрес страницы входа. Для мониторов типа CITRIX-WEB-INTERFACE, чтобы отслеживать динамическую страницу по пути к сайту, завершите путь к сайту с помощью символа слэша /. Применимо к мониторам CITRIX-WEB-INTERFACE, CITRIX-WI-EXTENDED и CITRIX-XDM.

Минимальная длина = 1

snmpcommunity

string

Имя сообщества для SNMP мониторов.

Минимальная длина = 1

Snmpoid

string

SNMP OID для SNMP мониторов.

Минимальная длина = 1

snmpthreshold

string

Пороговое значение для SNMP мониторов.

Минимальная длина = 1

snmpversion

string

Версия SNMP, которая будет использоваться для SNMP мониторов.

Варианты:

• "V1"
• "V2"

sqlquery

string

SQL-запрос для MYSQL-ECV или MSSQL-ECV монитора. Отправляется на сервер базы данных после того, как сервер аутентифицирует соединение.

Минимальная длина = 1

state

string

Состояние монитора. Настройка disabled отключает не только настраиваемый монитор, но и все мониторы того же типа, пока параметр не будет установлен в enabled. Если монитор привязан к сервису, состояние монитора не учитывается при определении состояния сервиса.

Варианты:

• "enabled"
• "disabled"

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

storedb

string

Сохранить список баз данных, заполненный ответами на зонды монитора. Используется в балансировке нагрузки, специфичной для базы данных, если настроен монитор MSSQL-ECV/MYSQL-ECV.

Варианты:

• "enabled"
• "disabled"

storefrontacctservice

boolean

Включить/Выключить зондирование для службы учетных записей. Применимо только к мониторам Store Front. Для конфигурации с несколькими клиентами пользователи могут пропустить службу учетных записей.

Варианты:

• false
• true

storefrontcheckbackendservices

boolean

Эта опция включит мониторинг служб, работающих на сервере StoreFront. Службы StoreFront контролируются путем зондирования службы Windows, которая работает на сервере StoreFront и предоставляет информацию о том, какие службы StoreFront работают.

Варианты:

• false
• true

storename

string

Имя хранилища. Для мониторов типа STOREFRONT, storename является необязательным аргументом, определяющим имя хранилища службы StoreFront. Применимо к мониторам STOREFRONT.

Минимальная длина = 1

successretries

string

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

Минимальное значение = 1

Максимальное значение = 32

supportedvendorids

string

Список пар значений атрибута Supported-Vendor-Id (AVP) для сообщения Capabilities-Exchange-Request (CER), используемого для мониторинга серверов Diameter. В сообщении мониторинга поддерживается максимум восемь таких AVP.

Минимальное значение = 1

Максимальное значение = 4294967295

tos

boolean

Проверить службу, закодировав целевой IP-адрес в 6 битах IP TOS.

Варианты:

• false
• true

tosid

string

Идентификатор TOS указанного целевого IP-адреса. Применимо только тогда, когда установлен параметр TOS.

Минимальное значение = 1

Максимальное значение = 63

transparent

boolean

Монитор привязан к прозрачному устройству, такому как брандмауэр или маршрутизатор. Состояние прозрачного устройства зависит от быстродействия служб, находящихся за ним. Если контролируется прозрачное устройство, необходимо указать целевой IP-адрес. Зонд отправляется на указанный IP-адрес с использованием MAC-адреса прозрачного устройства.

Варианты:

• false
• true

trofscode

string

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

trofsstring

string

Строка, ожидаемая от сервера для того, чтобы служба была помечена как trofs. Применимо к мониторам HTTP-ECV/TCP-ECV.

type

string

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

Варианты:

• "PING"
• "TCP"
• "HTTP"
• "TCP-ECV"
• "HTTP-ECV"
• "UDP-ECV"
• "DNS"
• "FTP"
• "LDNS-PING"
• "LDNS-TCP"
• "LDNS-DNS"
• "RADIUS"
• "USER"
• "HTTP-INLINE"
• "SIP-UDP"
• "SIP-TCP"
• "LOAD"
• "FTP-EXTENDED"
• "SMTP"
• "SNMP"
• "NNTP"
• "MYSQL"
• "MYSQL-ECV"
• "MSSQL-ECV"
• "ORACLE-ECV"
• "LDAP"
• "POP3"
• "CITRIX-XML-SERVICE"
• "CITRIX-WEB-INTERFACE"
• "DNS-TCP"
• "RTSP"
• "ARP"
• "CITRIX-AG"
• "CITRIX-AAC-LOGINPAGE"
• "CITRIX-AAC-LAS"
• "CITRIX-XD-DDC"
• "ND6"
• "CITRIX-WI-EXTENDED"
• "DIAMETER"
• "RADIUS_ACCOUNTING"
• "STOREFRONT"
• "APPC"
• "SMPP"
• "CITRIX-XNC-ECV"
• "CITRIX-XDM"
• "CITRIX-STA-SERVICE"
• "CITRIX-STA-SERVICE-NHOP"

units1

string

Единица измерения для параметра отклонения. Не может быть изменена после создания монитора.

Варианты:

• "SEC"
• "MSEC"
• "MIN"

units2

string

Единица измерения для параметра времени простоя. Не может быть изменена после создания монитора.

Варианты:

• "SEC"
• "MSEC"
• "MIN"

units3

string

Единицы интервала мониторинга.

Варианты:

• "SEC"
• "MSEC"
• "MIN"

units4

string

Единицы времени ожидания ответа монитора.

Варианты:

• "SEC"
• "MSEC"
• "MIN"

username

string

Имя пользователя, с помощью которого нужно проверить RADIUS, NNTP, FTP, FTP-EXTENDED, MYSQL, MSSQL, POP3, CITRIX-AG, CITRIX-XD-DDC, CITRIX-WI-EXTENDED, CITRIX-XNC или CITRIX-XDM сервер.

Минимальная длина = 1

validate_certs

boolean

Если no, SSL-сертификаты проверяться не будут. Это следует использовать только на лично контролируемых сайтах с самозаверяющими сертификатами.

Варианты:

• false
• true ← (по умолчанию)

validatecred

boolean

Проверить учетные данные пользователя сервера Xen Desktop DDC. Применимо к мониторам типа CITRIX-XD-DDC.

Варианты:

• false
• true

vendorid

string

Значение Vendor-Id для сообщения Capabilities-Exchange-Request (CER), используемого для мониторинга серверов Diameter.

vendorspecificacctapplicationids

string

Список пар значений атрибутов Vendor-Specific-Acct-Application-Id (AVP) для использования при мониторинге серверов Diameter. В сообщении мониторинга поддерживается максимум восемь таких AVP. Указанное значение объединяется со значением vendorSpecificVendorId для получения AVP Vendor-Specific-Application-Id в сообщении мониторинга CER.

Минимальное значение = 0

Максимальное значение = 4294967295

vendorspecificauthapplicationids

string

Список пар значений атрибутов Vendor-Specific-Auth-Application-Id (AVP) для сообщения Capabilities-Exchange-Request (CER), используемого для мониторинга серверов Diameter. В сообщении мониторинга поддерживается максимум восемь таких AVP. Указанное значение объединяется со значением vendorSpecificVendorId для получения AVP Vendor-Specific-Application-Id в сообщении мониторинга CER.

Минимальное значение = 0

Максимальное значение = 4294967295

vendorspecificvendorid

string

Vendor-Id для использования в группированной паре значений атрибутов Vendor-Specific-Application-Id (AVP) в сообщении мониторинга CER. Для указания Auth-Application-Id или Acct-Application-Id в Vendor-Specific-Application-Id используйте соответственно vendorSpecificAuthApplicationIds или vendorSpecificAcctApplicationIds. Поддерживается только один Vendor-Id для всех AVP Vendor-Specific-Application-Id в сообщении мониторинга CER.

Минимальное значение = 1