netscaler_cs_vserver - Управление сервером переключения содержимого
Новая версия с 2.4.
Описание
- Управление сервером переключения содержимого
- Этот модуль предназначен для работы либо на узле управления ansible, либо на бастионе (шлюзе) с доступом к фактической инстанции netscaler
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- nitro python sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| appflowlog |
| Включить протоколирование информации о потоках appflow. |
| authentication bool |
| Проверять подлинность пользователей, запрашивающих подключение к виртуальному серверу переключения контента. |
| authenticationhost | FQDN виртуального сервера аутентификации. Тип службы виртуального сервера должен быть либо HTTP , либо SSL. Минимальная длина = 3 Максимальная длина = 252 | |
| authn401 bool |
| Включить аутентификацию на основе HTTP 401-ответа. |
| authnprofile | Имя профиля аутентификации, используемого при включенной аутентификации. | |
| authnvsname | Имя виртуального сервера аутентификации, который аутентифицирует входящие запросы пользователей на этом виртуальном сервере переключения контента. . Минимальная длина = 1 Максимальная длина = 252 | |
| backupip | . Минимальная длина = 1 | |
| backupvserver | Имя резервного виртуального сервера, который вы настраиваете. Должен начинаться с символа ASCII-буквы, цифры или подчеркивания _, и содержать только ASCII-буквы, цифры, подчеркивания _, символ решётки #, точку ., пробел, двоеточие :, символ "@" @, знак равенства =, и тире -. Можно изменить после создания резервного виртуального сервера. Вы можете назначить другой резервный виртуальный сервер или переименовать существующий виртуальный сервер.Минимальная длина = 1 | |
| cacheable bool |
| Используйте этот параметр, чтобы указать, перенаправляет ли виртуальный сервер, используемый для балансировки нагрузки или переключения контента, запросы на виртуальный сервер перенаправления кэша перед отправкой их на настроенные сервера. |
| casesensitive bool |
| Учитывать регистр в 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 bool |
| При значении yes, виртуальный сервер CS будет отключен.При значении no, виртуальный сервер CS будет включен.Обратите внимание, что из-за ограничений базового 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-адреса назначения в запросе клиента с соответствующими битами в 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 | Используйте параметры L2 для идентификации соединения. | |
| lbvserver (добавлено в 2.5) | Виртуальный сервер балансировки нагрузки по умолчанию. | |
| listenpolicy | Строка, определяющая политику прослушивания для виртуального сервера переключения контента. Может быть именем существующей выражения или встроенным выражением. | |
| mssqlserverversion |
| Версия сервера 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 |
| Протокол для доступа к объектам API nitro. |
| nitro_timeout | По умолчанию: 310 | Время в секундах до таймаута при установлении нового сеанса с Netscaler |
| nitro_user обязательно | Имя пользователя для аутентификации на узле netscaler. | |
| nsip обязательно | IP-адрес устройства netscaler, на котором будут выполняться вызовы API nitro. Порт можно указать с двоеточием (:). Например, 192.168.1.1:555. | |
| oracleserverversion |
| Версия сервера Oracle. |
| port | Номер порта для виртуального сервера коммутации контента. Минимальное значение = 1 Диапазон 1 - 65535
* в CLI представлено как 65535 в NITRO API | |
| precedence |
| Тип приоритета для использования для правил на основе RULE и URL для виртуального сервера коммутации контента. При стандартном значении RULE входящие запросы оцениваются по правилам коммутации контента. Если ни одно из правил не соответствует, URL запроса оценивается по правилам URL коммутации контента. |
| push |
| Обработка трафика с виртуальным сервером push, связанным с этим виртуальным сервером коммутации контента (указывается параметром Push VServer). Тип службы виртуального сервера push должен быть HTTP или SSL. |
| pushlabel | Выражение для извлечения метки из ответа сервера. Эта строка может быть именем существующего правила или встроенным выражением. Тип службы виртуального сервера должен быть HTTP или SSL. | |
| pushmulticlients bool |
| Разрешить несколько подключений Web 2.0 от одного клиента для подключения к виртуальному серверу и ожидания обновлений. |
| pushvserver | Имя виртуального сервера балансировки нагрузки типа PUSH или SSL_PUSH, которому сервер отправляет обновления, полученные на виртуальном сервере балансировки нагрузки, обращенном к клиенту.Минимальная длина = 1 | |
| range | Количество последовательных IP-адресов, начиная с адреса, указанного параметром IP Address, включенных в диапазон адресов, назначенных этому виртуальному серверу. Минимальное значение = 1
Максимальное значение = 254
| |
| redirectportrewrite |
| Состояние изменения порта при выполнении HTTP перенаправления. |
| redirecturl | URL, на который перенаправляется трафик, если виртуальный сервер становится недоступным. Тип службы виртуального сервера должен быть HTTP или SSL. Внимание: Убедитесь, что домен в URL не соответствует домену, указанному для политики коммутации контента. Если совпадает, запросы постоянно перенаправляются на недоступный виртуальный сервер. Минимальная длина = 1 | |
| rhistate |
| Маршрут хоста вводится в соответствии с настройками на виртуальных серверах * Если установлено PASSIVE на всех виртуальных серверах, которые используют IP-адрес, устройство всегда вводит маршрут хоста.* Если установлено ACTIVE на всех виртуальных серверах, которые используют IP-адрес, устройство вводит маршрут хоста даже если один виртуальный сервер активен.* Если установлено ACTIVE на некоторых виртуальных серверах и PASSIVE на других, устройство вводит маршрут хоста даже если один виртуальный сервер со значением ACTIVE активен. |
| rtspnat bool |
| Включить трансляцию сетевых адресов (NAT) для подключений протокола реального времени потоковой передачи (RTSP). |
| save_config bool |
| Если значение true, модуль сохранит конфигурацию на узле netscaler, если были внесены изменения. Модуль не сохранит конфигурацию на узле netscaler, если изменений не было. |
| servicetype |
| Протокол, используемый виртуальным сервером. |
| sitedomainttl | . Минимальное значение = 1
| |
| sobackupaction |
| Действие, которое должно быть выполнено, если произойдёт переполнение, но нет или невозможна цепочка резервного копирования для переполнения. |
| somethod |
| Тип переполнения для перенаправления трафика на резервный виртуальный сервер, когда первичный виртуальный сервер достигает порога переполнения. Переполнение по подключениям основано на количестве подключений. Переполнение по пропускной способности основано на общем значении Kbps входящего и исходящего трафика. |
| sopersistence |
| Поддерживать персистентность на основе исходного IP-адреса на первичных и резервных виртуальных серверах. |
| sopersistencetimeout | Значение таймаута для персистентности переполнения в минутах. Минимальное значение = 2
Максимальное значение = 1440
| |
| sothreshold | В зависимости от метода переполнения, максимальное число подключений или максимальная общая пропускная способность (Kbps), которую может обработать виртуальный сервер перед возникновением переполнения. Минимальное значение = 1
Максимальное значение = 4294967287
| |
| ssl_certkey (добавлено в 2.5) | Имя сертификата ssl, привязанного к этой службе. Сертификат ssl должен уже существовать. Создание сертификата можно выполнить с помощью модуля netscaler_ssl_certkey. Этот параметр применим только когда servicetype значение SSL. | |
| state |
| Состояние ресурса, настраиваемого модулем на узле netscaler. При значении present ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При значении absent ресурс будет удален с узла netscaler. |
| stateupdate |
| Включить обновления состояния для определенного виртуального сервера коммутации контента. По умолчанию, виртуальный сервер коммутации контента всегда активен, независимо от состояния связанных с ним виртуальных серверов балансировки нагрузки. Этот параметр взаимодействует со глобальной настройкой следующим образом: Глобальный уровень | Уровень VServer | Результат enabled enabled enabled enabled disabled enabled disabled enabled enabled disabled disabled disabled Если необходимо включить обновления состояния только для некоторых виртуальных серверов коммутации контента, отключите параметр обновления состояния. |
| targettype |
| Тип целевого виртуального сервера. |
| tcpprofilename | Имя TCP профиля, содержащего настройки TCP для виртуального сервера. Минимальная длина = 1 Максимальная длина = 127 | |
| td | Целое число, которое однозначно идентифицирует домен трафика, в котором вы хотите настроить сущность. Если вы не укажете идентификатор, сущность станет частью стандартного домена трафика, который имеет идентификатор 0. Минимальное значение = 0 Максимальное значение = 4094 | |
| ttl | . Минимальное значение = 1
| |
| validate_certs | По умолчанию: "yes" | Если no, сертификаты SSL не будут проверяться. Это следует использовать только на сайтах, контролируемых лично, с самозаверяющими сертификатами. |
| vipheader | Имя заголовка виртуального сервера IP и порта, для использования с параметром VServer IP Port Insertion. Минимальная длина = 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 dict | неудача | Список различий между фактически настроенным объектом и конфигурацией, указанной в модуле Пример: {'clttimeout': 'различие. наше: (float) 100.0 другое: (float) 60.0'} |
| loglines list | всегда | список зарегистрированных сообщений модуля Пример: ['сообщение 1', 'сообщение 2'] |
| msg str | неудача | Сообщение, описывающее причину сбоя Пример: Действие не существует |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Более подробную информацию см. в Техническое обслуживание и поддержка модулей.
Список других модулей, которые также поддерживаются сообществом 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.6/modules/netscaler_cs_vserver_module.html
