netscaler_cs_vserver – Управление сервером переключения содержимого
Новая версия 2.4.
Описание
- Управление сервером переключения содержимого
- Этот модуль предназначен для работы либо на узле управления Ansible, либо на бастионе (шлюзе), имеющем доступ к фактической инстанции netscaler.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- nitro python sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| appflowlog - |
| Включить протоколирование информации о потоках приложений. |
| authentication boolean |
| Проверять подлинность пользователей, запрашивающих подключение к виртуальному серверу переключения контента. |
| authenticationhost - | FQDN сервера аутентификации. Тип службы виртуального сервера должен быть либо HTTP, либо SSL. Минимальная длина = 3 Максимальная длина = 252 | |
| authn401 boolean |
| Включить аутентификацию на основе HTTP-ответа 401. |
| authnprofile - | Имя профиля аутентификации, используемого при включенной аутентификации. | |
| authnvsname - | Имя виртуального сервера аутентификации, который аутентифицирует входящие запросы пользователей на этот виртуальный сервер переключения контента. Минимальная длина = 1 Максимальная длина = 252 | |
| backupip - | . Минимальная длина = 1 | |
| backupvserver - | Имя резервного виртуального сервера, который вы настраиваете. Должен начинаться с символа ASCII алфавитно-цифрового или нижнего подчеркивания _, и должен содержать только символы ASCII алфавитно-цифровые, нижнего подчеркивания _, хэша #, точки ., пробела, двоеточия :, знака «@» @, знака равенства =, и дефиса -. Может быть изменён после создания резервного виртуального сервера. Вы можете назначить другой резервный виртуальный сервер или переименовать существующий виртуальный сервер.Минимальная длина = 1 | |
| cacheable boolean |
| Используйте этот параметр, чтобы указать, будет ли виртуальный сервер, используемый для балансировки нагрузки или переключения контента, направлять запросы на виртуальный сервер перенаправления кеша перед отправкой их на настроенные серверы. |
| casesensitive boolean |
| Учитывать регистр в 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 |
| При установке в yes, cs vserver будет выключен.При установке в no, cs vserver будет включен.Обратите внимание, что из-за ограничений базового API NITRO изменение состояния disabled не приводит к изменению статуса в модуле результата. |
| disableprimaryondown - |
| Продолжать пересылку трафика на резервный виртуальный сервер даже после того, как основной сервер перешел из состояния DOWN в UP. |
| dnsprofilename - | Имя профиля DNS, которое должно быть связано с VServer. Свойства профиля DNS будут применяться к транзакциям, обрабатываемым VServer. Этот параметр действителен только для VServer DNS и DNS-TCP. Минимальная длина = 1 Максимальная длина = 127 | |
| domainname - | Имя домена, для которого необходимо изменить время жизни (TTL) и/или IP-адрес резервного сервиса. Минимальная длина = 1 | |
| downstateflush - |
| Очистить все активные транзакции, связанные с виртуальным сервером, состояние которого переходит из UP в DOWN. Не включайте этот параметр для приложений, которые должны завершить свои транзакции. |
| httpprofilename - | Имя профиля HTTP, содержащего настройки HTTP для виртуального сервера. Тип службы виртуального сервера должен быть либо HTTP, либо SSL.Минимальная длина = 1 Максимальная длина = 127 | |
| icmpvsrresponse - |
| Может быть активным или пассивным. |
| insertvserveripport - |
| Вставить IP-адрес и порт виртуального сервера в заголовок запроса. Доступные значения работают следующим образом: VIPADDR - Заголовок содержит IP-адрес и порт vserver без каких-либо переводов.OFF - Вставка IP и порта виртуального 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 - added in 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 - |
| Тип приоритета для использования для политик на основе правил и URL-адресов на виртуальном сервере переключения контента. При RULE по умолчанию, входящие запросы оцениваются по правилам переключения контента. Если ни одно из правил не соответствует, URL в запросе оценивается по политикам переключения контента на основе URL. |
| push - |
| Обработка трафика с виртуальным сервером push, связанным с этим виртуальным сервером переключения контента (указано в параметре Push VServer). Тип сервиса виртуального сервера push должен быть HTTP или SSL. |
| pushlabel - | Выражение для извлечения метки из ответа, полученного от сервера. Эта строка может быть именем существующего правила или встроенным выражением. Тип сервиса виртуального сервера должен быть HTTP или SSL. | |
| pushmulticlients boolean |
| Разрешить несколько подключений 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 boolean |
| Включить трансляцию сетевых адресов (NAT) для соединений протокола реального времени потоковой передачи (RTSP). |
| save_config boolean |
| Если true, модуль сохранит конфигурацию на узле netscaler, если были внесены изменения. Модуль не сохранит конфигурацию на узле netscaler, если не было изменений. |
| servicetype - |
| Протокол, используемый виртуальным сервером. |
| sitedomainttl - | . Минимальное значение = 1
| |
| sobackupaction - |
| Действие, которое будет выполнено, если переполнение должно вступить в силу, но нет или нет доступной резервной цепочки для переполнения. |
| somethod - |
| Тип переполнения, используемого для перенаправления трафика на резервный виртуальный сервер, когда первичный виртуальный сервер достигает порога переполнения. Переполнение соединения основано на количестве подключений. Переполнение полосы пропускания основано на общем количестве Кбит/с входящего и исходящего трафика. |
| sopersistence - |
| Поддерживать персистентность на основе исходного IP-адреса на первичном и резервном виртуальных серверах. |
| sopersistencetimeout - | Значение таймаута, в минутах, для персистентности переполнения. Минимальное значение = 2
Максимальное значение = 1440
| |
| sothreshold - | В зависимости от метода переполнения, максимальное количество подключений или максимальная общая пропускная способность (Кбит/с), которую может обрабатывать виртуальный сервер перед переполнением. Минимальное значение = 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 и порта виртуального сервера для использования с параметром вставки IP и порта VServer. Минимальная длина = 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 словарь | 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.7/modules/netscaler_cs_vserver_module.html
