netscaler_lb_monitor - Управление мониторами балансировки нагрузки

Новая версия с 2.4.

Описание
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Описание

Управление мониторами балансировки нагрузки.
Этот модуль предназначен для работы либо на узле управления Ansible, либо на бастионе (шлюзе) с доступом к фактическому экземпляру netscaler.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

nitro python sdk

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
acctapplicationid		Список пар атрибутов значения (AVP) Acct-Application-Id для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter. Максимальное количество таких AVP в сообщении мониторинга — восемь. Минимальное значение = `0` Максимальное значение = `4294967295`
action	Варианты: NONE LOG DOWN	Действие, выполняемое при получении ответа от встроенного монитора (монитор типа `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) Auth-Application-Id для сообщения 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 Desktop Delivery Controller (DDC) или серверы веб-интерфейса. Требуется для мониторов `CITRIX-XD-DDC` и `CITRIX-WI-EXTENDED` соответственно для входа на серверы DDC и серверы веб-интерфейса.
downtime		Время ожидания перед зондированием службы, которая была помечена как DOWN. Выражается в миллисекундах, секундах или минутах. Минимальное значение = `1` Максимальное значение = `20939`
evalrule		Умолчание синтаксического выражения, которое оценивает ответ сервера базы данных на запрос мониторинга MYSQL-ECV или MSSQL-ECV. Должно выдавать логический результат. Результат определяет состояние сервера. Если выражение возвращает TRUE, зондирование выполняется успешно. Например, если вы хотите, чтобы устройство оценивало сообщение об ошибке для определения состояния сервера, используйте правило `MYSQL.RES.ROW(10` .TEXT_ELE2.EQ("MySQL")).
failureretries		Количество попыток, которые должны завершиться неудачей (из числа указанных для параметра 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	Варианты: NO_INBAND_SECURITY TLS	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 software. Требуется, если необходимо отслеживать связанную страницу входа или агент входа. Применимо к мониторам `CITRIX-AAC-LAS` и `CITRIX-AAC-LOGINPAGE`.
lrtm	Варианты: включено выключено	Вычисление наименьших времен ответа для связанных служб. Если этот параметр не включен, устройство не определяет времен ответа связанных служб. Также используется для балансировки нагрузки LRTM.
maxforwards		Максимальное количество хопов, которые может пройти SIP-запрос, используемый для мониторинга, для достижения сервера. Применимо только к мониторам типа `SIP-UDP`. Минимальное значение = `0` Максимальное значение = `255`

END_OF_DOCUMENT_MARKER

metrictable		Таблица метрик, к которой привязать метрики. Минимальная длина = 1 Максимальная длина = 99
monitorname		Имя монитора. Должно начинаться с символа ASCII буквенно-цифрового или подчеркивания `_`, и должно содержать только символы ASCII буквенно-цифрового, подчеркивания, решётки `#`, точки `.`, пробела, двоеточия `:`, знака @ `@`, знака равно `=`, и дефиса `-`. Минимальная длина = 1
mssqlprotocolversion	Варианты: 70 2000 2000SP1 2005 2008 2008R2 2012 2014	Версия сервера MSSQL, который необходимо отслеживать.
netprofile		Имя сетевого профиля. Минимальная длина = 1 Максимальная длина = 127
nitro_pass обязательно		Пароль для аутентификации на узле Netscaler.
nitro_protocol	Варианты: http ← https	Протокол для доступа к объектам 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	Варианты: Адрес Зона AAAA	Тип записи 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-адрес сетевого доступа сервера (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	Варианты: нет да ←	Если значение 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	Варианты: OPTIONS INVITE REGISTER	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	Choices: V1 V2	Версия SNMP для использования `SNMP` мониторами.
sqlquery		SQL запрос для `MYSQL-ECV` или `MSSQL-ECV` монитора. Отправляется на сервер базы данных после аутентификации сервера. Минимальная длина = 1
state	Choices: enabled disabled По умолчанию: present	Состояние монитора. Параметр `disabled` отключает не только настроенный монитор, но и все мониторы того же типа, пока параметр не будет установлен в `enabled`. Если монитор привязан к службе, состояние монитора не учитывается при определении состояния службы.
storedb	Choices: enabled disabled	Сохранить список базы данных, заполненный ответами на запросы монитора. Используется в балансировке нагрузки, специфичной для базы данных, если настроен монитор `MSSQL-ECV`/`MYSQL-ECV`.
storefrontacctservice	Choices: no yes	Включить/выключить проверку службы учёта. Применимо только к мониторам Store Front. Для многопользовательской конфигурации пользователи могут пропустить службу учёта.
storefrontcheckbackendservices	Choices: no yes	Этот параметр включит мониторинг служб, работающих на сервере storefront. Сервисы storefront контролируются путём запроса к службе Windows, работающей на сервере storefront и предоставляющей информацию о том, какие сервисы storefront запущены.
storename		Имя магазина. Для мониторов типа `STOREFRONT`, `storename` — это необязательный аргумент, определяющий имя магазина storefront-службы. Применимо к мониторам `STOREFRONT`. Минимальная длина = 1
successretries		Количество последовательных успешных запросов, необходимых для перевода состояния службы из DOWN в UP. Минимальное значение = `1` Максимальное значение = `32`
supportedvendorids		Список поддерживаемых значений атрибута Supported-Vendor-Id (AVP) для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter. В сообщении мониторинга поддерживается максимальное количество восемь таких AVP. Минимальное значение = `1` Максимальное значение = `4294967295`
tos	Choices: no yes	Проверить службу, закодировав IP-адрес назначения в битах IP TOS (6).
tosid		Идентификатор TOS указанного IP-адреса назначения. Применимо только при установке параметра TOS. Минимальное значение = `1` Максимальное значение = `63`
transparent	Choices: no yes	Монитор связан с прозрачным устройством, таким как брандмауэр или маршрутизатор. Состояние прозрачного устройства зависит от отзывчивости служб за ним. Если мониторится прозрачное устройство, должен быть указан IP-адрес назначения. Запрос отправляется на указанный IP-адрес с использованием MAC-адреса прозрачного устройства.
trofscode		Код, ожидаемый при проведении технического обслуживания сервера.
trofsstring		Строка, ожидаемая от сервера для обозначения службы как трофс. Применимо к HTTP-ECV/TCP-ECV мониторам.
type	Choices: PING TCP HTTP TCP-ECV HTTP-ECV UDP-ECV DNS FTP LDNS-PING LDNS-TCP LDNS-DNS RADIUS USER HTTP-INLINE SIP-UDP SIP-TCP LOAD FTP-EXTENDED SMTP SNMP NNTP MYSQL MYSQL-ECV MSSQL-ECV ORACLE-ECV LDAP POP3 CITRIX-XML-SERVICE CITRIX-WEB-INTERFACE DNS-TCP RTSP ARP CITRIX-AG CITRIX-AAC-LOGINPAGE CITRIX-AAC-LAS CITRIX-XD-DDC ND6 CITRIX-WI-EXTENDED DIAMETER RADIUS_ACCOUNTING STOREFRONT APPC SMPP CITRIX-XNC-ECV CITRIX-XDM CITRIX-STA-SERVICE CITRIX-STA-SERVICE-NHOP	Тип монитора, который вы хотите создать.
units1	Choices: SEC MSEC MIN	Единица измерения параметра Отклонение. Не может быть изменена после создания монитора.
units2	Choices: SEC MSEC MIN	Единица измерения параметра Время простоя. Не может быть изменена после создания монитора.
units3	Choices: SEC MSEC MIN	Единицы измерения интервала мониторинга.
units4	Choices: SEC MSEC MIN	Единицы измерения таймаута ответа мониторинга.
username		Имя пользователя, используемое для проверки `RADIUS`, `NNTP`, `FTP`, `FTP-EXTENDED`, `MYSQL`, `MSSQL`, `POP3`, `CITRIX-AG`, `CITRIX-XD-DDC`, `CITRIX-WI-EXTENDED`, или `CITRIX-XDM` сервера. Минимальная длина = 1
validate_certs	По умолчанию: yes	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, находящихся под личным контролем, использующих самоподписанные сертификаты.
validatecred	Choices: no yes	Проверить учётные данные пользователя сервера Xen Desktop DDC. Применимо к мониторам типа `CITRIX-XD-DDC`.
vendorid		Значение Vendor-Id для сообщения Capabilities-Exchange-Request (CER) для мониторинга серверов Diameter.
vendorspecificacctapplicationids		Список пар атрибут-значение (AVP) 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 для получения значения Vendor-Specific-Application-Id в сообщении CER мониторинга. Минимальное значение = `0` Максимальное значение = `4294967295`
vendorspecificvendorid		Vendor-Id для использования в атрибуте-значении (AVP) Vendor-Specific-Application-Id в сообщении мониторинга CER. Для указания Auth-Application-Id или Acct-Application-Id в Vendor-Specific-Application-Id используйте vendorSpecificAuthApplicationIds или vendorSpecificAcctApplicationIds соответственно. Для всех Vendor-Specific-Application-Id AVP в сообщении CER мониторинга поддерживается только один Vendor-Id. Минимальное значение = 1

Примечания

Примечание

Для получения дополнительной информации об использовании Ansible для управления устройствами сети Citrix NetScaler см. https://www.ansible.com/ansible-netscaler.

Примеры

- name: Set lb monitor
  local_action:
    nsip: 172.18.0.2
    nitro_user: nsroot
    nitro_pass: nsroot
    validate_certs: no


    module: netscaler_lb_monitor
    state: present

    monitorname: monitor_1
    type: HTTP-INLINE
    action: DOWN
    respcode: ['400']

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое	Описание
diff dict	failure	Список различий между фактическим настроенным объектом и конфигурацией, указанной в модуле Пример: {'targetlbvserver': 'difference. ours: (str) server1 other: (str) server2'}
loglines list	всегда	Список сообщений, записанных модулем в журнал Пример: ['сообщение 1', 'сообщение 2']
msg str	failure	Сообщение, описывающее причину ошибки Пример: Действия не существует

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.

Автор

Джордж Николопулос (@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.5/modules/netscaler_lb_monitor_module.html