community.network.netscaler_lb_monitor – Управление мониторами балансировки нагрузки
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network
Для использования в книге задач укажите: community.network.netscaler_lb_monitor
Обзор
- Управление мониторами балансировки нагрузки.
- Этот модуль предназначен для запуска на узле управления Ansible или бастионе (шлюзе) с доступом к фактическому экземпляру Netscaler.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- nitro python sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| acctapplicationid строка | Список пар атрибутов Значение-ID приложения Аккаунта (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 строка | Список пар атрибутов Значение-ID приложения Аутентификации (AVP) для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter. В сообщении мониторинга CER поддерживается максимум восемь таких AVP. Минимальное значение = 0Максимальное значение = 4294967295 | |
| basedn строка | Базовое имя с разделителями (Distinguished Name) LDAP-службы, откуда сервер LDAP может начать поиск атрибутов в запросе мониторинга. Требуется для мониторинга сервисов LDAP.Минимальная длина = 1 | |
| binddn строка | Имя с разделителями (Distinguished Name), с помощью которого монитор LDAP может выполнить операцию Bind на сервере LDAP. Необязательно. Применимо к мониторам LDAP.Минимальная длина = 1 | |
| customheaders строка | Пользовательская строка заголовков для включения в запросы мониторинга. | |
| database строка | Имя базы данных, с которой необходимо подключиться во время аутентификации. Минимальная длина = 1 | |
| destip строка | IP-адрес службы, на который будут отправляться запросы. Если параметр установлен в 0, IP-адрес сервера, к которому подключен монитор, считается адресом назначения. | |
| destport строка | Порт TCP или UDP, на который нужно отправить запрос. Если параметр установлен в 0, номер порта службы, к которой подключен монитор, считается портом назначения. Однако для мониторинга типа USER, порт назначения — это номер порта, который включен в HTTP-запрос, отправленный диспетчеру. Не относится к мониторам типа PING. | |
| deviation строка | Значение времени, добавляемое к усреднённому времени ответа при динамическом мониторинге времени ответа (DRTM). При указании отклонения устройство определяет среднее время ответа связанных служб и добавляет отклонение к среднему. Затем конечное значение постоянно корректируется для учёта изменений времени ответа со временем. Указывается в миллисекундах, секундах или минутах. Минимальное значение = 0Максимальное значение = 20939 | |
| dispatcherip строка | IP-адрес диспетчера, на который нужно отправить запрос. | |
| dispatcherport строка | Номер порта на диспетчере, который слушает запрос мониторинга. | |
| domain строка | Домен, в котором находятся серверы XenDesktop Desktop Delivery Controller (DDC) или серверы Web Interface. Требуется для мониторинга CITRIX-XD-DDC и CITRIX-WI-EXTENDED соответственно для входа на серверы DDC и серверы Web Interface. | |
| downtime строка | Продолжительность времени ожидания перед зондированием службы, помеченной как DOWN. Выражается в миллисекундах, секундах или минутах. Минимальное значение = 1Максимальное значение = 20939 | |
| evalrule строка | Стандартное выражение синтаксиса, оценивающее ответ сервера базы данных на запрос мониторинга MYSQL-ECV или MSSQL-ECV. Должно возвращать логическое значение. Результат определяет состояние сервера. Если выражение возвращает TRUE, зондирование успешно. Например, если вы хотите, чтобы устройство оценивало сообщение об ошибке для определения состояния сервера, используйте правило MYSQL.RES.ROW(10 .TEXT_ELEM(2).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-запрос для получения названия новостной группы и оценивает ответ. Если новостная группа найдена на сервере, служба отмечается как ВКЛЮЧЕНА. Если новостной группы не существует или поиск завершается неудачно, служба отмечается как ВЫКЛЮЧЕНА. Применимо к 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 булево |
| Отправлять запрос мониторинга на службу через IP-туннель. Требуется указать адрес назначения. |
| kcdaccount строка | KCD-аккаунт, используемый монитором MSSQL.Минимальная длина = 1 Максимальная длина = 32 | |
| lasversion строка | Номер версии Citrix Advanced Access Control Logon Agent. Требуется для монитора CITRIX-AAC-LAS. |
| logonpointname строка | Имя точки входа в систему, настроенной для программного обеспечения Citrix Access Gateway Advanced Access Control. Требуется, если вы хотите отслеживать связанную страницу входа или Logon Agent. Применимо к мониторам 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 строка / обязательно | Пароль для аутентификации на узле netscaler. | |
| nitro_protocol строка |
| Протокол для доступа к объектам API nitro. |
| nitro_timeout вещественное число | По умолчанию: 310 | Время в секундах до таймаута при установлении нового сеанса с Netscaler |
| nitro_user строка / обязательно | Имя пользователя для аутентификации на узле netscaler. | |
| nsip строка / обязательно | 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 выполняют действие, указанное в параметре Действие. | |
| resptimeout строка | Время ожидания устройства перед тем, как оно пометит зонд как НЕУСПЕШНЫЙ. Должно быть меньше значения, указанного для параметра Интервал. Примечание: для мониторов UDP-ECV без настроенной строки получения таймаут ответа не применяется. Для мониторов UDP-ECV без строки получения ошибка отказа зонда указывается ICMP-ошибкой недоступности порта, полученной от службы.Минимальное значение = 1
Максимальное значение = 20939
| |
| resptimeoutthresh строка | Пороговое значение времени ответа, указанное в процентах от параметра Таймаута ответа. Если ответ на запрос монитора не получен при достижении порога, устройство генерирует SNMP-ловушку monRespTimeoutAboveThresh. После того, как время ответа вернётся к значению ниже порога, устройство генерирует SNMP-ловушку monRespTimeoutBelowThresh. Для генерации ловушек также должен быть включён тревожный сигнал «MONITOR-RTO-THRESHOLD». Минимальное значение = 0
Максимальное значение = 100
| |
| retries строка | Максимальное количество зондов, которые отправляются для установления состояния службы, для которой запрос мониторинга не удался. Минимальное значение = 1
Максимальное значение = 127
| |
| reverse булево |
| Помечать службу как НЕАКТИВНУЮ вместо АКТИВНОЙ, когда критерии зонда удовлетворены, и как ВКЛЮЧЁННУЮ вместо НЕАКТИВНОЙ, когда критерии зонда не удовлетворены. |
| rtsprequest строка | RTSP-запрос, который нужно отправить на сервер (например, "OPTIONS *"). | |
| save_config булево |
| Если yes, модуль сохранит конфигурацию на узле netscaler, если внесёт изменения.Если модуль не вносил изменений, конфигурация на узле netscaler не сохранится. |
| scriptargs строка | Строка аргументов для скрипта. Строка копируется дословно в запрос. | |
| scriptname строка | Путь и имя скрипта для выполнения. Скрипт должен быть доступен на устройстве NetScaler в каталоге /nsconfig/monitors/. Минимальная длина = 1 |
| secondarypassword string | Дополнительный пароль, который пользователи могут потребоваться предоставить для входа на сервер шлюза доступа. Применимо к мониторам CITRIX-AG. | |
| secure boolean |
| Использовать защищенное подключение SSL при мониторинге сервиса. Применимо только к мониторам на основе TCP. Параметр secure не может быть использован с монитором CITRIX-AG, так как монитор CITRIX-AG использует защищенное соединение по умолчанию. |
| send string | Строка, отправляемая сервису. Применимо к мониторам TCP-ECV, HTTP-ECV, и UDP-ECV. | |
| sipmethod string |
| Метод SIP, используемый для запроса. Применимо только к мониторам типа SIP-UDP. |
| 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. |
| sqlquery string | SQL-запрос для монитора MYSQL-ECV или MSSQL-ECV. Отправляется на сервер базы данных после аутентификации подключения сервером.Минимальная длина = 1 | |
| state string |
"включено" | Состояние монитора. Настройка disabled отключает не только настраиваемый монитор, но и все мониторы того же типа, пока параметр не будет установлен на enabled. Если монитор связан со службой, состояние монитора не учитывается при определении состояния службы. |
| storedb string |
| Хранить список баз данных, заполненный ответами на запросы монитора. Используется в балансировке нагрузки, специфичной для базы данных, если настроен монитор MSSQL-ECV/MYSQL-ECV. |
| storefrontacctservice boolean |
| Включить/выключить зондирование службы учетных записей. Применимо только к мониторам Store Front. При конфигурации многопользовательской системы пользователи могут пропустить службу учетных записей. |
| storefrontcheckbackendservices boolean |
| Этот параметр позволит включить мониторинг служб, работающих на сервере storefront. Сервисы storefront отслеживаются путем зондирования Windows-службы, работающей на сервере storefront, и предоставляющей подробную информацию о работающих сервисах storefront. |
| storename string | Название магазина. Для мониторов типа STOREFRONT, storename — это необязательный аргумент, определяющий имя магазина storefront-службы. Применимо к мониторам STOREFRONT.Минимальная длина = 1 | |
| successretries string | Количество последовательных успешных зондирований, необходимых для перевода состояния службы из DOWN в UP. Минимальное значение = 1
Максимальное значение = 32
| |
| supportedvendorids string | Список пар значений атрибутов Supported-Vendor-Id для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter. В сообщении мониторинга поддерживается максимум восемь таких AVP. Минимальное значение = 1
Максимальное значение = 4294967295
| |
| tos boolean |
| Зондирование сервиса путем кодирования IP-адреса назначения в битах TOS (6) IP. |
| tosid string | Идентификатор TOS указанного IP-адреса назначения. Применимо только при установке параметра TOS. Минимальное значение = 1
Максимальное значение = 63
| |
| transparent boolean |
| Монитор привязан к прозрачному устройству, такому как брандмауэр или маршрутизатор. Состояние прозрачного устройства зависит от отзывчивости сервисов, находящихся за ним. Если мониторится прозрачное устройство, необходимо указать IP-адрес назначения. Зондирование отправляется на указанный IP-адрес с использованием MAC-адреса прозрачного устройства. |
| trofscode string | Код, ожидаемый, когда сервер находится в режиме технического обслуживания. | |
| trofsstring string | Строка, ожидаемая от сервера, чтобы отметить службу как trofs. Применимо к мониторам HTTP-ECV/TCP-ECV. | |
| type string |
| Тип монитора, который вы хотите создать. |
| units1 string |
| Единица измерения для параметра Отклонение. Не может быть изменена после создания монитора. |
| units2 string |
| Единица измерения для параметра Время простоя. Не может быть изменена после создания монитора. |
| units3 string |
| Единицы измерения интервала мониторинга. |
| units4 string |
| Единицы измерения таймаута ответа монитора. |
| 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 не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов. |
| validatecred boolean |
| Проверить учетные данные пользователя сервера Xen Desktop DDC. Применимо к мониторам типа CITRIX-XD-DDC. |
| vendorid string | Значение Vendor-Id для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter. | |
| vendorspecificacctapplicationids string | Список пар значений атрибутов Vendor-Specific-Acct-Application-Id для мониторинга серверов Diameter. Поддерживается максимум восемь таких AVP в сообщении мониторинга. Указанное значение объединяется со значением vendorSpecificVendorId для получения AVP Vendor-Specific-Application-Id в сообщении мониторинга CER. Минимальное значение = 0
Максимальное значение = 4294967295
|
| vendorspecificauthapplicationids string | Список пар атрибут-значение Vendor-Specific-Auth-Application-Id (AVPs) для сообщения Capabilities-Exchange-Request (CER), используемого для мониторинга серверов Diameter. В сообщении мониторинга поддерживается максимум восемь таких пар AVP. Указанное значение комбинируется со значением vendorSpecificVendorId для получения значения Vendor-Specific-Application-Id AVP в сообщении мониторинга CER. Минимальное значение = 0
Максимальное значение = 4294967295
| |
| vendorspecificvendorid string | Идентификатор поставщика, используемый в паре атрибут-значение (AVP) Vendor-Specific-Application-Id в сообщении мониторинга CER. Для указания Auth-Application-Id или Acct-Application-Id в Vendor-Specific-Application-Id используйте vendorSpecificAuthApplicationIds или vendorSpecificAcctApplicationIds соответственно. Для всех AVP Vendor-Specific-Application-Id в сообщении мониторинга CER поддерживается только один идентификатор поставщика. Минимальное значение = 1 |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Citrix NetScaler Network см. на странице 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 строка | ошибка | Сообщение, содержащее причину ошибки Пример: Действия не существует |
Авторы
- George Nikolopoulos (@giorgos-nikolopoulos)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/netscaler_lb_monitor_module.html