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 будет выключен.При установке в значение 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-паттерна. Может содержать ведущие или хвостовые ненулевые октеты (например, 255.255.240.0 или 0.0.255.255). Соответственно, маска определяет, соответствуют ли первые n биты или последние n биты адреса назначения в запросе клиента соответствующим битам в IP-паттерне. Первый случай называется прямой маской. Второй — обратной маской. | ||
| ippattern | нет | IP-паттерн в обозначении с точками и десятичными знаками для идентификации пакетов, которые должны приниматься виртуальным сервером. Параметр IP-маски определяет, какая часть адреса назначения соответствует шаблону. Взаимоисключающие с параметром IP-адрес. Например, если 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 для идентификации подключения. | ||
| 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 | нет | http |
| Протокол, используемый при доступе к объектам 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 | нет |
| Разрешить несколько подключений 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 | нет |
| Включить трансляцию сетевого адреса (NAT) для подключений протокола потоковой передачи в реальном времени (RTSP). | |
| save_config | нет | True |
| Если True, модуль сохранит конфигурацию на узле netscaler, если внесет какие-либо изменения. Модуль не сохранит конфигурацию на узле netscaler, если не внес никаких изменений. |
| servicetype | нет |
| Протокол, используемый виртуальным сервером. | |
| sitedomainttl | нет | . Минимальное значение = 1
| ||
| sobackupaction | нет |
| Действие, которое будет выполнено, если произойдет переполнение, но нет или недоступна резервная цепочка для переполнения. | |
| somethod | нет |
| Тип переполнения, используемого для перенаправления трафика на резервный виртуальный сервер, когда первичный виртуальный сервер достигает порога переполнения. Переполнение по подключениям основано на количестве подключений. Переполнение по пропускной способности основано на общей пропускной способности входящего и исходящего трафика. | |
| sopersistence | нет |
| Сохранить постоянство на основе исходного IP-адреса на первичном и резервном виртуальных серверах. | |
| sopersistencetimeout | нет | Значение таймаута, в минутах, для постоянства переполнения. Минимальное значение = 2
Максимальное значение = 1440
| ||
| sothreshold | нет | В зависимости от метода переполнения, максимальное количество подключений или максимальная общая пропускная способность (Кбит/с), которую может обрабатывать виртуальный сервер, прежде чем произойдет переполнение. Минимальное значение = 1
Максимальное значение = 4294967287
| ||
| state | нет | present |
| Состояние ресурса, настраиваемого модулем на узле 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 |
Примеры
# 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 | dict | {'clttimeout': 'различие. наше: (float) 100.0 другое: (float) 60.0'} |
| loglines | Список сообщений, зарегистрированных модулем | всегда | list | ['сообщение 1', 'сообщение 2'] |
| msg | Сообщение, описывающее причину ошибки | failure | str | Действие не существует |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Для получения помощи в разработке модулей, если вы этого захотите, пожалуйста, прочитайте Информация о сообществе и сотрудничество, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/netscaler_cs_vserver_module.html
