netscaler_lb_vserver – Управление конфигурацией балансировщика нагрузки vserver

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

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

Обзор

Управление конфигурацией балансировщика нагрузки vserver
Этот модуль предназначен для работы либо на контрольном узле ansible, либо на бастионе (шлюзе) с доступом к фактической инстанции netscaler

Требования

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

nitro python sdk

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
appflowlog -	Варианты: enabled disabled	Применить протоколирование AppFlow к виртуальному серверу.
authentication boolean	Варианты: no yes	Включить или выключить аутентификацию пользователя.
authenticationhost -		Полное доменное имя (FQDN) виртуального сервера аутентификации, на который пользователь должен быть перенаправлен для аутентификации. Убедитесь, что параметр Authentication установлен на `yes`. Минимальная длина = 3 Максимальная длина = 252
authn401 boolean	Варианты: no yes	Включить или выключить аутентификацию пользователя с ответами HTTP 401.
authnprofile -		Имя профиля аутентификации, которое будет использоваться при включенной аутентификации.
authnvsname -		Имя виртуального сервера аутентификации, который используется для аутентификации пользователей. Минимальная длина = 1 Максимальная длина = 252
backuplbmethod -	Варианты: ROUNDROBIN LEASTCONNECTION LEASTRESPONSETIME SOURCEIPHASH LEASTBANDWIDTH LEASTPACKETS CUSTOMLOAD	Метод резервного балансирования нагрузки. Становится активным, если метод первичного балансирования нагрузки выходит из строя или не может быть использован. Действителен только в случае, если первичный метод основан на статической близости.
backuppersistencetimeout -		Период времени, в течение которого действует резервное сохранение. Минимальное значение = `2` Максимальное значение = `1440`
bypassaaaa boolean	Варианты: no yes	Если этот параметр включен, при разрешении запроса DNS64 запросы AAAA не отправляются на сервер обратного DNS.
cacheable boolean	Варианты: no yes	Перенаправлять кешируемые запросы на виртуальный сервер перенаправления кэша. Виртуальный сервер балансировки нагрузки может пересылать запросы только на виртуальный сервер прозрачного перенаправления кэша, имеющий комбинацию IP-адреса и порта *:80, поэтому такой виртуальный сервер перенаправления кэша должен быть настроен на устройстве.
clttimeout -		Время простоя, в секундах, после которого соединение клиента закрывается. Минимальное значение = `0` Максимальное значение = `31536000`
comment -		Любые комментарии, которые вы хотите связать с виртуальным сервером.
connfailover -	Варианты: DISABLED STATEFUL STATELESS	Режим работы функции отключения соединения для виртуального сервера. После отключения соединения установленные TCP-соединения и потоки UDP-пакетов остаются активными и возобновляются на вторичном устройстве. Клиенты остаются подключенными к тем же серверам. Доступные параметры работают следующим образом: * `STATEFUL` - Первичное устройство обменивается информацией о состоянии со вторичным устройством в реальном времени, что приводит к некоторой вычислительной нагрузке во время работы. * `STATELESS` - Информация о состоянии не обменивается, и новое первичное устройство пытается повторно создать поток пакетов на основе информации, содержащейся в полученных им пакетах. * `DISABLED` - Отключение соединения не происходит.
cookiename -		Используйте этот параметр для указания имени cookie для типа сохранения `COOKIE`. Он указывает имя cookie с максимальной длиной 32 символа. Если не указано, имя cookie генерируется внутри.
datalength -		Длина токена, который необходимо извлечь из сегмента данных входящего пакета для использования в методе балансировки нагрузки по токену. Длина токена, указанная в байтах, не должна превышать 24 КБ. Применимо к виртуальным серверам типа TCP. Минимальное значение = `1` Максимальное значение = `100`
dataoffset -		Смещение, которое необходимо учитывать при извлечении токена из полезной нагрузки TCP. Применимо к виртуальным серверам типа TCP, использующим метод балансировки нагрузки по токену. Должно находиться в пределах первых 24 КБ полезной нагрузки TCP. Минимальное значение = `0` Максимальное значение = `25400`
dbprofilename -		Имя профиля базы данных, настройки которого необходимо применить к виртуальному серверу. Минимальная длина = 1 Максимальная длина = 127
dbslb -	Варианты: enabled disabled	Включить балансировку нагрузки, специфичную для базы данных, для типов сервисов MySQL и MSSQL.
disabled boolean	Варианты: нет ← да	При установке в `yes`, виртуальный сервер балансировки нагрузки будет отключен. При установке в `no`, виртуальный сервер балансировки нагрузки будет включен. Обратите внимание, что из-за ограничений базового API NITRO изменение состояния `disabled` не приводит к изменению статуса в модуле результата.
disableprimaryondown -	Варианты: enabled disabled	Если первичный виртуальный сервер выходит из строя, не разрешать ему возвращаться в первичное состояние до его ручного включения.
dns64 -	Варианты: enabled disabled	Этот аргумент предназначен для включения/выключения `dns64` на виртуальном сервере балансировки нагрузки.
dnsprofilename -		Имя профиля DNS, которое необходимо ассоциировать с виртуальным сервером. Свойства профиля DNS будут применяться к транзакциям, обрабатываемым виртуальным сервером. Этот параметр действителен только для виртуальных серверов DNS и DNS-TCP. Минимальная длина = 1 Максимальная длина = 127
downstateflush -	Варианты: enabled disabled	Очистить все активные транзакции, связанные с виртуальным сервером, при переходе его состояния из состояния UP в состояние DOWN. Не включайте этот параметр для приложений, которые должны завершить свои транзакции.
hashlength -		Количество байтов для расчета значения хеша, используемого в методах балансировки нагрузки URLHASH и DOMAINHASH. Минимальное значение = `1` Максимальное значение = `4096`
healththreshold -		Пороговое значение в процентах активных сервисов, ниже которого состояние виртуального сервера устанавливается в DOWN. Если этот порог равен 0, состояние виртуального сервера будет UP, даже если один из связанных сервисов находится в состоянии UP. Минимальное значение = `0` Максимальное значение = `100`
httpprofilename -		Имя профиля HTTP, настройки которого необходимо применить к виртуальному серверу. Минимальная длина = 1 Максимальная длина = 127

