community.network.netscaler_lb_monitor – Управление мониторами балансировки нагрузки
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в плейбуке укажите: community.network.netscaler_lb_monitor.
Описание
- Управление мониторами балансировки нагрузки.
- Этот модуль предназначен для выполнения на контрольном узле ansible или бастионе (шлюзе) с доступом к фактической инстанции netscaler.
Требования
Ниже перечислены требования, необходимые на узле, на котором выполняется этот модуль.
- nitro python sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| acctapplicationid строка | Список пар атрибутов значения (AVP) Acct-Application-Id для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter. В сообщении о мониторинге поддерживается не более восьми таких AVP. Минимальное значение = 0
Максимальное значение = 4294967295
| |
| action строка |
| Действие, которое выполняется при получении ответа от встроенного монитора (монитора типа HTTP-INLINE) о том, что сервис недоступен. Сервис, отслеживаемый встроенным монитором, считается недоступным, если код ответа не совпадает с кодами, указанными для параметра Response Code.Доступные настройки работают следующим образом: * 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) Auth-Application-Id для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter. В сообщении о мониторинге CER поддерживается не более восьми таких AVP. Минимальное значение = 0
Максимальное значение = 4294967295
| |
| basedn строка | Базовое имя с различиями службы LDAP, с которого сервер LDAP может начать поиск атрибутов в запросе мониторинга. Требуется для мониторинга сервисов LDAP. Минимальная длина = 1 | |
| binddn строка | Имя с различиями, которое монитор 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) или серверы веб-интерфейса. Требуется мониторами CITRIX-XD-DDC и CITRIX-WI-EXTENDED для входа на серверы DDC и серверы веб-интерфейса соответственно. | |
| downtime строка | Продолжительность ожидания перед зондированием сервиса, помеченного как DOWN. Выражается в миллисекундах, секундах или минутах. Минимальное значение = 1
Максимальное значение = 20939
| |
| evalrule строка | Выражение по умолчанию, которое оценивает ответ сервера базы данных на запрос MYSQL-ECV или MSSQL-ECV мониторинга. Должно возвращать булево значение. Результат определяет состояние сервера. Если выражение возвращает TRUE, зондирование успешно. Например, если вы хотите, чтобы устройство оценивало сообщение об ошибке для определения состояния сервера, используйте правило MYSQL.RES.ROW(10 .TEXT_ELEM(2).EQ("MySQL")). | |
| failureretries строка | Количество неудачных попыток, которые должны произойти из числа указанных в параметре Retries, чтобы сервис был помечен как DOWN. Например, если параметр Retries установлен в 10, а параметр Failure Retries в 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 строка | Интервал времени между двумя последовательными зондами. Должен быть больше значения Response Time-out. Минимальное значение = 1
Максимальное значение = 20940
| |
| ipaddress строка | Набор IP-адресов, ожидаемых в ответе мониторинга от DNS-сервера, если тип записи A или AAAA. Применимо к мониторам DNS. Минимальная длина = 1 | |
| iptunnel булево |
| Отправить зонд мониторинга в службу через IP-туннель. Требуется указать адрес назначения. |
| kcdaccount строка | Аккаунт KCD, используемый монитором MSSQL. Минимальная длина = 1 Максимальная длина = 32 | |
| lasversion строка | Номер версии агента входа Citrix Advanced Access Control Logon. Требуется монитором 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-идентификатор для отправки в пакете запроса доступа. Применимо к мониторам типа 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 логический |
| Отметить службу как НЕАКТИВНУЮ вместо АКТИВНОЙ, когда критерии зонда выполнены, и как АКТИВНУЮ вместо НЕАКТИВНОЙ, когда критерии зонда не выполнены. |
| 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 |
"present" | Состояние монитора. Параметр disabled отключает не только настраиваемый монитор, но и все мониторы того же типа, пока параметр не будет установлен в значение enabled. Если монитор связан со службой, состояние монитора не учитывается при определении состояния службы. |
| storedb string |
| Сохранить список баз данных, заполненный ответами на запросы монитора. Используется в балансировке нагрузки, специфичной для базы данных, если настроен монитор MSSQL-ECV/MYSQL-ECV. |
| storefrontacctservice boolean |
| Включить/отключить зондирование службы Учётной записи. Применимо только к мониторам Store Front. Для конфигурации с несколькими арендаторами пользователи могут пропустить службу учёта. |
| storefrontcheckbackendservices boolean |
| Этот параметр включит мониторинг служб, работающих на сервере магазина. Службы магазина отслеживаются путём зондирования к службе Windows, которая работает на сервере магазина и предоставляет информацию о том, какие службы магазина работают. |
| storename string | Имя магазина. Для мониторов типа STOREFRONT, storename — необязательный аргумент, определяющий имя магазина для службы магазина магазина. Применимо к мониторам 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 для получения значения атрибута Vendor-Specific-Application-Id в сообщении мониторинга CER. Минимальное значение = 0Максимальное значение = 4294967295 |
| vendorspecificauthapplicationids строка | Список пар атрибут-значение (AVP) Vendor-Specific-Auth-Application-Id для сообщения Capabilities-Exchange-Request (CER), используемого для мониторинга серверов Diameter. В сообщении мониторинга поддерживается максимум восемь таких пар AVP. Указанное значение комбинируется со значением vendorSpecificVendorId для получения значения AVP Vendor-Specific-Application-Id в сообщении мониторинга CER. Минимальное значение = 0
Максимальное значение = 4294967295
| |
| vendorspecificvendorid строка | Идентификатор поставщика, используемый в группе пар атрибут-значение (AVP) Vendor-Specific-Application-Id в сообщении мониторинга CER. Для указания Auth-Application-Id или Acct-Application-Id в Vendor-Specific-Application-Id используйте соответственно vendorSpecificAuthApplicationIds или vendorSpecificAcctApplicationIds. В сообщении мониторинга CER поддерживается только один Идентификатор поставщика для всех AVP Vendor-Specific-Application-Id. Минимальное значение = 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 строка | ошибка | Сообщение, содержащее причину ошибки Пример: Действие не существует |
Авторы
- Джордж Николопулос (@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.10/collections/community/network/netscaler_lb_monitor_module.html