community.network.netscaler_cs_vserver – Управление коммутацией контента vserver
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в playbook укажите: community.network.netscaler_cs_vserver.
Обзор
- Управление коммутацией контента vserver
- Этот модуль предназначен для выполнения либо на контрольном узле Ansible, либо на бастионе (шлюзе) с доступом к фактическому экземпляру netscaler
Требования
Ниже перечислены требования, необходимые на узле, на котором выполняется этот модуль.
- nitro python sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| appflowlog строка |
| Включить логирование информации о потоке appflow. |
| authentication логический |
| Проверять подлинность пользователей, запрашивающих подключение к виртуальному серверу переключения содержимого. |
| authenticationhost строка | FQDN виртуального сервера аутентификации. Тип сервиса виртуального сервера должен быть либо HTTP, либо SSL. Минимальная длина = 3 Максимальная длина = 252 | |
| authn401 логический |
| Включить аутентификацию на основе ответа HTTP 401. |
| authnprofile строка | Имя профиля аутентификации, которое будет использоваться при включенной аутентификации. | |
| authnvsname строка | Имя виртуального сервера аутентификации, который аутентифицирует входящие запросы пользователей к этому виртуальному серверу переключения содержимого. Минимальная длина = 1 Максимальная длина = 252 | |
| backupip строка | . Минимальная длина = 1 | |
| backupvserver строка | Имя резервного виртуального сервера, который вы настраиваете. Должно начинаться с ASCII буквенно-цифрового или символа подчеркивания _, и должно содержать только ASCII буквенно-цифровые, символы подчеркивания _, решетки #, точки ., пробелы , двоеточия :, знаки «@» @, знаки «=» =, и тире - . Может быть изменено после создания резервного виртуального сервера. Вы можете назначить другой резервный виртуальный сервер или переименовать существующий виртуальный сервер.Минимальная длина = 1 | |
| cacheable логический |
| Используйте этот параметр, чтобы указать, направляет ли виртуальный сервер, используемый для балансировки нагрузки или переключения содержимого, запросы на виртуальный сервер перенаправления кэша перед отправкой их на настроенные серверы. |
| casesensitive логический |
| Учитывать регистр в 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 логический |
| При установке в yes, cs vserver будет отключён.При установке в no, cs vserver будет включён.Обратите внимание, что из-за ограничений базового API NITRO изменение состояния disabled не приводит к тому, что модуль результат отображает изменённый статус. |
| disableprimaryondown строка |
| Продолжать пересылку трафика на резервный виртуальный сервер даже после того, как первичный сервер перешел из состояния «выключен» в «включен». |
| dnsprofilename строка | Имя профиля DNS, которое будет связано с VServer. Свойства профиля DNS будут применены к транзакциям, обработанным VServer. Этот параметр действителен только для DNS и DNS-TCP VServer. Минимальная длина = 1 Максимальная длина = 127 | |
| domainname строка | Имя домена, для которого необходимо изменить время жизни (TTL) и/или IP-адрес резервного сервиса. Минимальная длина = 1 | |
| downstateflush строка |
| Очистить все активные транзакции, связанные с виртуальным сервером, состояние которого переходит из «включено» в «выключено». Не включайте этот параметр для приложений, которые должны завершить свои транзакции. |
| httpprofilename строка | Имя HTTP-профиля, содержащего параметры HTTP-настройки для виртуального сервера. Тип сервиса виртуального сервера должен быть либо HTTP, либо SSL. Минимальная длина = 1 Максимальная длина = 127 | |
| icmpvsrresponse строка |
| Может быть активным или пассивным. |
| insertvserveripport строка |
| Вставить 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. Первый случай называется прямой маской. Второй – обратной маской. | |
| ippattern строка | Шаблон IP-адреса, в точечной десятичной записи, для идентификации пакетов, которые должны быть приняты виртуальным сервером. Параметр IP Mask определяет, какая часть адреса назначения соответствует шаблону. Взаимоисключающий с параметром IP Address. Например, если заданным шаблоном IP виртуального сервера является 198.51.100.0 , а маской IP – 255.255.240.0 (прямая маска), первые 20 битов в адресах назначения сопоставляются с первыми 20 битами в шаблоне. Виртуальный сервер принимает запросы с IP-адресами в диапазоне от 198.51.96.1 до 198.51.111.254. Также можно использовать шаблон, такой как 0.0.2.2 и маску, такую как 0.0.255.255 (обратная маска).Если адрес назначения соответствует более чем одному шаблону IP, выбирается шаблон с наибольшим соответствием, и соответствующий виртуальный сервер обрабатывает запрос. Например, если у виртуальных серверов vs1 и vs2 одинаковый шаблон IP 0.0.100.128, но разные маски IP 0.0.255.255 и 0.0.224.255, адрес назначения 198.51.100.128 имеет наибольшее соответствие с шаблоном IP vs1. Если адрес назначения соответствует двум или более виртуальным серверам в одинаковой степени, запрос обрабатывается виртуальным сервером, номер порта которого соответствует номеру порта в запросе. | |
| ipv46 строка | IP-адрес виртуального сервера переключения содержимого. Минимальная длина = 1 | |
| l2conn логический |
| Использовать параметры L2 для идентификации соединения. |
| lbvserver строка | Виртуальный сервер балансировки нагрузки по умолчанию. | |
| listenpolicy строка | Строка, определяющая политику прослушивания для виртуального сервера переключения содержимого. Может быть именем существующей выражения или встроенным выражением. | |
| mssqlserverversion строка |
| Версия сервера MSSQL. |
| mysqlcharacterset строка | Набор символов, возвращаемый mysql vserver. | |
| mysqlprotocolversion строка | Версия протокола, возвращаемая mysql vserver. | |
| mysqlservercapabilities строка | Возможности сервера, возвращаемые mysql vserver. | |
| mysqlserverversion строка | Строка версии сервера, возвращаемая mysql vserver. Минимальная длина = 1 Максимальная длина = 31 |
| имя строка | Имя виртуального сервера переключения контента. Должно начинаться с ASCII буквенно-цифрового символа или символа подчеркивания _, и должно содержать только ASCII буквенно-цифровые символы, символ подчеркивания _, символ решетки #, точку ., пробел, двоеточие :, символ "@" @, знак равенства =, и дефис -.Не может быть изменено после создания виртуального сервера CS. Минимальная длина = 1 | |
| netprofile строка | Имя сетевого профиля. Минимальная длина = 1 Максимальная длина = 127 | |
| nitro_pass строка / обязательно | Пароль для аутентификации на узле netscaler. | |
| nitro_protocol строка |
| Протокол для доступа к объектам API nitro. |
| nitro_timeout вещественное число | По умолчанию: 310 | Время в секундах до таймаута при установлении нового сеанса с Netscaler |
| nitro_user строка / обязательно | Имя пользователя для аутентификации на узле netscaler. | |
| nsip строка / обязательно | IP-адрес устройства netscaler, к которому будут выполняться вызовы API nitro. Порт можно указать с помощью двоеточия (:). Например, 192.168.1.1:555. | |
| oracleserverversion строка |
| Версия сервера Oracle. |
| порт строка | Номер порта для виртуального сервера переключения контента. Минимальное значение = 1 Диапазон 1 - 65535
* в CLI отображается как 65535 в NITRO API | |
| преимущество строка |
| Тип приоритета для использования как для правил, так и для политик на основе URL на виртуальном сервере переключения контента. При стандартном RULE значении, входящие запросы оцениваются по правилам политики переключения контента. Если ни одно правило не совпадает, URL в запросе оценивается по политике переключения контента на основе URL. |
| push строка |
| Обработка трафика с виртуальным сервером push, привязанным к этому виртуальному серверу переключения контента (указан параметром Push VServer). Тип службы виртуального сервера push должен быть либо HTTP либо SSL. |
| pushlabel строка | Выражение для извлечения метки из ответа, полученного от сервера. Эта строка может быть либо именем существующего правила, либо встроенным выражением. Тип службы виртуального сервера должен быть либо HTTP либо SSL. | |
| pushmulticlients логическое |
| Разрешить несколько подключений Web 2.0 от одного клиента для подключения к виртуальному серверу и ожидания обновлений. |
| pushvserver строка | Имя виртуального сервера балансировки нагрузки типа PUSH или SSL_PUSH, на который сервер отправляет обновления, полученные на виртуальном сервере балансировки нагрузки для клиентов.Минимальная длина = 1 | |
| диапазон строка | Количество последовательных IP-адресов, начиная с адреса, указанного параметром IP-адрес, для включения в диапазон адресов, назначенных этому виртуальному серверу. Минимальное значение = 1
Максимальное значение = 254
| |
| перенаправлениепортаперезапись строка |
| Состояние перезаписи порта при выполнении перенаправления HTTP. |
| перенаправитьurl строка | URL, на который перенаправляется трафик, если виртуальный сервер недоступен. Тип службы виртуального сервера должен быть либо HTTP либо SSL.Предупреждение: Убедитесь, что домен в URL не совпадает с доменом, указанным для политики переключения контента. Если совпадает, запросы постоянно перенаправляются на недоступный виртуальный сервер. Минимальная длина = 1 | |
| rhistate строка |
| Маршрут хоста вставляется в соответствии с настройками виртуальных серверов * Если установлен на PASSIVE на всех виртуальных серверах, разделяющих IP-адрес, устройство всегда вставляет маршрут хоста.* Если установлен на ACTIVE на всех виртуальных серверах, разделяющих IP-адрес, устройство вставляет маршрут, даже если один виртуальный сервер активен.* Если установлен на ACTIVE на некоторых виртуальных серверах и на PASSIVE на других, устройство вставляет маршрут, даже если один виртуальный сервер, установленный на ACTIVE активен. |
| rtspnat логическое |
| Включить трансляцию сетевого адреса (NAT) для подключений протокола реального времени (RTSP). |
| сохранить_конфигурацию логическое |
| Если yes модуль сохранит конфигурацию на узле netscaler, если внесёт какие-либо изменения.Модуль не сохранит конфигурацию на узле netscaler, если не внес никаких изменений. |
| тип_службы строка |
| Протокол, используемый виртуальным сервером. |
| sitedomainttl строка | . Минимальное значение = 1
| |
| sobackupaction строка |
| Действие, которое должно быть выполнено, если переполнение должно вступить в силу, но цепочка резервных копий для переполнения не используется или не существует. |
| somethod строка |
| Тип переполнения, используемый для перенаправления трафика на резервный виртуальный сервер, когда первичный виртуальный сервер достигает порога переполнения. Переполнение соединения основано на количестве подключений. Переполнение полосы пропускания основано на общем значении Kbps входящего и исходящего трафика. |
| sopersistence строка |
| Сохранить постоянство на основе исходного IP-адреса на первичных и резервных виртуальных серверах. |
| sopersistencetimeout строка | Значение таймаута, в минутах, для сохранения переполнения. Минимальное значение = 2
Максимальное значение = 1440
| |
| sothreshold строка | В зависимости от метода переполнения, максимальное количество подключений или максимальная общая пропускная способность (Kbps), которую может обрабатывать виртуальный сервер, прежде чем произойдет переполнение. Минимальное значение = 1
Максимальное значение = 4294967287
| |
| ssl_certkey строка | Имя сертификата ssl, привязанного к этой службе. Сертификат ssl должен уже существовать. Создание сертификата можно выполнить с помощью модуля community.network.netscaler_ssl_certkey. Этот параметр применим только когда servicetype равен SSL. | |
| состояние строка |
| Состояние ресурса, настраиваемого модулем на узле netscaler. При значении «наличие» ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При значении «отсутствует» ресурс будет удалён с узла netscaler. |
| stateupdate строка |
| Включить обновления состояния для определенного виртуального сервера переключения контента. По умолчанию виртуальный сервер переключения контента всегда активен, независимо от состояния связанных с ним виртуальных серверов балансировки нагрузки. Этот параметр взаимодействует со глобальной настройкой следующим образом: Глобальный уровень | Уровень Vserver | Результат enabled enabled enabled enabled disabled enabled disabled enabled enabled disabled disabled disabled Если вы хотите включить обновления состояния только для некоторых виртуальных серверов переключения контента, убедитесь, что параметр обновления состояния отключён. |
| targettype строка |
| Тип целевого виртуального сервера. |
| tcpprofilename строка | Имя профиля TCP, содержащего настройки TCP для виртуального сервера. Минимальная длина = 1 Максимальная длина = 127 |
| td string | Целое значение, уникально идентифицирующее домен трафика, в котором вы хотите настроить сущность. Если вы не укажете идентификатор, сущность станет частью стандартного домена трафика, который имеет идентификатор 0. Минимальное значение = 0 Максимальное значение = 4094 | |
| ttl string | . Минимальное значение = 1 | |
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых вами лично, которые используют собственные подписанные сертификаты. |
| vipheader string | Имя заголовка IP и порта виртуального сервера для использования с параметром VServer IP Port Insertion. Минимальная длина = 1 |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Citrix NetScaler см. на странице 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
community.network.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 dictionary | failure | Список различий между фактически настроенным объектом и конфигурацией, указанной в модуле Пример: {'clttimeout': 'difference. ours: (float) 100.0 other: (float) 60.0'} |
| loglines list / elements=string | всегда | Список сообщений, записанных модулем Пример: ['message 1', 'message 2'] |
| msg string | failure | Сообщение, описывающее причину ошибки Пример: Действие не существует |
Авторы
- George Nikolopoulos (@giorgos-nikolopoulos)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/netscaler_cs_vserver_module.html