icmpvsrresponse -	Варианты: PASSIVE ACTIVE	Как устройство NetScaler отвечает на запросы пинга, полученные для IP-адреса, общего для одного или нескольких виртуальных серверов. Доступные настройки работают следующим образом: * Если на всех виртуальных серверах, разделяющих IP-адрес, установлено значение `PASSIVE`, устройство всегда отвечает на запросы пинга. * Если на всех виртуальных серверах, разделяющих IP-адрес, установлено значение `ACTIVE`, устройство отвечает на запросы пинга, если хотя бы один из виртуальных серверов активен. В противном случае устройство не отвечает. * Если на некоторых виртуальных серверах установлено значение `ACTIVE`, а на других — PASSIVE, устройство отвечает, если хотя бы один виртуальный сервер с настройкой ACTIVE активен. В противном случае устройство не отвечает. Примечание: Этот параметр доступен на уровне виртуального сервера. Аналогичный параметр, ICMP Response, доступен на уровне IP-адреса для IPv4-адресов типа VIP. Для установки этого параметра используйте команду add ip в командной строке или диалоговое окно «Создать IP» в графическом интерфейсе.
insertvserveripport -	Варианты: OFF VIPADDR V6TOV4MAPPING	Вставка HTTP-заголовка, значением которого является IP-адрес и номер порта виртуального сервера, перед пересылкой запроса на сервер. Формат заголовка: <vipHeader>: <IP-адрес виртуального сервера>_<номер порта>, где vipHeader — имя, которое вы указываете для заголовка. Если виртуальный сервер имеет IPv6-адрес, адрес в заголовке заключен в квадратные скобки ([ и ]) для отделения его от номера порта. Если вы отобразили IPv4-адрес на IPv6-адрес виртуального сервера, значение этого параметра определяет, какой IP-адрес вставляется в заголовок, как показано ниже: * `VIPADDR` — Вставка IP-адреса виртуального сервера в HTTP-заголовок независимо от того, имеет ли виртуальный сервер IPv4-адрес или IPv6-адрес. Отображённый IPv4-адрес, если он настроен, игнорируется. * `V6TOV4MAPPING` — Вставка IPv4-адреса, отображённого на IPv6-адрес виртуального сервера. Если отображённый IPv4-адрес не настроен, вставляется IPv6-адрес. * `OFF` — Отключение вставки заголовка.
ipmask -		Маска IP, в точечной десятичной нотации, для параметра IP Pattern. Может содержать ведущие или хвостовые не нулевые октеты (например, `255.255.240.0` или `0.0.255.255`). Соответственно, маска определяет, какие первые n биты или последние n биты целевого IP-адреса в запросе клиента должны быть сопоставлены с соответствующими битами в IP-образце. Первый случай называется прямой маской. Второй случай называется обратной маской.
ippattern -		Шаблон IP-адреса, в точечной десятичной нотации, для идентификации пакетов, которые должны быть приняты виртуальным сервером. Параметр IP Mask определяет, какая часть целевого IP-адреса должна быть сопоставлена с образцом. Взаимоисключающий с параметром IP Address. Например, если IP-шаблон, назначенный виртуальному серверу, равен `198.51.100.0`, а IP-маска — `255.255.240.0` (прямая маска), первые 20 битов целевых IP-адресов сопоставляются с первыми 20 битами шаблона. Виртуальный сервер принимает запросы с IP-адресами, которые варьируются от `198.51.96.1` до `198.51.111.254`. Также можно использовать шаблон, такой как `0.0.2.2` и маску, такую как `0.0.255.255` (обратная маска). Если целевой IP-адрес соответствует более чем одному IP-шаблону, выбирается шаблон с наибольшим соответствием, и соответствующий виртуальный сервер обрабатывает запрос. Например, если виртуальные серверы `vs1` и `vs2` имеют одинаковый IP-шаблон, `0.0.100.128`, но разные IP-маски `0.0.255.255` и `0.0.224.255`, целевой IP-адрес `198.51.100.128` имеет наибольшее соответствие с IP-образцом vs1. Если целевой IP-адрес соответствует двум или более виртуальным серверам в одинаковой степени, запрос обрабатывается виртуальным сервером, номер порта которого соответствует номеру порта в запросе.
ipv46 -		IPv4 или IPv6 адрес, который необходимо назначить виртуальному серверу.
l2conn boolean	Варианты: no yes	Использование параметров уровня 2 (номер канала, MAC-адрес и идентификатор VLAN) в дополнение к 4-кортежу (<источник IP>:<порт источника>::<назначение IP>:<порт назначения>), используемому для идентификации соединения. Позволяет нескольким TCP- и не-TCP соединениям с одним и тем же 4-кортежем сосуществовать на устройстве NetScaler.
lbmethod -	Варианты: ROUNDROBIN LEASTCONNECTION LEASTRESPONSETIME URLHASH DOMAINHASH DESTINATIONIPHASH SOURCEIPHASH SRCIPDESTIPHASH LEASTBANDWIDTH LEASTPACKETS TOKEN SRCIPSRCPORTHASH LRTM CALLIDHASH CUSTOMLOAD LEASTREQUEST AUDITLOGHASH STATICPROXIMITY	Метод балансировки нагрузки. Доступные настройки работают следующим образом: * `ROUNDROBIN` — Распределение запросов по очереди, независимо от нагрузки. Весам могут быть назначены службы для обеспечения взвешенного распределения по принципу «круговой очереди». * `LEASTCONNECTION` (по умолчанию) — Выбор службы с наименьшим количеством подключений. * `LEASTRESPONSETIME` — Выбор службы с наименьшим средним временем отклика. * `LEASTBANDWIDTH` — Выбор службы, которая в настоящее время обрабатывает наименьший трафик. * `LEASTPACKETS` — Выбор службы, которая в настоящее время обслуживает наименьшее количество пакетов в секунду. * `CUSTOMLOAD` — Базирование выбора службы на метриках SNMP, полученных пользовательскими мониторами нагрузки. * `LRTM` — Выбор службы с наименьшим временем отклика. Время отклика определяется с помощью зондирования мониторинга. Этот метод также учитывает количество активных подключений. Также доступны несколько методов хеширования, при которых устройство извлекает предварительно определенную часть запроса, создает хеш этой части и затем проверяет, были ли в предыдущих запросах такие же значения хеша. Если он находит совпадение, запрос пересылается на службу, которая обслуживала эти предыдущие запросы. Ниже приведены методы хеширования: * `URLHASH` — Создание хеша URL запроса (или части URL). * `DOMAINHASH` — Создание хеша доменного имени в запросе (или части доменного имени). Доменное имя берётся либо из URL, либо из заголовка Host. Если доменное имя появляется в обоих местах, предпочтительнее URL. Если запрос не содержит доменного имени, метод балансировки нагрузки по умолчанию — `LEASTCONNECTION`. * `DESTINATIONIPHASH` — Создание хеша IP-адреса назначения в заголовке IP. * `SOURCEIPHASH` — Создание хеша IP-адреса источника в заголовке IP. * `TOKEN` — Извлечение маркера из запроса, создание хеша маркера и затем выбор службы, на которую были отправлены любые предыдущие запросы с таким же значением хеша маркера. * `SRCIPDESTIPHASH` — Создание хеша строки, полученной путем конкатенации IP-адресов источника и назначения в заголовке IP. * `SRCIPSRCPORTHASH` — Создание хеша IP-адреса источника и порта источника в заголовке IP. * `CALLIDHASH` — Создание хеша заголовка SIP Call-ID.
listenpolicy -		Стандартное синтаксическое выражение, определяющее трафик, принимаемый виртуальным сервером. Может быть либо выражением (например, `CLIENT.IP.DST.IN_SUBNET(192.0.2.0/24`) или именем именованного выражения. В приведенном выше примере виртуальный сервер принимает все запросы, целевой IP-адрес которых находится в подсети 192.0.2.0/24.
listenpriority -		Целое число, определяющее приоритет политики прослушивания. Большее число указывает меньший приоритет. Если запрос соответствует политикам прослушивания более чем одного виртуального сервера, запрос принимает виртуальный сервер, чья политика прослушивания имеет наивысший приоритет (наименьший номер приоритета). Минимальное значение = `0` Максимальное значение = `101`
m -	Варианты: IP MAC IPTUNNEL TOS	Режим перенаправления для балансировки нагрузки. Доступные настройки работают следующим образом: * `IP` — Перед пересылкой запроса на сервер изменение целевого IP-адреса на IP-адрес сервера. * `MAC` — Перед пересылкой запроса на сервер изменение целевого MAC-адреса на MAC-адрес сервера. Целевой IP-адрес не изменяется. Режим перенаправления на основе MAC в основном используется в развертываниях балансировки нагрузки с файрволом. * `IPTUNNEL` — Выполнение инкапсуляции IP-в-IP для пакетов IP клиента. В внешних заголовках IP устанавливаются целевой IP-адрес на IP-адрес сервера и исходный IP-адрес на IP-адрес подсети (SNIP). Пакеты IP клиента не изменяются. Применимо как к IPv4, так и к IPv6 пакетам. * `TOS` — Кодирование идентификатора TOS виртуального сервера в поле TOS заголовка IP. Вы можете использовать либо `IPTUNNEL`, либо `TOS`, чтобы реализовать Direct Server Return (DSR).
macmoderetainvlan -	Варианты: enabled disabled	Этот параметр используется для сохранения информации о VLAN входящего пакета при включенном macmode.

