netscaler_cs_vserver - Управление vserver переключения содержимого
Новая версия 2.4.
Описание
- Управление 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 (добавлено в 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 в API NITRO | |
| precedence |
| Тип приоритета для использования для политик на основе правил и URL для виртуального сервера переключения содержимого. При RULE по умолчанию, входящие запросы оцениваются по политикам переключения содержимого на основе правил. Если ни одно из правил не соответствует, URL в запросе оценивается по политикам переключения содержимого на основе URL. |
| push |
| Обработка трафика с виртуальным сервером push, привязанным к этому виртуальному серверу переключения содержимого (указано параметром Push VServer). Тип службы виртуального сервера push должен быть либо HTTP либо SSL. |
| pushlabel | Выражение для извлечения метки из ответа, полученного от сервера. Эта строка может быть либо именем существующего правила, либо встроенным выражением. Тип службы виртуального сервера должен быть либо HTTP либо SSL. | |
| pushmulticlients |
| Разрешить несколько подключений 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-адрес, устройство всегда вставляет hostroute.* Если установлено ACTIVE на всех виртуальных серверах, которые используют IP-адрес, устройство вставляет, даже если один виртуальный сервер активен.* Если установлено ACTIVE на некоторых виртуальных серверах и PASSIVE на других, устройство вставляет, даже если один виртуальный сервер, установленный на ACTIVE активен. |
| rtspnat |
| Включить трансляцию сетевых адресов (NAT) для подключений протокола реального времени потоковой передачи (RTSP). |
| save_config |
| Если истинно, модуль сохранит конфигурацию на узле 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 | Значение по умолчанию: да | Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, которыми вы контролируете, которые используют самозаверенные сертификаты. |
| vipheader | Имя заголовка 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
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 словарь | ошибка | Список различий между фактически настроенным объектом и конфигурацией, указанной в модуле Пример: {'clttimeout': 'различие. наше: (float) 100.0 другое: (float) 60.0'} |
| loglines список | всегда | список зарегистрированных сообщений модуля Пример: ['сообщение 1', 'сообщение 2'] |
| msg строка | ошибка | Сообщение, описывающее причину ошибки Пример: Действие не существует |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Автор
- Георгий Николопулос (@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.5/modules/netscaler_cs_vserver_module.html
