community.network.netscaler_cs_vserver – Управление сервером переключения содержимого
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Чтобы использовать его в плейбуке, укажите: community.network.netscaler_cs_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, виртуальный сервер переключения контента будет отключен.При установке в no, виртуальный сервер переключения контента будет включен.Обратите внимание, что из-за ограничений базового API NITRO изменение состояния disabled не приводит к изменению статуса в модуле. |
| disableprimaryondown строка |
| Продолжать перенаправление трафика на резервный виртуальный сервер даже после того, как основной сервер перейдет из состояния ВНЕ СТРОЯ в состояние В СТРОЮ. |
| dnsprofilename строка | Имя профиля DNS, который необходимо связать с виртуальным сервером. Свойства профиля DNS будут применяться к транзакциям, обработанным виртуальным сервером. Этот параметр действителен только для виртуальных серверов DNS и DNS-TCP. Минимальная длина = 1 Максимальная длина = 127 | |
| domainname строка | Имя домена, для которого необходимо изменить время жизни (TTL) и/или IP-адрес резервного сервиса. Минимальная длина = 1 | |
| downstateflush строка |
| Очистить все активные транзакции, связанные с виртуальным сервером, состояние которого переходит из В СТРОЮ в ВНЕ СТРОЯ. Не включайте этот параметр для приложений, которым необходимо завершить свои транзакции. |
| httpprofilename строка | Имя профиля HTTP, содержащего параметры конфигурации HTTP для виртуального сервера. Тип службы виртуального сервера должен быть либо HTTP, либо SSL. Минимальная длина = 1 Максимальная длина = 127 | |
| icmpvsrresponse строка |
| Может быть активным или пассивным. |
| insertvserveripport строка |
| Вставить IP-адрес и порт виртуального сервера в заголовок запроса. Доступные значения работают следующим образом: VIPADDR - Заголовок содержит IP-адрес и порт виртуального сервера без каких-либо преобразований.OFF - Параметр вставки заголовка виртуального IP-адреса и порта отключен.V6TOV4MAPPING - Заголовок содержит сопоставленный IPv4-адрес, соответствующий IPv6-адресу виртуального сервера, и номер порта. 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. | |
| mysqlprotocolversion строка | Версия протокола, возвращаемая виртуальным сервером mysql. | |
| mysqlservercapabilities строка | Возможности сервера, возвращаемые виртуальным сервером mysql. | |
| mysqlserverversion строка | Строка версии сервера, возвращаемая виртуальным сервером mysql. Минимальная длина = 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 в API NITRO | |
| precedence строка |
| Тип приоритета для использования для правил на основе RULE и 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-адрес, для включения в диапазон адресов, назначенных этому виртуальному серверу. Минимальное значение = 1
Максимальное значение = 254
| |
| redirectportrewrite строка |
| Состояние перезаписи порта во время выполнения перенаправления HTTP. |
| redirecturl строка | URL, на который перенаправляется трафик, если виртуальный сервер становится недоступным. Тип службы виртуального сервера должен быть либо HTTP либо SSL. Предупреждение: Убедитесь, что домен в URL не совпадает с доменом, указанным для политики переключения контента. В противном случае запросы постоянно перенаправляются на недоступный виртуальный сервер. Минимальная длина = 1 | |
| rhistate строка |
| Маршрут хоста вставляется в соответствии с настройками на виртуальных серверах. * Если установлено PASSIVE на всех виртуальных серверах, которые используют один IP-адрес, устройство всегда вставляет маршрут хоста.* Если установлено ACTIVE на всех виртуальных серверах, которые используют один IP-адрес, устройство вставляет маршрут, даже если один виртуальный сервер активен.* Если установлено ACTIVE на некоторых виртуальных серверах и PASSIVE на других, устройство вставляет маршрут, даже если один виртуальный сервер с ACTIVE активен. |
| rtspnat булево |
| Включить трансляцию сетевого адреса (NAT) для подключений протокола реального времени (RTSP). |
| save_config булево |
| Если yes модуль сохранит конфигурацию на узле netscaler, если внесены какие-либо изменения.Модуль не сохранит конфигурацию на узле netscaler, если изменений не было. |
| servicetype строка |
| Протокол, используемый виртуальным сервером. |
| sitedomainttl строка | . Минимальное значение = 1
| |
| sobackupaction строка |
| Действие, которое будет выполнено, если переполнение должно вступить в силу, но ни одна резервная цепь для переполнения не используется или не существует. |
| somethod строка |
| Тип переполнения, используемый для перенаправления трафика на резервный виртуальный сервер, когда основной виртуальный сервер достигает порога переполнения. Переполнение подключений основано на количестве подключений. Переполнение пропускной способности основано на общей пропускной способности входящего и исходящего трафика. |
| sopersistence строка |
| Поддерживать персистентность на основе исходного IP-адреса на основных и резервных виртуальных серверах. |
| sopersistencetimeout строка | Значение таймаута в минутах для персистентности переполнения. Минимальное значение = 2
Максимальное значение = 1440
| |
| sothreshold строка | В зависимости от метода переполнения, максимальное количество подключений или максимальная общая пропускная способность (Кбит/с), которые может обработать виртуальный сервер перед переполнением. Минимальное значение = 1
Максимальное значение = 4294967287
| |
| ssl_certkey строка | Имя SSL-сертификата, привязанного к этой службе. SSL-сертификат должен уже существовать. Создание сертификата можно выполнить с помощью модуля community.network.netscaler_ssl_certkey. Этот параметр применим только в том случае, когда servicetype SSL. | |
| состояние строка |
| Состояние ресурса, настраиваемого модулем на узле 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 string | Целочисленное значение, уникально идентифицирующее домен трафика, в котором вы хотите настроить сущность. Если вы не укажете идентификатор, сущность станет частью по умолчанию домена трафика, который имеет идентификатор 0. Минимальное значение = 0 Максимальное значение = 4094 | |
| ttl string | . Минимальное значение = 1 | |
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, находящихся под вашим контролем, использующих самозаверяющие сертификаты. |
| vipheader string | Имя заголовка виртуального сервера 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
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 словарь | ошибка | Список различий между фактически настроенным объектом и конфигурацией, указанной в модуле Пример: {'clttimeout': 'различие. наше: (float) 100.0 другое: (float) 60.0'} |
| loglines список / элементы=строка | всегда | список сообщений, записанных модулем Пример: ['сообщение 1', 'сообщение 2'] |
| msg строка | ошибка | Сообщение, подробно описывающее причину ошибки Пример: Действие не существует |
Авторы
- 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.10/collections/community/network/netscaler_cs_vserver_module.html