maxautoscalemembers -		Максимальное ожидаемое количество членов, присутствующих при использовании vserver в Автомасштабировании. Минимальное значение = `0` Максимальное значение = `5000`
minautoscalemembers -		Минимальное ожидаемое количество членов, присутствующих при использовании vserver в Автомасштабировании. Минимальное значение = `0` Максимальное значение = `5000`
mssqlserverversion -	Варианты: 70 2000 2000SP1 2005 2008 2008R2 2012 2014	Для виртуального сервера балансировки нагрузки типа `MSSQL`, версия Microsoft SQL Server. Установите этот параметр, если ожидается, что некоторые клиенты будут использовать версию, отличную от версии базы данных. Эта настройка обеспечивает совместимость между клиентскими и серверными подключениями, гарантируя, что все взаимодействие соответствует версии сервера.
mysqlcharacterset -		Набор символов, который виртуальный сервер объявляет клиентам.
mysqlprotocolversion -		Версия протокола MySQL, которую виртуальный сервер объявляет клиентам.
mysqlservercapabilities -		Возможности сервера, которые виртуальный сервер объявляет клиентам.
mysqlserverversion -		Строка версии сервера MySQL, которую виртуальный сервер объявляет клиентам. Минимальная длина = 1 Максимальная длина = 31
name -		Имя виртуального сервера. Должно начинаться с ASCII буквенно-цифрового или символа подчеркивания `_`, и должно содержать только ASCII буквенно-цифровые, символы подчеркивания, решетки `#`, точки `.`, пробелы , двоеточия `:`, знаки @ `@`, знаки равно `=`, и дефисы `-` . Может быть изменено после создания виртуального сервера. Минимальная длина = 1
netmask -		Маска подсети IPv4 для применения к целевому IP-адресу или исходному IP-адресу, когда метод балансировки нагрузки составляет `DESTINATIONIPHASH` или `SOURCEIPHASH`. Минимальная длина = 1
netprofile -		Имя сетевого профиля, который нужно связать с виртуальным сервером. Если вы установите этот параметр, виртуальный сервер будет использовать только IP-адреса в сетевом профиле в качестве исходных IP-адресов при установлении подключений к серверам. Минимальная длина = 1 Максимальная длина = 127
newservicerequest -		Количество запросов или процент нагрузки на существующие службы, на которые нужно увеличить нагрузку на новую службу на каждом интервале в режиме медленного запуска. Значение не равное нулю указывает, что медленный старт применим. Ноль указывает, что применяется глобальный параметр RR запуска. Изменение значения на ноль приведет к тому, что службы, которые в настоящее время в режиме медленного старта, получат весь трафик, как определено методом LB. Впоследствии любые новые добавленные службы будут использовать глобальный коэффициент RR.
newservicerequestincrementinterval -		Интервал в секундах между последовательными увеличениями нагрузки на новую службу или службу, состояние которой только что изменилось с DOWN на UP. Значение 0 (ноль) указывает ручной медленный старт. Минимальное значение = `0` Максимальное значение = `3600`
newservicerequestunit -	Варианты: PER_SECOND PERCENT	Единицы измерения для увеличения нагрузки на каждом интервале в режиме медленного запуска.
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.
oracleserverversion -	Варианты: 10G 11G	Версия сервера Oracle.
persistavpno -		Номер AVP для сохранения состояния сессии по протоколу Diameter. В случае, если этот AVP не определен в базовом RFC 3588 и он вложен внутри сгруппированного AVP, определите последовательность номеров AVP (максимум 3) в порядке от родителя к дочернему элементу. Скажем, номер AVP сохранения X вложен внутри AVP Y, который вложен в Z, то определите список как Z Y X. Минимальное значение = `1`
persistencebackup -	Варианты: SOURCEIP NONE	Тип резервного сохранения состояния сессии для виртуального сервера. Вступает в действие, если первичный механизм сохранения состояния сессии выходит из строя.
persistencetype -	Варианты: SOURCEIP COOKIEINSERT SSLSESSION RULE URLPASSIVE CUSTOMSERVERID DESTIP SRCIPDESTIP CALLID RTSPSID DIAMETER FIXSESSION NONE	Тип сохранения состояния сессии для виртуального сервера. Доступные настройки работают следующим образом: * `SOURCEIP` - Подключения с одного и того же IP-адреса клиента относятся к одной и той же сессии сохранения состояния. * `COOKIEINSERT` - Подключения с одинаковым HTTP-куки, добавленным директивой Set-Cookie сервером, относятся к одной и той же сессии сохранения состояния. * `SSLSESSION` - Подключения с одинаковым идентификатором SSL-сессии относятся к одной и той же сессии сохранения состояния. * `CUSTOMSERVERID` - Подключения с тем же идентификатором сервера являются частью одной сессии. Для этого типа сохранения состояния установите параметр Идентификатор сервера (CustomServerID) для каждой службы и настройте параметр Правило для определения идентификатора сервера в запросе. * `RULE` - Все подключения, соответствующие определенному вами правилу, относятся к одной и той же сессии сохранения состояния. * `URLPASSIVE` - Запросы с одинаковым идентификатором сервера в запросе URL относятся к одной и той же сессии сохранения состояния. Идентификатор сервера — это шестнадцатеричное представление IP-адреса и порта службы, к которой должен быть перенаправлен запрос. Для этого типа сохранения состояния требуется правило для определения идентификатора сервера в запросе. * `DESTIP` - Подключения к одному и тому же целевому IP-адресу относятся к одной и той же сессии сохранения состояния. * `SRCIPDESTIP` - Подключения с одинаковым исходным IP-адресом и целевым IP-адресом относятся к одной и той же сессии сохранения состояния. * `CALLID` - Подключения с одинаковым SIP-заголовком CALL-ID относятся к одной и той же сессии сохранения состояния. * `RTSPSID` - Подключения с одинаковым идентификатором RTSP-сессии относятся к одной и той же сессии сохранения состояния. * FIXSESSION - Подключения с одинаковыми значениями SenderCompID и TargetCompID относятся к одной и той же сессии сохранения состояния.
persistmask -		Маска сохранения состояния для типов сохранения состояния на основе IP для IPv4 виртуальных серверов. Минимальная длина = 1
port -		Номер порта для виртуального сервера. Диапазон `1` - `65535` * в CLI представлен как `65535` в NITRO API
processlocal -	Варианты: enabled disabled	Включив этот параметр, пакеты, предназначенные для vserver в кластере, не будут перенаправляться. Включите этот параметр для режима запроса-ответа для одиночных пакетов или когда верхнее устройство выполняет надлежащий RSS для распределения на основе подключения.

