netscaler_lb_monitor - Управление мониторами балансировки нагрузки
Новая версия с 2.4.
Обзор
- Управление мониторами балансировки нагрузки.
- Этот модуль предназначен для выполнения либо на узле управления Ansible, либо на бастионе (прыжковом сервере) с доступом к фактической инстанции netscaler.
Требования (к хосту, на котором выполняется модуль)
- nitro python sdk
Параметры
| параметр | обязательный | по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| Snmpoid | нет | OID SNMP для SNMP мониторов.Минимальная длина = 1 | ||
| acctapplicationid | нет | Список пар атрибутов значения Acct-Application-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 | нет | Список пар атрибутов значения Auth-Application-Id (AVP) для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter. Максимальное количество этих AVP в сообщении мониторинга CER — восемь. Минимальное значение = 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 (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 | нет |
| Отправить зонд мониторинга на службу через 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 | нет | http |
| Протокол, используемый при доступе к объектам 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. Используется совместно с именем пользователя, указанным для параметра 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 (Network Access Server), отправляемый в пакете Access-Request. Применимо для мониторов типа RADIUS.Минимальная длина = 1 | ||
| radnasip | нет | IP-адрес сетевого доступа сервера (NAS), используемый в качестве исходного IP-адреса при мониторинге сервера RADIUS. Применимо для мониторов типа RADIUS и RADIUS_ACCOUNTING. | ||
| recv | нет | Строка, ожидаемая от сервера для обозначения сервиса как активного. Применимо для мониторов TCP-ECV, HTTP-ECV, и UDP-ECV. | ||
| respcode | нет | Коды ответов, при которых служба отмечается как активная. Для других кодов ответа действие зависит от типа монитора. Мониторы HTTP и RADIUS отмечают службу как DOWN, в то время как мониторы HTTP-INLINE выполняют действие, указанное в параметре Action. | ||
| resptimeout | нет | Время, в течение которого устройство должно ждать, прежде чем пометить зонд как НЕУСПЕШНЫЙ. Должно быть меньше значения, указанного для параметра Interval. Примечание: Для мониторов UDP-ECV, для которых не настроена строка приема, таймаут ответа не применяется. Для мониторов UDP-ECV без строки приема, отказ зонда обозначается ошибкой ICMP недоступности порта, полученной от сервиса.Минимальное значение = 1
Максимальное значение = 20939
| ||
| resptimeoutthresh | нет | Пороговое значение времени ответа, указанное в процентах от параметра Response Time-out. Если ответ на запрос мониторинга не поступит, когда будет достигнут порог, устройство генерирует SNMP-сигнал monRespTimeoutAboveThresh. После того, как время ответа вернется к значению ниже порога, устройство генерирует SNMP-сигнал monRespTimeoutBelowThresh. Для генерации сигналов также должна быть включена тревога «MONITOR-RTO-THRESHOLD». Минимальное значение = 0
Максимальное значение = 100
| ||
| retries | нет | Максимальное количество зондов, отправляемых для определения состояния службы, для которой зонд мониторинга завершился неудачно. Минимальное значение = 1
Максимальное значение = 127
| ||
| reverse | нет |
| Отметить службу как НЕАКТИВНУЮ вместо АКТИВНОЙ, когда критерии зонда удовлетворены, и как АКТИВНУЮ вместо НЕАКТИВНОЙ, когда критерии зонда не удовлетворены. | |
| rtsprequest | нет | RTSP-запрос, отправляемый на сервер (например, "OPTIONS *"). | ||
| save_config | нет | True |
| Если true, модуль сохранит конфигурацию на узле netscaler, если внесёт какие-либо изменения. Модуль не сохранит конфигурацию на узле netscaler, если не внес изменений. |
| scriptargs | нет | Строка аргументов для скрипта. Строка копируется дословно в запрос. | ||
| scriptname | нет | Путь и имя выполняемого скрипта. Скрипт должен быть доступен на устройстве NetScaler в каталоге /nsconfig/monitors/. Минимальная длина = 1 | ||
| secondarypassword | нет | Дополнительный пароль, который пользователи могут потребоваться ввести для входа на сервер шлюза доступа. Применимо для мониторов CITRIX-AG. | ||
| secure | нет |
| Использовать защищенное 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 | ||
| snmpthreshold | нет | Порог для мониторов SNMP. Минимальная длина = 1 | ||
| snmpversion | нет |
| Версия SNMP, которая должна использоваться для мониторов SNMP. | |
| sqlquery | нет | SQL-запрос для монитора MYSQL-ECV или MSSQL-ECV. Отправляется на сервер базы данных после аутентификации подключения сервером.Минимальная длина = 1 | ||
| state | нет |
| Состояние монитора. Настройка disabled отключает не только настраиваемый монитор, но и все мониторы того же типа, пока параметр не будет установлен в значение enabled. Если монитор привязан к службе, состояние монитора не учитывается при определении состояния службы. | |
| storedb | нет |
| Сохранить список баз данных, заполненный ответами на запросы монитора. Используется в балансировке нагрузки, специфичной для базы данных, если настроен монитор MSSQL-ECV/MYSQL-ECV. | |
| storefrontacctservice | нет |
| Включить/выключить зондирование для службы учетных записей. Применимо только к мониторам Store Front. Для многопользовательской конфигурации пользователи могут пропустить службу учетных записей. | |
| storefrontcheckbackendservices | нет |
| Этот параметр включит мониторинг служб, работающих на сервере storefront. Службы storefront отслеживаются путем зондирования службы Windows, которая работает на сервере Storefront и предоставляет сведения о работающих службах storefront. | |
| storename | нет | Имя магазина. Для мониторов типа STOREFRONT, storename — это необязательный аргумент, определяющий имя магазина службы storefront. Применимо к мониторам STOREFRONT.Минимальная длина = 1 | ||
| successretries | нет | Количество последовательных успешных зондирований, необходимых для перехода состояния службы с DOWN на UP. Минимальное значение = 1Максимальное значение = 32 | ||
| supportedvendorids | нет | Список пар значений атрибутов Supported-Vendor-Id для сообщения запроса обмена данными о возможностях (CER) для мониторинга серверов Diameter. В сообщении о мониторинге поддерживается максимум восемь таких атрибутов. Минимальное значение = 1Максимальное значение = 4294967295 | ||
| tos | нет |
| Зондирование службы путем кодирования IP-адреса назначения в битах IP TOS (6). | |
| tosid | нет | Идентификатор TOS указанного IP-адреса назначения. Применимо только в том случае, если параметр TOS установлен. Минимальное значение = 1Максимальное значение = 63 | ||
| transparent | нет |
| Монитор привязан к прозрачному устройству, такому как брандмауэр или маршрутизатор. Состояние прозрачного устройства зависит от отзывчивости служб за ним. Если мониторится прозрачное устройство, необходимо указать 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 | нет | да | Если no, сертификаты SSL не будут проверены. Это следует использовать только на управляемых вами сайтах, использующих самозаверяемые сертификаты. | |
| validatecred | нет |
| Проверить учетные данные пользователя сервера Xen Desktop DDC. Применимо к мониторам типа CITRIX-XD-DDC. | |
| vendorid | нет | Значение Vendor-Id для сообщения запроса обмена данными о возможностях (CER) для мониторинга серверов Diameter. | ||
| vendorspecificacctapplicationids | нет | Список пар значений атрибутов Vendor-Specific-Acct-Application-Id для мониторинга серверов Diameter. В сообщении о мониторинге поддерживается максимум восемь таких атрибутов. Указанное значение комбинируется со значением vendorSpecificVendorId для получения атрибута Vendor-Specific-Application-Id в сообщении CER мониторинга. Минимальное значение = 0Максимальное значение = 4294967295 | ||
| vendorspecificauthapplicationids | нет | Список пар значений атрибутов Vendor-Specific-Auth-Application-Id для сообщения запроса обмена данными о возможностях (CER) для мониторинга серверов Diameter. В сообщении о мониторинге поддерживается максимум восемь таких атрибутов. Указанное значение комбинируется со значением vendorSpecificVendorId для получения атрибута 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 соответственно. Для всех атрибутов Vendor-Specific-Application-Id в сообщении CER мониторинга поддерживается только один идентификатор поставщика. Минимальное значение = 1 |
Примеры
- 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 и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/netscaler_lb_monitor_module.html
