netscaler_lb_monitor – Управление мониторами балансировки нагрузки
Новая версия с 2.4.
Обзор
- Управление мониторами балансировки нагрузки.
- Этот модуль предназначен для запуска либо на контрольном узле ansible, либо на бастионе (jumpserver) с доступом к фактической инстанции netscaler.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- nitro python sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| acctapplicationid - | Список пар атрибутов Значение-Идентификатор-приложения (AVP) для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter. Максимальное количество этих AVP в сообщении мониторинга — восемь. Минимальное значение = 0
Максимальное значение = 4294967295
| |
| action - |
| Действие, которое нужно выполнить, когда ответ на внутренний мониторинг (мониторинг типа HTTP-INLINE) указывает на то, что служба недоступна. Служба, контролируемая внутренним мониторингом, считается DOWN, если код ответа не входит в список кодов, указанных для параметра Код ответа.Доступные настройки работают следующим образом: * NONE — не выполнять никаких действий. Однако команда show service и команда show lb monitor показывают общее количество проверок и количество последовательных ошибок после последнего успешного зондирования.* LOG — записать событие в NSLOG или SYSLOG.* DOWN — пометить службу как недоступную и не направлять трафик на службу до истечения установленного времени простоя. Постоянные подключения к службе прерываются сразу же после того, как служба помечена как DOWN. Кроме того, записать событие в NSLOG или SYSLOG. |
| alertretries - | Количество последовательных сбоев зондирования после которых прибор генерирует SNMP-ловушку monProbeFailed. Минимальное значение = 0
Максимальное значение = 32
| |
| application - | Имя приложения, используемого для определения состояния службы. Применимо к мониторам типа CITRIX-XML-SERVICE.Минимальная длина = 1 | |
| attribute - | Атрибут для оценки, когда сервер LDAP отвечает на запрос. Успех или неудача зондирования мониторинга зависят от того, существует ли атрибут в ответе. Необязательно. Минимальная длина = 1 | |
| authapplicationid - | Список пар атрибутов Значение-Идентификатор-приложения (AVP) для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter. Максимальное количество этих AVP в сообщении мониторинга CER — восемь. Минимальное значение = 0
Максимальное значение = 4294967295
| |
| basedn - | Базовое имя с разделителем (Distinguished Name) LDAP-службы, с которого сервер LDAP может начать поиск атрибутов в запросе мониторинга. Требуется для мониторинга служб LDAP. Минимальная длина = 1 | |
| binddn - | Имя с разделителем (Distinguished Name), с помощью которого монитор LDAP может выполнить операцию привязки (Bind) к серверу LDAP. Необязательно. Применимо к мониторам LDAP.Минимальная длина = 1 | |
| customheaders - | Строка пользовательского заголовка, которая должна быть включена в зондирование мониторинга. | |
| database - | Имя базы данных, к которой необходимо подключиться во время аутентификации. Минимальная длина = 1 | |
| destip - | IP-адрес службы, к которой должны быть отправлены зонды. Если параметр установлен в 0, IP-адрес сервера, к которому привязан монитор, считается конечным IP-адресом. | |
| destport - | TCP или UDP порт, к которому нужно отправить зонд. Если параметр установлен в 0, номер порта службы, к которой привязан монитор, считается конечным портом. Однако для монитора типа USER, конечный порт — это номер порта, включенный в HTTP-запрос, отправленный диспетчеру. Не применяется к мониторам типа PING. | |
| deviation - | Значение времени, добавляемое к усреднённому времени отклика при динамическом мониторинге времени отклика (DRTM). При указании отклонения прибор определяет среднее время отклика связанных служб и добавляет отклонение к среднему значению. Затем конечное значение постоянно корректируется, чтобы учитывать изменения времени отклика со временем. Указывается в миллисекундах, секундах или минутах. Минимальное значение = 0
Максимальное значение = 20939
| |
| dispatcherip - | IP-адрес диспетчера, которому нужно отправить зонд. | |
| dispatcherport - | Номер порта диспетчера, на котором он прослушивает зонды мониторинга. | |
| domain - | Домен, в котором присутствуют серверы XenDesktop Desktop Delivery Controller (DDC) или серверы веб-интерфейса. Требуется для мониторов CITRIX-XD-DDC и CITRIX-WI-EXTENDED соответственно для входа на серверы DDC и веб-интерфейса. | |
| downtime - | Продолжительность времени ожидания перед зондированием службы, помеченной как DOWN. Выражается в миллисекундах, секундах или минутах. Минимальное значение = 1
Максимальное значение = 20939
| |
| evalrule - | Выражение по умолчанию для синтаксического анализа ответа сервера базы данных на запрос мониторинга MYSQL-ECV или MSSQL-ECV. Должен возвращать логическое значение. Результат определяет состояние сервера. Если выражение возвращает TRUE, зондирование выполняется успешно. Например, если необходимо, чтобы прибор анализировал сообщение об ошибке для определения состояния сервера, используйте правило MYSQL.RES.ROW(10 .TEXT_ELE2.EQ("MySQL")). | |
| failureretries - | Количество попыток, которые должны завершиться неудачей из заданного количества для параметра Повторные попытки, для того чтобы служба была помечена как DOWN. Например, если параметр Повторные попытки установлен в 10, а параметр Повторные неудачи — в 6, то из десяти отправленных зондов по крайней мере шесть должны завершиться неудачей, для того чтобы служба была помечена как DOWN. Значение по умолчанию 0 означает, что все повторные попытки должны завершиться неудачей, если служба должна быть помечена как DOWN. Минимальное значение = 0
Максимальное значение = 32
| |
| filename - | Имя файла на FTP-сервере. Прибор контролирует FTP-службу, периодически проверяя существование файла на сервере. Применимо к мониторам FTP-EXTENDED.Минимальная длина = 1 | |
| filter - | Критерии фильтрации для запроса LDAP. Необязательно. Минимальная длина = 1 | |
| firmwarerevision - | Значение Firmware-Revision для сообщения Capabilities-Exchange-Request (CER), используемого для мониторинга серверов Diameter. | |
| group - | Имя новостной группы, доступной на NNTP-службе, которая должна быть отслежена. Прибор периодически генерирует запрос NNTP для имени новостной группы и анализирует ответ. Если новостная группа найдена на сервере, служба помечается как UP. Если новостная группа не существует или поиск завершается неудачей, служба помечается как DOWN. Применимо к NNTP-мониторам. Минимальная длина = 1 | |
| hostipaddress - | Значение Host-IP-Address для сообщения Capabilities-Exchange-Request (CER), используемого для мониторинга серверов Diameter. Если Host-IP-Address не указан, прибор вставляет сопоставленный IP-адрес (MIP) или IP-адрес подсети (SNIP) из которого отправляется запрос CER (зонд мониторинга). Минимальная длина = 1 | |
| hostname - | Имя хоста в формате FQDN (Пример: porche.cars.org). Применимо к мониторам STOREFRONT.Минимальная длина = 1 | |
| httprequest - | HTTP-запрос для отправки на сервер (например, "HEAD /file.html"). | |
| inbandsecurityid - |
| Inband-Security-Id для сообщения Capabilities-Exchange-Request (CER), используемого для мониторинга серверов Diameter. |
| interval - | Интервал времени между двумя последовательными зондами. Должен быть больше значения параметра «Время ожидания ответа». Минимальное значение = 1
Максимальное значение = 20940
| |
| ipaddress - | Набор IP-адресов, ожидаемых в ответе мониторинга от сервера DNS, если тип записи — A или AAAA. Применимо к мониторам DNS. Минимальная длина = 1 | |
| iptunnel boolean |
| Отправка зонда мониторинга к службе через IP-туннель. Необходимо указать целевой IP-адрес. |
| kcdaccount - | Аккаунт KCD, используемый монитором MSSQL. Минимальная длина = 1 Максимальная длина = 32 | |
| lasversion - | Номер версии агента входа Citrix Advanced Access Control Logon. Требуется монитором CITRIX-AAC-LAS. | |
| logonpointname - | Имя точки входа, настроенной для программного обеспечения Citrix Access Gateway Advanced Access Control. Требуется, если вы хотите отслеживать связанную страницу входа или агент входа. Применимо к мониторам CITRIX-AAC-LAS и CITRIX-AAC-LOGINPAGE. | |
| lrtm - |
| Расчет наименьших времен отклика для связанных служб. Если этот параметр не включен, прибор не определяет времен отклика связанных служб. Также используется для балансировки нагрузки LRTM. |
| maxforwards - | Максимальное количество переходов, которые может совершить запрос SIP, используемый для мониторинга, чтобы достичь сервера. Применимо только к мониторам типа SIP-UDP.Минимальное значение = 0
Максимальное значение = 255
| |
| metrictable - | Таблица метрик, к которой привязаны метрики. Минимальная длина = 1 Максимальная длина = 99 | |
| monitorname - | Имя монитора. Должно начинаться с символа ASCII-буквы, цифры или подчеркивания _, и должно содержать только символы ASCII-буквы, цифры, подчеркивания, решетку #, точку ., пробел, двоеточие :, знак «@» @, знак «=» =, и дефис -.Минимальная длина = 1 | |
| mssqlprotocolversion - |
| Версия сервера MSSQL, который должен быть отслежен. |
| netprofile - | Имя сетевого профиля. Минимальная длина = 1 Максимальная длина = 127 | |
| nitro_pass string / обязательно | Пароль для аутентификации на узле Netscaler. | |
| nitro_protocol string |
| Протокол для доступа к объектам API Nitro. |
| nitro_timeout float | По умолчанию: 310 | Время в секундах до возникновения ошибки таймаута при установлении нового сеанса с Netscaler. |
| nitro_user string / обязательно | Имя пользователя для аутентификации на узле Netscaler. | |
| nsip string / обязательно | IP-адрес устройства Netscaler, на котором будут выполняться вызовы API Nitro. Порт можно указать с двоеточием (:). Например, 192.168.1.1:555. | |
| oraclesid - | Имя идентификатора службы, используемого для подключения к базе данных Oracle во время аутентификации. Минимальная длина = 1 | |
| originhost - | Значение Origin-Host для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter. Минимальная длина = 1 | |
| originrealm - | Значение Origin-Realm для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter. Минимальная длина = 1 | |
| password - | Пароль, необходимый для входа на сервер RADIUS, NNTP, FTP, FTP-EXTENDED, MYSQL, MSSQL, POP3, CITRIX-AG, CITRIX-XD-DDC, CITRIX-WI-EXTENDED, CITRIX-XNC-ECV или CITRIX-XDM. Используется совместно с именем пользователя, указанным для параметра username. Минимальная длина = 1 | |
| productname - | Значение Product-Name для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter. Минимальная длина = 1 | |
| query - | Имя домена для разрешения в рамках мониторинга службы DNS (например, example.com). | |
| querytype - |
| Тип записи DNS, для которого отправляются запросы мониторинга. Установите значение Address для запроса записей A, AAAA для запроса записей AAAA и Zone для запроса записи SOA. |
| radaccountsession - | Идентификатор сеанса учетной записи для использования в пакете запроса учетной записи. Применимо к мониторам типа RADIUS_ACCOUNTING.Минимальная длина = 1 | |
| radaccounttype - | Тип учетной записи для использования в пакете запроса учетной записи. Применимо к мониторам типа RADIUS_ACCOUNTING.Минимальное значение = 0 Максимальное значение = 15 | |
| radapn - | Идентификатор вызываемой станции, который будет использоваться в пакете запроса учетной записи. Применимо к мониторам типа RADIUS_ACCOUNTING.Минимальная длина = 1 | |
| radframedip - | Исходный IP-адрес, с которого будет отправлен пакет. Применимо к мониторам типа RADIUS_ACCOUNTING. | |
| radkey - | Ключ аутентификации (строка общего секрета) для обмена между клиентами и серверами RADIUS. Применимо к мониторам типа RADIUS и RADIUS_ACCOUNTING.Минимальная длина = 1 | |
| radmsisdn - | Идентификатор вызывающей станции для использования в пакете запроса учетной записи. Применимо к мониторам типа RADIUS_ACCOUNTING.Минимальная длина = 1 | |
| radnasid - | NAS-идентификатор для отправки в пакете Access-Request. Применимо к мониторам типа RADIUS.Минимальная длина = 1 | |
| radnasip - | IP-адрес Network Access Server (NAS) для использования в качестве исходного IP-адреса при мониторинге сервера RADIUS. Применимо к мониторам типа RADIUS и RADIUS_ACCOUNTING. | |
| recv - | Строка, ожидаемая от сервера для маркировки службы как активной. Применимо к мониторам TCP-ECV, HTTP-ECV, и UDP-ECV. | |
| respcode - | Коды ответа, при которых служба отмечается как активная. Для других кодов ответа действие зависит от типа монитора. Мониторы HTTP и RADIUS отмечают службу как DOWN, в то время как мониторы HTTP-INLINE выполняют действие, указанное в параметре Action. |
| resptimeout - | Время ожидания прибором перед тем, как он отметит зонд как НЕУДАЧНЫЙ. Должно быть меньше значения, указанного для параметра Интервал. Примечание: Для UDP-ECV мониторов, для которых не настроена строка приема, тайм-аут ответа не применяется. Для UDP-ECV мониторов без строки приема, ошибка зонда указывается ошибкой недоступности порта ICMP, полученной от службы.Минимальное значение = 1
Максимальное значение = 20939
| |
| resptimeoutthresh - | Пороговое значение времени ответа, указанное в процентах от параметра Таймаут времени ответа. Если ответ на зондовый запрос монитора не получен при достижении порога, прибор генерирует SNMP-ловушку с именем monRespTimeoutAboveThresh. После того, как время ответа возвращается к значению ниже порога, прибор генерирует SNMP-ловушку monRespTimeoutBelowThresh. Для генерации ловушек также должен быть включен тревожный сигнал «MONITOR-RTO-THRESHOLD». Минимальное значение = 0
Максимальное значение = 100
| |
| retries - | Максимальное количество зондов, отправляемых для определения состояния службы, для которой произошла неудача мониторингового зонда. Минимальное значение = 1
Максимальное значение = 127
| |
| reverse boolean |
| Отметить службу как ВНЕ СТРОЯ вместо В СТРОЕ, когда критерии зонда удовлетворяются, и как В СТРОЕ вместо ВНЕ СТРОЯ, когда критерии зонда не удовлетворяются. |
| rtsprequest - | RTSP-запрос для отправки на сервер (например, "OPTIONS *"). | |
| save_config boolean |
| Если yes модуль сохранит конфигурацию на узле netscaler, если внесет какие-либо изменения.Модуль не сохранит конфигурацию на узле netscaler, если не внес никаких изменений. |
| scriptargs - | Строка аргументов для скрипта. Строка копируется дословно в запрос. | |
| scriptname - | Путь и имя скрипта для выполнения. Скрипт должен быть доступен на приборе NetScaler в каталоге /nsconfig/monitors/. Минимальная длина = 1 | |
| secondarypassword - | Дополнительный пароль, который пользователи могут потребоваться предоставить для входа на сервер шлюза доступа. Применимо к CITRIX-AG мониторам. | |
| secure boolean |
| Использовать безопасное SSL-соединение при мониторинге службы. Применимо только к TCP-мониторам. Параметр secure не может использоваться с монитором CITRIX-AG, потому что монитор CITRIX-AG по умолчанию использует безопасное соединение. |
| send - | Строка для отправки службе. Применимо к TCP-ECV, HTTP-ECV, и UDP-ECV мониторам. | |
| sipmethod - |
| SIP-метод для запроса. Применимо только к мониторам типа SIP-UDP. |
| sipreguri - | SIP-пользователь для регистрации. Применимо только если монитор типа SIP-UDP и параметр SIP Method установлен на REGISTER.Минимальная длина = 1 | |
| sipuri - | Строка SIP URI для отправки службе (например, sip:sip.test). Применимо только к мониторам типа SIP-UDP.Минимальная длина = 1 | |
| sitepath - | URL страницы входа. Для мониторов типа CITRIX-WEB-INTERFACE, для мониторинга динамической страницы по пути сайта, завершите путь сайта косой чертой /. Применимо к CITRIX-WEB-INTERFACE, CITRIX-WI-EXTENDED и CITRIX-XDM мониторам.Минимальная длина = 1 | |
| snmpcommunity - | Имя сообщества для SNMP мониторов.Минимальная длина = 1 | |
| Snmpoid - | SNMP OID для SNMP мониторов.Минимальная длина = 1 | |
| snmpthreshold - | Порог для SNMP мониторов.Минимальная длина = 1 | |
| snmpversion - |
| Версия SNMP, используемая для SNMP мониторов. |
| sqlquery - | SQL-запрос для MYSQL-ECV или MSSQL-ECV монитора. Отправляется на сервер базы данных после аутентификации подключения сервером.Минимальная длина = 1 | |
| state string |
"present" | Состояние монитора. Настройка disabled отключает не только настраиваемый монитор, но и все мониторы того же типа, пока параметр не будет установлен на enabled. Если монитор привязан к службе, состояние монитора не учитывается при определении состояния службы. |
| storedb - |
| Хранить список баз данных, заполненный ответами на зонды монитора. Используется в балансировке нагрузки, специфичной для баз данных, если настроен монитор MSSQL-ECV/MYSQL-ECV. |
| storefrontacctservice boolean |
| Включить/выключить проверку для службы учетных записей. Применимо только к мониторам Store Front. Для конфигурации многопользовательской системы пользователи могут пропустить службу учетных записей. |
| storefrontcheckbackendservices boolean |
| Этот параметр включит мониторинг служб, работающих на сервере storefront. Сервисы storefront отслеживаются путем зондирования службы Windows, которая выполняется на сервере Storefront и предоставляет подробную информацию о работающих сервисах storefront. |
| storename - | Имя магазина. Для мониторов типа STOREFRONT, storename — это необязательный аргумент, определяющий имя магазина службы storefront. Применимо к STOREFRONT мониторам.Минимальная длина = 1 | |
| successretries - | Количество последовательных успешных зондов, необходимых для перевода состояния службы из ВНЕ СТРОЯ в СТРОЕ. Минимальное значение = 1
Максимальное значение = 32
| |
| supportedvendorids - | Список пар атрибутов Supported-Vendor-Id для сообщения Capabilities-Exchange-Request (CER) для использования при мониторинге серверов Diameter. В сообщении мониторинга поддерживается не более восьми пар атрибутов. Минимальное значение = 1
Максимальное значение = 4294967295
| |
| tos boolean |
| Проверить службу путем кодирования IP-адреса назначения в битах TOS (6) IP. |
| tosid - | Идентификатор TOS указанного IP-адреса назначения. Применимо только при установке параметра TOS. Минимальное значение = 1
Максимальное значение = 63
|
| прозрачный boolean |
| Монитор подключен к прозрачному устройству, такому как брандмауэр или маршрутизатор. Состояние прозрачного устройства зависит от отзывчивости служб за ним. Если мониторится прозрачное устройство, необходимо указать IP-адрес назначения. Зонд отправляется на указанный IP-адрес, используя MAC-адрес прозрачного устройства. |
| trofscode - | Код, ожидаемый, когда сервер находится в режиме технического обслуживания. | |
| trofsstring - | Строка, ожидаемая от сервера для обозначения службы как trofs. Применимо к мониторам HTTP-ECV/TCP-ECV. | |
| type - |
| Тип монитора, который вы хотите создать. |
| units1 - |
| Единица измерения для параметра Отклонение. Не может быть изменена после создания монитора. |
| units2 - |
| Единица измерения для параметра Время простоя. Не может быть изменена после создания монитора. |
| units3 - |
| Единицы интервала мониторинга. |
| units4 - |
| Единицы времени ожидания ответа монитора. |
| username - | Имя пользователя для проверки 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 не будут проверены. Это следует использовать только на сайтах, управляемых лично, с использованием самозаверенных сертификатов. |
| validatecred boolean |
| Проверять учетные данные пользователя сервера Xen Desktop DDC. Применимо к мониторам типа CITRIX-XD-DDC. |
| vendorid - | Значение Vendor-Id для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter. | |
| vendorspecificacctapplicationids - | Список пар атрибутов и значений Vendor-Specific-Acct-Application-Id (AVPs) для мониторинга серверов Diameter. В сообщении мониторинга поддерживается максимум восемь таких AVP. Указанное значение комбинируется со значением vendorSpecificVendorId для получения Vendor-Specific-Application-Id AVP в сообщении мониторинга CER. Минимальное значение = 0Максимальное значение = 4294967295 | |
| vendorspecificauthapplicationids - | Список пар атрибутов и значений Vendor-Specific-Auth-Application-Id (AVPs) для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter. В сообщении мониторинга поддерживается максимум восемь таких AVP. Указанное значение комбинируется со значением vendorSpecificVendorId для получения Vendor-Specific-Application-Id AVP в сообщении мониторинга CER. Минимальное значение = 0Максимальное значение = 4294967295 | |
| vendorspecificvendorid - | Vendor-Id, используемый в группе атрибутов и значений Vendor-Specific-Application-Id (AVP) в сообщении мониторинга CER. Для указания Auth-Application-Id или Acct-Application-Id в Vendor-Specific-Application-Id используйте соответственно vendorSpecificAuthApplicationIds или vendorSpecificAcctApplicationIds. Для всех AVP Vendor-Specific-Application-Id в сообщении мониторинга CER поддерживается только один Vendor-Id. Минимальное значение = 1 |
Примечания
Примечание
- Для получения дополнительной информации об использовании Ansible для управления устройствами сети Citrix NetScaler см. https://www.ansible.com/ansible-netscaler.
Примеры
- name: Set lb monitor
local_action:
nsip: 172.18.0.2
nitro_user: nsroot
nitro_pass: nsroot
validate_certs: no
module: netscaler_lb_monitor
state: present
monitorname: monitor_1
type: HTTP-INLINE
action: DOWN
respcode: ['400']
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| diff словарь | неудача | Список различий между фактически настроенным объектом и конфигурацией, указанной в модуле Пример: {'targetlbvserver': 'различие. наше: (строка) server1 другое: (строка) server2'} |
| loglines список | всегда | список зарегистрированных сообщений модуля Пример: ['сообщение 1', 'сообщение 2'] |
| msg строка | неудача | Сообщение, подробно описывающее причину неудачи Пример: Действия не существует |
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Георгий Николопулос (@giorgos-nikolopoulos)
Подсказка
Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/netscaler_lb_monitor_module.html