push -		Варианты: enabled disabled	Обрабатывать трафик с виртуальным сервером push, привязанным к этому виртуальному серверу балансировки нагрузки.
pushlabel -			Выражение для извлечения метки из ответа сервера. Может быть выражением или именем именованного выражения.
pushmulticlients boolean		Варианты: no yes	Разрешить несколько подключений Web 2.0 от одного клиента к виртуальному серверу и ожидать обновлений.
pushvserver -			Имя виртуального сервера балансировки нагрузки типа PUSH или SSL_PUSH, на который сервер отправляет обновления, полученные на виртуальном сервере балансировки нагрузки, который вы настраиваете. Минимальная длина = 1
range -			Количество IP-адресов, которые устройство должно сгенерировать и назначить виртуальному серверу. Затем виртуальный сервер функционирует как виртуальный сетевой сервер, принимая трафик по любому из сгенерированных IP-адресов. IP-адреса генерируются автоматически следующим образом: * Для диапазона n последний октет адреса, указанного в параметре IP-адрес, увеличивается на n-1 раз. * Если последний октет превышает 255, он переходит в 0, а третий октет увеличивается на 1. Примечание: параметр Range назначает несколько IP-адресов одному виртуальному серверу. Чтобы сгенерировать массив виртуальных серверов, каждый из которых владеет только одним IP-адресом, используйте скобки в параметрах IP-адрес и Имя для указания диапазона. Например: add lb vserver my_vserver[1-3] HTTP 192.0.2.[1-3] 80. Минимальное значение = `1` Максимальное значение = `254`
recursionavailable boolean		Варианты: no yes	При установке в положение ДА этот параметр заставляет ответы DNS с этого vserver иметь бит RA, установленный в включенное состояние. Обычно этот параметр устанавливают в ДА, когда vserver балансирует нагрузку на набор серверов DNS, поддерживающих рекурсивные запросы.
redirectportrewrite -		Варианты: enabled disabled	Перезаписать порт и изменить протокол для обеспечения успешных перенаправлений HTTP из служб.
redirurl -			URL для перенаправления трафика, если виртуальный сервер становится недоступным. ВНИМАНИЕ! Убедитесь, что домен в URL не совпадает с доменом, указанным для политики переключения контента. Если это так, запросы постоянно перенаправляются на недоступный виртуальный сервер. Минимальная длина = 1
resrule -			Выражение по умолчанию, указывающее, какую часть ответа сервера использовать для создания сессий на основе правил (тип персистентности RULE). Может быть выражением или именем именованного выражения. Пример: `HTTP.RES.HEADER("setcookie"`.VALUE(0).TYPECAST_NVLIST_T('=',';').VALUE("server1")).
rhistate -		Варианты: PASSIVE ACTIVE	Функциональность маршрутизации ввода-вывода здоровья (RHI) устройства NetSaler для объявления маршрута адреса VIP, связанного с виртуальным сервером. Когда параметр уровня RHI Vserver (RHI) установлен в VSVR_CNTRLD, следующее различается в поведении RHI для адреса VIP на основе настроек RHIstate (RHI STATE) на виртуальных серверах, связанных с адресом VIP: * Если вы установите `rhistate` на `PASSIVE` на всех виртуальных серверах, NetScaler ADC всегда объявляет маршрут для адреса VIP. * Если вы установите `rhistate` на `ACTIVE` на всех виртуальных серверах, NetScaler ADC объявляет маршрут для адреса VIP, если хотя бы один из связанных виртуальных серверов находится в состоянии UP. * Если вы установите `rhistate` на `ACTIVE` на некоторых и PASSIVE на других, NetScaler ADC объявляет маршрут для адреса VIP, если хотя бы один из связанных виртуальных серверов, чей `rhistate` установлен в `ACTIVE`, находится в состоянии UP.
rtspnat boolean		Варианты: no yes	Использовать трансляцию сетевых адресов (NAT) для подключений данных RTSP.
save_config boolean		Варианты: no yes ←	Если `yes` модуль сохранит конфигурацию на узле netscaler, если он внес какие-либо изменения. Модуль не сохранит конфигурацию на узле netscaler, если он не внес никаких изменений.
servicebindings -			Список служб вместе с весами, которые балансируются по нагрузке. Доступны следующие подпараметры.
	servicename -		Служба, привязанная к виртуальному серверу. Минимальная длина = 1
	weight -		Вес, который нужно назначить указанной службе. Минимальное значение = `1` Максимальное значение = `100`
