netscaler_cs_vserver – Управление сервером переключения содержимого

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

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

Описание

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

Требования

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

nitro python sdk

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
appflowlog -	Варианты: enabled disabled	Включить протоколирование информации о потоках appflow.
authentication boolean	Варианты: no yes	Проверять подлинность пользователей, запрашивающих подключение к виртуальному серверу переключения содержимого.
authenticationhost -		FQDN виртуального сервера аутентификации. Тип службы виртуального сервера должен быть либо `HTTP` либо `SSL`. Минимальная длина = 3 Максимальная длина = 252
authn401 boolean	Варианты: no yes	Включить аутентификацию на основе ответа HTTP 401.
authnprofile -		Имя профиля аутентификации, используемого при включенной аутентификации.
authnvsname -		Имя виртуального сервера аутентификации, который аутентифицирует входящие запросы пользователей на этот виртуальный сервер переключения содержимого. Минимальная длина = 1 Максимальная длина = 252
backupip -		. Минимальная длина = 1
backupvserver -		Имя резервного виртуального сервера, который вы настраиваете. Должно начинаться с ASCII буквенно-цифрового или подчеркивания `_`, и должно содержать только ASCII буквенно-цифровые, символы подчеркивания `_`, хэша `#`, точки `.`, пробелы, двоеточия `:`, знаки «@» `@`, знаки «=» `=`, и дефисы `-`. Можно изменить после создания резервного виртуального сервера. Можно назначить другой резервный виртуальный сервер или переименовать существующий виртуальный сервер. Минимальная длина = 1
cacheable boolean	Варианты: no yes	Используйте этот параметр, чтобы указать, перенаправляет ли виртуальный сервер (используемый для балансировки нагрузки или переключения содержимого) запросы на виртуальный сервер перенаправления кэша перед отправкой их на настроенные серверы.
casesensitive boolean	Варианты: no yes	Учитывать регистр в URL-адресах (для политик, использующих URL-адреса вместо правил). Например, с настройкой `on`, URL-адреса /a/1.html и /A/1.HTML обрабатываются по-разному и могут иметь разные цели (установленные политиками переключения содержимого). С настройкой `off`, /a/1.html и /A/1.HTML переключаются на одну и ту же цель.
clttimeout -		Время простоя, в секундах, после которого клиентское соединение закрывается. Значения по умолчанию: Минимальное значение = `0` Максимальное значение = `31536000`
comment -		Информация об этом виртуальном сервере.
cookiedomain -		. Минимальная длина = 1
cookietimeout -		. Минимальное значение = `0` Максимальное значение = `1440`
dbprofilename -		Имя профиля базы данных. Минимальная длина = 1 Максимальная длина = 127
disabled boolean	Варианты: no ← yes	При установке в `yes`, cs vserver будет отключен. При установке в `no`, cs vserver будет включен. Обратите внимание, что из-за ограничений базового API NITRO изменение состояния `disabled` не приводит к тому, что модуль результатов сообщает об изменении статуса.
disableprimaryondown -	Варианты: enabled disabled	Продолжить пересылку трафика на резервный виртуальный сервер даже после того, как первичный сервер перейдет из состояния DOWN в UP.
dnsprofilename -		Имя профиля DNS, которое должно быть связано с VServer. Свойства профиля DNS будут применяться к транзакциям, обрабатываемым VServer. Этот параметр действителен только для DNS и DNS-TCP VServer. Минимальная длина = 1 Максимальная длина = 127
domainname -		Имя домена, для которого необходимо изменить время жизни (TTL) и/или IP-адрес резервного сервиса. Минимальная длина = 1
downstateflush -	Варианты: enabled disabled	Очистить все активные транзакции, связанные с виртуальным сервером, состояние которого переходит из UP в DOWN. Не включайте этот параметр для приложений, которые должны завершить свои транзакции.
httpprofilename -		Имя профиля HTTP, содержащего настройки HTTP для виртуального сервера. Тип службы виртуального сервера должен быть либо `HTTP` либо `SSL`. Минимальная длина = 1 Максимальная длина = 127
icmpvsrresponse -	Варианты: PASSIVE ACTIVE	Может быть активным или пассивным.
insertvserveripport -	Варианты: OFF VIPADDR V6TOV4MAPPING	Вставить IP-адрес и номер порта виртуального сервера в заголовок запроса. Доступные значения работают следующим образом: `VIPADDR` - Заголовок содержит IP-адрес и номер порта vserver без каких-либо переводов. `OFF` - Опция вставки заголовка виртуального IP и порта отключена. `V6TOV4MAPPING` - Заголовок содержит сопоставленный IPv4-адрес, соответствующий IPv6-адресу vserver и номер порта. IPv6-адрес можно сопоставить с указанным пользователем IPv4-адресом с помощью команды set ns ip6.
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 -		IP-адрес виртуального сервера переключения содержимого. Минимальная длина = 1
l2conn boolean	Варианты: no yes	Использовать параметры L2 для идентификации соединения.

