netscaler_lb_monitor - Управление мониторами балансировки нагрузки
Новая версия с 2.4.
Описание
- Управление мониторами балансировки нагрузки.
- Этот модуль предназначен для запуска либо на контрольном узле ansible, либо на бастионе (шлюзе) с доступом к фактической инстанции 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. В сообщении мониторинга 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 | Продолжительность ожидания перед повторной проверкой службы, которая была отмечена как ВЫКЛЮЧЕНА. Указывается в миллисекундах, секундах или минутах. Минимальное значение = 1
Максимальное значение = 20939
| |
| evalrule | Стандартное выражение синтаксиса, которое оценивает ответ сервера базы данных на запрос мониторинга MYSQL-ECV или MSSQL-ECV. Должно возвращать булево значение. Результат определяет состояние сервера. Если выражение возвращает ИСТИНА, запрос успешен. Например, если вы хотите, чтобы устройство оценивало сообщение об ошибке для определения состояния сервера, используйте правило MYSQL.RES.ROW(10 .TEXT_ELE2.EQ("MySQL")). | |
| failureretries | Количество неудачных попыток, которые должны произойти из числа указанных для параметра Повторные попытки, для того чтобы служба была отмечена как ВЫКЛЮЧЕНА. Например, если параметр Повторные попытки установлен в 10, а параметр Повторные попытки сбоя — в 6, то из 10 отправленных запросов минимум 6 должны завершиться неудачей, чтобы служба была отмечена как ВЫКЛЮЧЕНА. Значение по умолчанию 0 означает, что все попытки должны быть неудачными, чтобы служба была отмечена как ВЫКЛЮЧЕНА. Минимальное значение = 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 bool |
| Отправить запрос мониторинга на службу через 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 выполняют действие, указанное в параметре Action. | |
| resptimeout | Время ожидания устройства перед отметкой зонда как НЕУСПЕШНОГО. Должно быть меньше значения, указанного для параметра Interval. Примечание: Для мониторов UDP-ECV для которых не настроена строка приема, таймаут ответа не применяется. Для мониторов UDP-ECV без строки приема сбой зонда обозначается ошибкой ICMP недоступности порта, полученной от службы.Минимальное значение = 1
Максимальное значение = 20939
| |
| resptimeoutthresh | Пороговое значение времени ответа, заданное в процентах от параметра Response Timeout. Если ответ на запрос монитора не прибыл, когда достигнуто значение порога, устройство генерирует SNMP-ловушку monRespTimeoutAboveThresh. После того, как время ответа вернется к значению ниже порога, устройство генерирует SNMP-ловушку monRespTimeoutBelowThresh. Для генерации ловушек также должна быть включена тревога "MONITOR-RTO-THRESHOLD". Минимальное значение = 0
Максимальное значение = 100
| |
| retries | Максимальное количество зондов для отправки, чтобы установить состояние службы, для которой сбой зонда мониторинга. Минимальное значение = 1
Максимальное значение = 127
| |
| reverse bool |
| Отметить службу как НЕАКТИВНУЮ, вместо АКТИВНОЙ, когда критерии зондирования выполнены, и как АКТИВНУЮ вместо НЕАКТИВНОЙ, когда критерии зондирования не выполнены. |
| rtsprequest | Запрос RTSP, который необходимо отправить на сервер (например, "OPTIONS *"). | |
| save_config bool |
| Если значение true, модуль сохранит конфигурацию на узле netscaler, если внесёт какие-либо изменения. Модуль не сохранит конфигурацию на узле netscaler, если не внес никаких изменений. |
| scriptargs | Строка аргументов для скрипта. Строка копируется дословно в запрос. | |
| scriptname | Путь и имя исполняемого скрипта. Скрипт должен быть доступен на устройстве NetScaler в каталоге /nsconfig/monitors/. Минимальная длина = 1 | |
| secondarypassword | Дополнительный пароль, который пользователи могут потребоваться предоставить для входа на сервер Access Gateway. Применимо к мониторам CITRIX-AG. | |
| secure bool |
| Использовать безопасное 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 |
"present" | Состояние монитора. Параметр disabled отключает не только настраиваемый монитор, но и все мониторы того же типа, пока параметр не будет установлен в значение enabled. Если монитор привязан к службе, состояние монитора не учитывается при определении состояния службы. |
| storedb |
| Сохранить список базы данных, заполненный ответами на запросы монитора. Используется в балансировке нагрузки, специфичной для базы данных, если настроен монитор типа MSSQL-ECV/MYSQL-ECV. |
| storefrontacctservice bool |
| Включить/выключить зондирование службы Account Service. Применимо только к мониторам Store Front. Пользователи с конфигурацией многопользовательских систем могут пропустить службу учетных данных. |
| storefrontcheckbackendservices bool |
| Этот параметр включит мониторинг служб, работающих на сервере 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 bool |
| Зондирование службы с кодировкой адреса назначения IP в битах IP TOS (6). |
| tosid | Идентификатор TOS указанного адреса назначения IP. Применимо только при установленном параметре TOS. Минимальное значение = 1.
Максимальное значение = 63.
| |
| transparent bool |
| Монитор привязан к прозрачному устройству, например, брандмауэру или маршрутизатору. Состояние прозрачного устройства зависит от отзывчивости служб за ним. Если мониторится прозрачное устройство, необходимо указать адрес назначения 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 | По умолчанию: "yes" | Если no, сертификаты SSL не будут проверяться. Это следует использовать только на сайтах, контролируемых лично, использующих самозаверяемые сертификаты. |
| validatecred bool |
| Проверить учетные данные пользователя сервера 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 для мониторинга серверов Diameter. В сообщении мониторинга поддерживается максимум восемь таких пар атрибутов. Указанное значение объединяется со значением vendorSpecificVendorId, чтобы получить значение Vendor-Specific-Application-Id в сообщении мониторинга CER. Минимальное значение = 0.
Максимальное значение = 4294967295.
| |
| vendorspecificvendorid | Vendor-Id для использования в атрибуте Vendor-Specific-Application-Id в группе пар атрибут-значение (AVP) в сообщении мониторинга CER. Для указания Auth-Application-Id или Acct-Application-Id в Vendor-Specific-Application-Id используйте vendorSpecificAuthApplicationIds или vendorSpecificAcctApplicationIds соответственно. Для всех пар атрибутов Vendor-Specific-Application-Id в сообщении мониторинга CER поддерживается только один Vendor-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 dict | ошибка | Список различий между фактически настроенным объектом и конфигурацией, указанной в модуле Пример: {'targetlbvserver': 'различие. наше: (str) server1 другое: (str) server2'} |
| loglines list | всегда | Список зарегистрированных сообщений модулем Пример: ['сообщение 1', 'сообщение 2'] |
| msg str | ошибка | Сообщение, подробно описывающее причину ошибки Пример: Действие не существует |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- George Nikolopoulos (@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.6/modules/netscaler_lb_monitor_module.html