servicegroupbindings -			Список групп служб вместе с весами, которые балансируются по нагрузке. Доступны следующие подпараметры.
	servicegroupname -		Имя группы служб, привязанной к выбранному виртуальному серверу балансировки нагрузки.
	weight -		Целое число, определяющее вес службы. Большее число указывает больший вес. Определяет емкость службы по отношению к другим службам в конфигурации балансировки нагрузки. Определяет приоритет, предоставляемый службе в решениях балансировки нагрузки. Минимальное значение = `1` Максимальное значение = `100`
servicetype -		Варианты: HTTP FTP TCP UDP SSL SSL_BRIDGE SSL_TCP DTLS NNTP DNS DHCPRA ANY SIP_UDP SIP_TCP SIP_SSL DNS_TCP RTSP PUSH SSL_PUSH RADIUS RDP MYSQL MSSQL DIAMETER SSL_DIAMETER TFTP ORACLE SMPP SYSLOGTCP SYSLOGUDP FIX SSL_FIX	Протокол, используемый службой (также называется типом службы).
sessionless -		Варианты: enabled disabled	Выполнять балансировку нагрузки на основе каждого пакета без установления сессий. Рекомендуется для балансировки нагрузки серверов системы обнаружения вторжений (IDS) и сценариев с прямым возвратом сервера (DSR), где информация о сессии не требуется.
skippersistency -		Варианты: Bypass ReLb None	Этот аргумент определяет поведение в случае, если служба, выбранная из существующей сессии сохранения состояния, достигла порога.
sobackupaction -		Варианты: DROP ACCEPT REDIRECT	Действие, которое должно быть выполнено, если переполнение должно вступить в силу, но нет доступной или существующей резервной цепочки для переполнения.
somethod -		Варианты: CONNECTION DYNAMICCONNECTION BANDWIDTH HEALTH NONE	Тип порога, превышение которого приводит к переполнению. Доступные настройки работают следующим образом: * `CONNECTION` - Переполнение происходит, когда количество подключений клиентов превышает порог. * DYNAMICCONNECTION - Переполнение происходит, когда количество подключений клиентов на виртуальном сервере превышает сумму максимальных настроек клиентов (Макс. Клиенты) для связанных служб. Не указывайте порог переполнения для этой настройки, так как порог подразумевается настройками Макс. Клиенты связанных служб. * `BANDWIDTH` - Переполнение происходит, когда пропускная способность, потребляемая входящим и исходящим трафиком виртуального сервера, превышает порог. * `HEALTH` - Переполнение происходит, когда процент весов служб, которые находятся в состоянии UP, падает ниже порога. Например, если службы svc1, svc2 и svc3 привязаны к виртуальному серверу с весами 1, 2 и 3, а порог переполнения составляет 50%, переполнение происходит, если svc1 и svc3 или svc2 и svc3 переходят в состояние DOWN. * `NONE` - Переполнение не происходит.