lbvserver - добавлен в 2.5		Виртуальный сервер балансировки нагрузки по умолчанию.
listenpolicy -		Строка, определяющая политику прослушивания для виртуального сервера переключения содержимого. Может быть именем существующего выражения или встроенным выражением.
mssqlserverversion -	Варианты: 70 2000 2000SP1 2005 2008 2008R2 2012 2014	Версия сервера MSSQL.
mysqlcharacterset -		Набор символов, возвращаемый mysql vserver.
mysqlprotocolversion -		Версия протокола, возвращаемая mysql vserver.
mysqlservercapabilities -		Возможности сервера, возвращаемые mysql vserver.
mysqlserverversion -		Строка версии сервера, возвращаемая mysql vserver. Минимальная длина = 1 Максимальная длина = 31
name -		Имя виртуального сервера переключения содержимого. Должно начинаться с символа ASCII буквенно-цифрового или подчеркивания `_`, и должно содержать только символы ASCII буквенно-цифрового, подчеркивания `_`, решётки `#`, точки `.`, пробела, двоеточия `:`, знака @ `@`, знака равенства `=`, и дефиса `-`. Не может быть изменено после создания виртуального сервера CS. Минимальная длина = 1
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.
oracleserverversion -	Варианты: 10G 11G	Версия сервера Oracle.
port -		Номер порта для виртуального сервера переключения содержимого. Минимальное значение = 1 Диапазон `1` - `65535` * в CLI представлено как 65535 в NITRO API
precedence -	Варианты: RULE URL	Тип приоритета для использования для правил на основе RULE и URL на виртуальном сервере переключения содержимого. При стандартном `RULE` значение, входящие запросы оцениваются по правилам переключения содержимого. Если ни одно правило не соответствует, URL в запросе оценивается по URL-политикам переключения содержимого.
push -	Варианты: enabled disabled	Обработка трафика с виртуальным сервером push, привязанным к этому виртуальному серверу переключения содержимого (указан параметром Push VServer). Тип службы виртуального сервера push должен быть либо `HTTP` , либо `SSL`.
pushlabel -		Выражение для извлечения метки из ответа, полученного от сервера. Эта строка может быть именем существующего правила или встроенным выражением. Тип службы виртуального сервера должен быть либо `HTTP` , либо `SSL`.
pushmulticlients логическое	Варианты: no yes	Разрешить несколько подключений Web 2.0 от одного клиента к виртуальному серверу и ожидать обновлений.
pushvserver -		Имя виртуального сервера балансировки нагрузки, типа `PUSH` или `SSL_PUSH`, в который сервер отправляет обновления, полученные на виртуальном сервере балансировки, обращенном к клиенту. Минимальная длина = 1
range -		Количество последовательных IP-адресов, начиная с адреса, указанного параметром IP Address, для включения в диапазон адресов, назначенных этому виртуальному серверу. Минимальное значение = `1` Максимальное значение = `254`
redirectportrewrite -	Варианты: enabled disabled	Состояние изменения порта при выполнении HTTP перенаправления.
redirecturl -		URL, на который перенаправляется трафик, если виртуальный сервер становится недоступным. Тип службы виртуального сервера должен быть либо `HTTP` , либо `SSL`. Предупреждение: Убедитесь, что домен в URL не совпадает с доменом, указанным для политики переключения содержимого. Если совпадает, запросы постоянно перенаправляются на недоступный виртуальный сервер. Минимальная длина = 1
rhistate -	Варианты: PASSIVE ACTIVE	Маршрут хоста вводится в зависимости от настроек виртуальных серверов * Если установлен на `PASSIVE` на всех виртуальных серверах, разделяющих IP-адрес, устройство всегда вводит маршрут хоста. * Если установлен на `ACTIVE` на всех виртуальных серверах, разделяющих IP-адрес, устройство вводит даже если один виртуальный сервер активен. * Если установлен на `ACTIVE` на некоторых виртуальных серверах и на `PASSIVE` на других, устройство вводит, даже если один виртуальный сервер, установленный на `ACTIVE` активен.
rtspnat логическое	Варианты: no yes	Включить трансляцию сетевых адресов (NAT) для подключений протокола реального времени потокового вещания (RTSP).
save_config логическое	Варианты: no yes ←	Если `yes` модуль сохранит конфигурацию на узле netscaler, если он внес какие-либо изменения. Модуль не сохранит конфигурацию на узле netscaler, если не внес никаких изменений.
servicetype -	Варианты: HTTP SSL TCP FTP RTSP SSL_TCP UDP DNS SIP_UDP SIP_TCP SIP_SSL ANY RADIUS RDP MYSQL MSSQL DIAMETER SSL_DIAMETER DNS_TCP ORACLE SMPP	Протокол, используемый виртуальным сервером.
sitedomainttl -		. Минимальное значение = `1`
sobackupaction -	Варианты: DROP ACCEPT REDIRECT	Действие, которое будет выполнено, если переполнение должно вступить в силу, но ни одна цепочка резервного копирования для переполнения не используется или не существует.

