community.network.netscaler_lb_vserver модуль — Управление конфигурацией балансировки нагрузки vserver
Примечание
Этот модуль входит в коллекцию community.network (версия 5.0.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install community.network. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.
Чтобы использовать его в playbook, укажите: community.network.netscaler_lb_vserver.
Описание
- Управление конфигурацией балансировки нагрузки vserver
- Этот модуль предназначен для выполнения либо на узле управления Ansible, либо на бастионе (прыжковом сервере) с доступом к фактической инстанции Netscaler
Псевдонимы: network.netscaler.netscaler_lb_vserver
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- nitro python sdk
Параметры
Параметр | Комментарии |
|---|---|
appflowlog string | Применить ведение журнала AppFlow к виртуальному серверу. Варианты:
|
authentication boolean | Включить или отключить аутентификацию пользователя. Варианты:
|
authenticationhost string | Полностью квалифицированное доменное имя (FQDN) виртуального сервера аутентификации, на который пользователь должен быть перенаправлен для аутентификации. Убедитесь, что параметр Authentication установлен в Минимальная длина = 3 Максимальная длина = 252 |
authn401 boolean | Включить или отключить аутентификацию пользователя с ответами HTTP 401. Варианты:
|
authnprofile string | Имя профиля аутентификации, который будет использоваться при включенной аутентификации. |
authnvsname string | Имя виртуального сервера аутентификации, с помощью которого будет выполняться аутентификация пользователей. Минимальная длина = 1 Максимальная длина = 252 |
backuplbmethod string | Резервный метод балансировки нагрузки. Становится рабочим, если основной метод балансировки нагрузки не работает или не может быть использован. Действительно только если основной метод основан на статической близости. Варианты:
|
backuppersistencetimeout string | Период времени, в течение которого действует резервное сохранение состояния. Минимальное значение = Максимальное значение = |
bypassaaaa boolean | Если этот параметр включен при разрешении запроса DNS64, запросы AAAA не отправляются на сервер back end dns. Варианты:
|
cacheable boolean | Маршрутизировать кэшируемые запросы на виртуальный сервер перенаправления кэша. Виртуальный сервер балансировки нагрузки может пересылать запросы только на прозрачный виртуальный сервер перенаправления кэша, имеющий комбинацию IP-адреса и порта *:80, поэтому такой виртуальный сервер перенаправления кэша должен быть настроен на устройстве. Варианты:
|
clttimeout string | Время простоя, в секундах, после которого соединение клиента разрывается. Минимальное значение = Максимальное значение = |
comment string | Любые комментарии, которые вы можете захотеть связать с виртуальным сервером. |
connfailover string | Режим работы функции переключения на резервный сервер для виртуального сервера. После переключения на резервный сервер установленные TCP-соединения и потоки UDP-пакетов остаются активными и возобновляются на резервном устройстве. Клиенты остаются подключенными к тем же серверам. Доступные параметры работают следующим образом: * * * Варианты:
|
cookiename string | Используйте этот параметр для указания имени cookie для типа сохранения состояния |
datalength string | Длина маркера, который будет извлечен из сегмента данных входящего пакета, для использования в методе балансировки нагрузки на основе маркеров. Длина маркера, указанная в байтах, не должна превышать 24 КБ. Применимо к виртуальным серверам типа TCP. Минимальное значение = Максимальное значение = |
dataoffset string | Смещение, которое необходимо учитывать при извлечении маркера из полезной нагрузки TCP. Применимо к виртуальным серверам типа TCP, использующим метод балансировки нагрузки на основе маркеров. Должно находиться в первых 24 КБ полезной нагрузки TCP. Минимальное значение = Максимальное значение = |
dbprofilename string | Имя профиля DB, параметры которого будут применены к виртуальному серверу. Минимальная длина = 1 Максимальная длина = 127 |
dbslb string | Включить балансировку нагрузки, специфичную для базы данных, для типов служб MySQL и MSSQL. Варианты:
|
disabled boolean | При установке в При установке в Обратите внимание, что из-за ограничений базового API NITRO изменение состояния Варианты:
|
disableprimaryondown string | Если основной виртуальный сервер выходит из строя, не разрешайте ему вернуться в состояние основного до его ручного включения. Варианты:
|
dns64 string | Этот параметр предназначен для включения/выключения Варианты:
|
dnsprofilename string | Имя профиля DNS, которое необходимо ассоциировать с VServer. Свойства профиля DNS будут применяться к транзакциям, обрабатываемым VServer. Этот параметр действителен только для DNS и DNS-TCP VServer. Минимальная длина = 1 Максимальная длина = 127 |
downstateflush string | Очистить все активные транзакции, связанные с виртуальным сервером, чье состояние переходит из ВКЛ в ВЫКЛ. Не активируйте этот параметр для приложений, которые должны завершить свои транзакции. Варианты:
|
hashlength string | Количество байтов, учитываемых для значения хэша, используемого в методах балансировки нагрузки URLHASH и DOMAINHASH. Минимальное значение = Максимальное значение = |
healththreshold string | Пороговое значение в процентах активных служб, ниже которого состояние vserver устанавливается в ВЫКЛ. Если этот порог равен 0, состояние vserver будет ВКЛ, даже если одна связанная служба включена. Минимальное значение = Максимальное значение = |
httpprofilename string | Имя HTTP-профиля, настройки которого необходимо применить к виртуальному серверу. Минимальная длина = 1 Максимальная длина = 127 |
icmpvsrresponse string | Как NetScaler-устройство отвечает на запросы пинга, полученные для IP-адреса, общего для одного или нескольких виртуальных серверов. Доступные настройки работают следующим образом: * Если установлено значение * Если установлено значение * Если установлено значение Примечание: Этот параметр доступен на уровне виртуального сервера. Аналогичный параметр, Ответ ICMP, доступен на уровне IP-адреса для IP-адресов типа VIP. Для настройки этого параметра используйте команду add ip в консоли или диалоговое окно «Создать IP» в графическом интерфейсе. Варианты:
|
insertvserveripport string | Вставить HTTP-заголовок, значение которого — IP-адрес и номер порта виртуального сервера, перед переадресацией запроса на сервер. Формат заголовка: <vipHeader>: <IP-адрес виртуального сервера>_<номер порта>, где vipHeader — имя, заданное вами для заголовка. Если виртуальный сервер имеет IPv6-адрес, адрес в заголовке заключён в квадратные скобки ([ и ]) для разделения его с номером порта. Если вы сопоставили IPv4-адрес с IPv6-адресом виртуального сервера, значение этого параметра определяет, какой IP-адрес вставляется в заголовок, следующим образом: * * * Варианты:
|
ipmask string | Маска IP, в точечной десятичной нотации, для параметра IP Pattern. Может содержать ведущие или хвостовые ненулевые октеты (например, |
ippattern string | Шаблон IP-адреса в формате с точками и десятичными числами для идентификации пакетов, которые должны приниматься виртуальным сервером. Параметр IP Mask указывает, какая часть IP-адреса назначения сопоставляется с шаблоном. Взаимоисключающее с параметром IP Address. Например, если заданный для виртуального сервера шаблон IP-адреса — Если IP-адрес назначения соответствует более чем одному шаблону IP-адреса, выбирается шаблон с самым длинным соответствием, и соответствующий виртуальный сервер обрабатывает запрос. Например, если виртуальные серверы |
ipv46 string | IP-адрес IPv4 или IPv6, который необходимо назначить виртуальному серверу. |
l2conn boolean | Использование параметров уровня 2 (номер канала, MAC-адрес и идентификатор VLAN) помимо 4-кортежа (<IP-адрес источника>:<порт источника>::<IP-адрес назначения>:<порт назначения>), который используется для идентификации соединения. Позволяет нескольким TCP- и не-TCP-соединениям с одинаковым 4-кортежем существовать на устройстве NetScaler. Варианты:
|
lbmethod string | Метод балансировки нагрузки. Доступные настройки работают следующим образом: * * * * * * * Также доступны несколько методов хэширования, при которых устройство выделяет заранее определенную часть запроса, создает хэш этой части и проверяет, были ли в предыдущих запросах значения с таким же хэш-значением. Если совпадение найдено, запрос перенаправляется на ту службу, которая обслуживала эти предыдущие запросы. Ниже приведены методы хэширования: * * * * * * * * Варианты:
|
listenpolicy string | Выражение синтаксиса по умолчанию, идентифицирующее трафик, принимаемый виртуальным сервером. Может быть либо выражением (например, |
listenpriority string | Целое число, определяющее приоритет политики прослушивания. Более высокое число указывает более низкий приоритет. Если запрос соответствует политике прослушивания более чем одного виртуального сервера, запрос принимает виртуальный сервер, чья политика прослушивания имеет наивысший приоритет (наименьший номер приоритета). Минимальное значение = Максимальное значение = |
| ... |
mssqlserverversion string | Для виртуального сервера балансировки нагрузки типа Варианты:
|
mysqlcharacterset string | Кодировка символов, которую виртуальный сервер объявляет клиентам. |
mysqlprotocolversion string | Версия протокола MySQL, которую виртуальный сервер объявляет клиентам. |
mysqlservercapabilities string | Возможности сервера, которые виртуальный сервер объявляет клиентам. |
mysqlserverversion string | Строка версии сервера MySQL, которую виртуальный сервер объявляет клиентам. Минимальная длина = 1 Максимальная длина = 31 |
name string | Имя для виртуального сервера. Должно начинаться с буквенно-цифрового символа ASCII или символа подчеркивания Минимальная длина = 1 |
netmask string | Маска подсети IPv4 для применения к целевому IP-адресу или исходному IP-адресу, когда метод балансировки нагрузки — Минимальная длина = 1 |
netprofile string | Имя сетевого профиля для ассоциирования с виртуальным сервером. Если вы установите этот параметр, виртуальный сервер будет использовать только IP-адреса в сетевом профиле в качестве исходных IP-адресов при инициировании соединений с серверами. Минимальная длина = 1 Максимальная длина = 127 |
newservicerequest string | Количество запросов или процент нагрузки на существующие службы, на которые следует увеличить нагрузку на новую службу на каждом интервале в режиме медленного запуска. Не нулевое значение указывает на то, что медленный запуск применим. Нулевое значение указывает на то, что применяется глобальный параметр запуска RR. Изменение значения на ноль приведет к тому, что службы, которые в данный момент находятся в режиме медленного запуска, будут принимать весь трафик, как определено методом LB. Впоследствии любые новые добавленные службы будут использовать глобальный коэффициент RR. |
newservicerequestincrementinterval string | Интервал, в секундах, между последовательными увеличениями нагрузки на новую службу или службу, состояние которой только что изменилось с DOWN на UP. Значение 0 (ноль) указывает на ручной медленный запуск. Минимальное значение = Максимальное значение = |
newservicerequestunit string | Единицы, в которых необходимо увеличивать нагрузку на каждом интервале в режиме медленного запуска. Варианты:
|
nitro_pass string / required | Пароль для аутентификации на узле Netscaler. |
nitro_protocol string | Какой протокол использовать при доступе к объектам API Nitro. Варианты:
|
nitro_timeout float | Время в секундах до возникновения ошибки времени ожидания при установлении нового сеанса с Netscaler По умолчанию: |
nitro_user string / required | Имя пользователя для аутентификации на узле Netscaler. |
nsip string / required | IP-адрес устройства Netscaler, где будут выполняться вызовы API Nitro. Порт может быть указан с помощью двоеточия (:). Например, 192.168.1.1:555. |
oracleserverversion string | Версия сервера Oracle. Варианты:
|
persistavpno string | Номер AVP для сохранения для постоянства Diameter. В случае, если этот AVP не определен в базовом RFC 3588 и он вложен внутри сгруппированного AVP, определите последовательность номеров AVP (макс. 3) в порядке от родителя к дочернему. Допустим, номер AVP X для сохранения вложен внутри AVP Y, который вложен в Z, затем определите список как Z Y X. Минимальное значение = |
persistencebackup string | Резервный тип сохранения состояния для виртуального сервера. Становится активным, если основной механизм сохранения состояния выходит из строя. Choices:
|
persistencetype string | Тип сохранения состояния для виртуального сервера. Доступные параметры работают следующим образом: * * * * * * * * * * * FIXSESSION - Подключения, имеющие одинаковые значения SenderCompID и TargetCompID, относятся к одному сеансу сохранения состояния. Choices:
|
persistmask string | Маска сохранения состояния для типов сохранения состояния на основе IP для виртуальных серверов IPv4. Минимальная длина = 1 |
port string | Номер порта для виртуального сервера. Диапазон * в CLI представлен как |
processlocal string | При включении этого параметра пакеты, предназначенные для виртуального сервера в кластере, не будут подвергаться никакому управлению. Включите этот параметр для режима запроса-ответа с одним пакетом или когда вышестоящее устройство выполняет правильный RSS для распределения на основе соединения. Choices:
|
push string | Обрабатывать трафик с помощью виртуального сервера push, который привязан к этому виртуальному серверу балансировки нагрузки. Choices:
|
pushlabel string | Выражение для извлечения метки из ответа сервера. Может быть выражением или именем именованного выражения. |
pushmulticlients boolean | Разрешить нескольким подключениям Web 2.0 от одного клиента подключаться к виртуальному серверу и ожидать обновлений. Choices:
|
pushvserver string | Имя виртуального сервера балансировки нагрузки типа PUSH или SSL_PUSH, на который сервер отправляет обновления, полученные на виртуальном сервере балансировки нагрузки, который вы настраиваете. Минимальная длина = 1 |
range string | Количество IP-адресов, которые устройство должно сгенерировать и назначить виртуальному серверу. Затем виртуальный сервер функционирует как сетевой виртуальный сервер, принимая трафик по любому из сгенерированных IP-адресов. IP-адреса генерируются автоматически следующим образом: * Для диапазона n последний октет адреса, указанный параметром IP-адреса, увеличивается n-1 раз. * Если последний октет превышает 255, он обнуляется, а третий октет увеличивается на 1. Примечание: Параметр Range назначает несколько IP-адресов одному виртуальному серверу. Чтобы сгенерировать массив виртуальных серверов, каждый из которых владеет только одним IP-адресом, используйте квадратные скобки в параметрах IP-адрес и имя для указания диапазона. Например: add lb vserver my_vserver[1-3] HTTP 192.0.2.[1-3] 80. Минимальное значение = Максимальное значение = |
boolean | При установке в YES этот параметр приводит к тому, что в ответах DNS от этого виртуального сервера бит RA будет установлен. Обычно этот параметр устанавливается в YES, когда виртуальный сервер балансирует нагрузку набора DNS-серверов, которые поддерживают рекурсивные запросы. Choices:
|
redirectportrewrite string | Переписать порт и изменить протокол, чтобы обеспечить успешные HTTP-перенаправления со служб. Choices:
|
redirurl string | URL, на который следует перенаправлять трафик, если виртуальный сервер станет недоступен. ПРЕДУПРЕЖДЕНИЕ! Убедитесь, что домен в URL не совпадает с доменом, указанным для политики переключения контента. В противном случае запросы будут постоянно перенаправляться на недоступный виртуальный сервер. Минимальная длина = 1 |
resrule string | Выражение синтаксиса по умолчанию, указывающее, какую часть ответа сервера использовать для создания сеансов сохранения состояния на основе правил (тип сохранения состояния RULE). Может быть выражением или именем именованного выражения. Пример:
|
rhistate string | Функциональность Route Health Injection (RHI) устройства NetScaler для объявления маршрута адреса VIP, связанного с виртуальным сервером. Когда параметр Vserver RHI Level (RHI) установлен в VSVR_CNTRLD, следующие различные поведения RHI для адреса VIP основаны на настройках RHIstate (RHI STATE) на виртуальных серверах, связанных с адресом VIP: * Если вы установите * Если вы установите * Если вы установите Варианты:
|
rtspnat boolean | Использование трансляции сетевых адресов (NAT) для подключений данных RTSP. Варианты:
|
save_config boolean | Если Модуль не сохранит конфигурацию на узле netscaler, если он не внес никаких изменений. Варианты:
|
servicebindings string | Список служб с весами, которые сбалансированы по нагрузке. Доступны следующие подварианты. |
|
servicename string |
Служба, которая должна быть привязана к виртуальному серверу. Минимальная длина = 1 |
|
weight string |
Вес, назначаемый указанной службе. Минимальное значение = Максимальное значение = |
servicegroupbindings string | Список групп служб с весами, которые сбалансированы по нагрузке. Доступны следующие подварианты. |
|
servicegroupname string |
Имя группы служб, привязанное к выбранному виртуальному серверу балансировки нагрузки. |
|
weight string |
Целое число, определяющее вес службы. Большее число указывает больший вес. Определяет емкость службы по отношению к другим службам в конфигурации балансировки нагрузки. Определяет приоритет, присваиваемый службе в решениях балансировки нагрузки. Минимальное значение = Максимальное значение = |
servicetype string | Протокол, используемый службой (также называется типом службы). Варианты:
|
sessionless string | Выполнение балансировки нагрузки на основе каждого пакета без установления сеансов. Рекомендуется для балансировки нагрузки серверов обнаружения вторжений (IDS) и сценариев с прямым возвратом к серверу (DSR), где информация о сеансе не требуется. Варианты:
|
skippersistency string | Этот аргумент определяет поведение в случае, если служба, выбранная из существующей сессии персистенции, достигла порога. Варианты:
|
sobackupaction string | Действие, которое должно быть выполнено, если переполнение должно вступить в силу, но нет или недоступна резервная цепочка для переполнения. Варианты:
|
somethod string | Тип порога, превышение которого вызывает переполнение. Доступные параметры работают следующим образом: * * DYNAMICCONNECTION - Переполнение происходит, когда количество клиентских соединений на виртуальном сервере превышает сумму максимальных настроек клиентов (Max Clients) для связанных служб. Не указывайте порог переполнения для этого параметра, поскольку порог подразумевается настройками Max Clients связанных служб. * * * Варианты:
|
sopersistence string | Если происходит переполнение, поддерживать постоянство на основе исходного IP-адреса как для основного, так и для резервного виртуальных серверов. Варианты:
|
sopersistencetimeout string | Время ожидания постоянства переполнения в минутах. Минимальное значение = Максимальное значение = |
sothreshold string | Порог, при котором происходит переполнение. Укажите целое число для метода переполнения Минимальное значение = Максимальное значение = |
ssl_certkey string | Имя SSL-сертификата, привязанного к этой службе. SSL-сертификат должен уже существовать. Создание сертификата можно выполнить с помощью модуля community.network.netscaler_ssl_certkey. Этот параметр применим только тогда, когда |
state string | Состояние ресурса, настраиваемого модулем на узле NetScaler. При наличии ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При отсутствии ресурс будет удален с узла NetScaler. Варианты:
|
tcpprofilename string | Имя TCP-профиля, настройки которого должны быть применены к виртуальному серверу. Минимальная длина = 1 Максимальная длина = 127 |
td string | Целочисленное значение, однозначно идентифицирующее трафиковый домен, в котором вы хотите настроить объект. Если вы не укажете ID, объект станет частью домена трафика по умолчанию, который имеет ID 0. Минимальное значение = Максимальное значение = |
timeout string | Период времени, в течение которого действует сеанс постоянства. Минимальное значение = Максимальное значение = |
tosid string | ID TOS виртуального сервера. Применимо только тогда, когда режим перенаправления балансировки нагрузки установлен в TOS. Минимальное значение = Максимальное значение = |
v6netmasklen string | Количество битов, которые следует учитывать в IPv6-адресе назначения или источника IP для создания хэша, необходимого для методов балансировки нагрузки Минимальное значение = Максимальное значение = |
v6persistmasklen string | Маска постоянства для типов постоянства на основе IP для виртуальных серверов IPv6. Минимальное значение = Максимальное значение = |
validate_certs boolean | Если Варианты:
|
vipheader string | Имя для вставленного заголовка. Имя по умолчанию — vip-header. Минимальная длина = 1 |
Примечания
Примечание
- Дополнительные сведения об использовании Ansible для управления сетевыми устройствами Citrix NetScaler см. по адресу 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
community.network.netscaler_lb_vserver:
nsip: 172.18.0.2
nitro_user: nsroot
nitro_pass: nsroot
validate_certs: false
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
community.network.netscaler_lb_vserver:
nsip: 172.18.0.2
nitro_user: nsroot
nitro_pass: nsroot
validate_certs: false
state: present
name: lb_vserver_2
servicetype: HTTP
ipv46: 6.92.2.2
port: 80
timeout: 10
servicegroupbindings:
- servicegroupname: service-group-1
Значения возврата
Общие значения возврата описаны здесь, ниже приведены поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
diff словарь | Список различий между фактически настроенным объектом и конфигурацией, указанной в модуле Возвращается: ошибка Пример: |
loglines список / элементы=строка | Список сообщений, записанных модулем Возвращается: всегда Пример: |
msg строка | Сообщение, описывающее причину ошибки Возвращается: ошибка Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/netscaler_lb_vserver_module.html