sopersistence -	Варианты: enabled disabled	Если происходит переполнение, сохранить персистентность IP-адреса источника для виртуальных серверов и резервного.
sopersistencetimeout -		Таймаут для сохранения при переполнении, в минутах. Минимальное значение = `2` Максимальное значение = `1440`
sothreshold -		Порог, при котором происходит переполнение. Укажите целое число для метода переполнения `CONNECTION`, значение пропускной способности в килобитах в секунду для метода `BANDWIDTH` (не вводить единицы), или процент для метода `HEALTH` (не вводить знак процента). Минимальное значение = `1` Максимальное значение = `4294967287`
ssl_certkey -		Имя ssl-сертификата, привязанного к этому сервису. ssl-сертификат должен уже существовать. Создание сертификата может быть выполнено с помощью модуля netscaler_ssl_certkey. Этот параметр применим только когда `servicetype` равен `SSL`.
state строка	Варианты: absent present ←	Состояние ресурса, настраиваемого модулем на узле netscaler. При значении present ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При значении absent ресурс будет удален с узла netscaler.
tcpprofilename -		Имя TCP профиля, настройки которого должны быть применены к виртуальному серверу. Минимальная длина = 1 Максимальная длина = 127
td -		Целочисленное значение, уникально идентифицирующее домен трафика, в котором вы хотите настроить сущность. Если вы не укажете ID, сущность станет частью стандартного домена трафика, который имеет ID 0. Минимальное значение = `0` Максимальное значение = `4094`
timeout -		Период времени, в течение которого сессия сохранения активна. Минимальное значение = `0` Максимальное значение = `1440`
tosid -		Идентификатор TOS виртуального сервера. Применим только при режиме перенаправления балансировки нагрузки TOS. Минимальное значение = `1` Максимальное значение = `63`
v6netmasklen -		Количество бит для рассмотрения в IPv6 целевом или исходном IP-адресе для создания хэша, необходимого для методов балансировки нагрузки `DESTINATIONIPHASH` и `SOURCEIPHASH`. Минимальное значение = `1` Максимальное значение = `128`
v6persistmasklen -		Маска сохранения для типов сохранения на основе IP для IPv6 виртуальных серверов. Минимальное значение = `1` Максимальное значение = `128`
validate_certs логическое	Варианты: no yes ←	Если `no`, SSL-сертификаты не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов.
vipheader -		Имя вставляемого заголовка. По умолчанию имя vip-header. Минимальная длина = 1