END_OF_DOCUMENT_MARKER

somethod -	Варианты: CONNECTION DYNAMICCONNECTION BANDWIDTH HEALTH NONE	Тип переполнения, используемого для перенаправления трафика на резервный виртуальный сервер, когда первичный виртуальный сервер достигает порога переполнения. Переполнение по подключениям основано на количестве подключений. Переполнение по пропускной способности основано на общем значении Kbps входящего и исходящего трафика.
sopersistence -	Варианты: enabled disabled	Поддерживать персистенцию на основе исходного IP-адреса на первичных и резервных виртуальных серверах.
sopersistencetimeout -		Значение таймаута в минутах для персистенции переполнения. Минимальное значение = `2` Максимальное значение = `1440`
sothreshold -		В зависимости от метода переполнения, максимальное количество подключений или максимальная общая пропускная способность (Kbps), которую может обработать виртуальный сервер, прежде чем произойдёт переполнение. Минимальное значение = `1` Максимальное значение = `4294967287`
ssl_certkey - добавлен в 2.5		Имя сертификата ssl, привязанного к этому сервису. Сертификат ssl должен уже существовать. Создание сертификата может быть выполнено с помощью модуля netscaler_ssl_certkey. Этот параметр применим только тогда, когда `servicetype` равен `SSL`.
state строка	Варианты: absent present ←	Состояние ресурса, настраиваемого модулем на узле netscaler. При значении present ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При значении absent ресурс будет удалён с узла netscaler.
stateupdate -	Варианты: enabled disabled	Включить обновления состояния для определённого виртуального сервера переключения содержимого. По умолчанию виртуальный сервер переключения содержимого всегда активен, независимо от состояния связанных с ним виртуальных серверов балансировки нагрузки. Этот параметр взаимодействует с глобальными настройками следующим образом: Глобальный уровень \| Уровень VServer \| Результат enabled enabled enabled enabled disabled enabled disabled enabled enabled disabled disabled disabled Если вы хотите включить обновления состояния только для некоторых виртуальных серверов переключения содержимого, убедитесь, что параметр обновления состояния отключён.
targettype -	Варианты: GSLB	Тип целевого виртуального сервера.
tcpprofilename -		Имя профиля TCP, содержащего настройки конфигурации TCP для виртуального сервера. Минимальная длина = 1 Максимальная длина = 127
td -		Целочисленное значение, уникально идентифицирующее домен трафика, в котором вы хотите настроить сущность. Если вы не укажете идентификатор, сущность станет частью стандартного домена трафика, имеющего идентификатор 0. Минимальное значение = 0 Максимальное значение = 4094
ttl -		. Минимальное значение = `1`
validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов.
vipheader -		Имя заголовка IP и порта виртуального сервера для использования с параметром Вставка IP-порта VServer. Минимальная длина = 1

Примечания

Примечание

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

Примеры

# policy_1 must have been already created with the netscaler_cs_policy module
# lbvserver_1 must have been already created with the netscaler_lb_vserver module

- name: Setup content switching vserver
  delegate_to: localhost
  netscaler_cs_vserver:
    nsip: 172.18.0.2
    nitro_user: nsroot
    nitro_pass: nsroot

    state: present

    name: cs_vserver_1
    ipv46: 192.168.1.1
    port: 80
    servicetype: HTTP

    policybindings:
      - policyname: policy_1
        targetlbvserver: lbvserver_1

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

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

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

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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_cs_vserver_module.html