Примечания

Примечание

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

Примеры

# Netscaler services service-http-1, service-http-2 must have been already created with the netscaler_service module

- name: Create a load balancing vserver bound to services
  delegate_to: localhost
  netscaler_lb_vserver:
    nsip: 172.18.0.2
    nitro_user: nsroot
    nitro_pass: nsroot
    validate_certs: no

    state: present

    name: lb_vserver_1
    servicetype: HTTP
    timeout: 12
    ipv46: 6.93.3.3
    port: 80
    servicebindings:
        - servicename: service-http-1
          weight: 80
        - servicename: service-http-2
          weight: 20

# Service group service-group-1 must have been already created with the netscaler_servicegroup module

- name: Create load balancing vserver bound to servicegroup
  delegate_to: localhost
  netscaler_lb_vserver:
    nsip: 172.18.0.2
    nitro_user: nsroot
    nitro_pass: nsroot
    validate_certs: no
    state: present

    name: lb_vserver_2
    servicetype: HTTP
    ipv46: 6.92.2.2
    port: 80
    timeout: 10
    servicegroupbindings:
        - servicegroupname: service-group-1

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

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

Ключ	Возвращаемое	Описание
diff словарь	ошибка	Список различий между фактически настроенным объектом и конфигурацией, указанной в модуле Пример: {'clttimeout': 'различие. наше: (float) 10.0 другое: (float) 20.0'}
loglines список	всегда	список сообщений журнала, созданных модулем Пример: ['сообщение 1', 'сообщение 2']
msg строка	ошибка	Сообщение, описывающее причину ошибки Пример: Действия не существует

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом 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.9/modules/netscaler_lb_vserver_module.html