community.network.netscaler_cs_vserver модуль – Управление сервером переключения содержимого
Примечание
Этот модуль является частью коллекции community.network (версия 5.0.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.
Для использования в книге задач укажите: community.network.netscaler_cs_vserver.
Обзор
- Управление сервером переключения содержимого
- Этот модуль предназначен для выполнения как на контрольном узле Ansible, так и на бастионе (шлюзе) с доступом к фактическому экземпляру Netscaler
Псевдонимы: network.netscaler.netscaler_cs_vserver
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- nitro python sdk
Параметры
Параметр | Комментарии |
|---|---|
appflowlog string | Включить логирование информации о потоке AppFlow. Варианты:
|
authentication boolean | Проводить аутентификацию пользователей, запрашивающих подключение к виртуальному серверу переключения контента. Варианты:
|
authenticationhost string | FQDN виртуального сервера аутентификации. Тип сервиса виртуального сервера должен быть либо Минимальная длина = 3 Максимальная длина = 252 |
authn401 boolean | Включить аутентификацию на основе ответа HTTP 401. Варианты:
|
authnprofile string | Имя профиля аутентификации, который будет использоваться, когда аутентификация включена. |
authnvsname string | Имя виртуального сервера аутентификации, который аутентифицирует входящие запросы пользователей к этому виртуальному серверу переключения контента. Минимальная длина = 1 Максимальная длина = 252 |
backupip string | . Минимальная длина = 1 |
backupvserver string | Имя резервного виртуального сервера, который вы настраиваете. Должно начинаться с ASCII буквенно-цифрового или символа подчеркивания Минимальная длина = 1 |
cacheable boolean | Используйте этот параметр, чтобы указать, перенаправляет ли виртуальный сервер, используемый для балансировки нагрузки или переключения контента, запросы на виртуальный сервер перенаправления кэша, прежде чем отправлять их на настроенные серверы. Варианты:
|
casesensitive boolean | Учитывать регистр в URL-адресах (для политик, которые используют URL-адреса вместо ПРАВИЛ). Например, с настройкой Варианты:
|
clttimeout string | Время простоя, в секундах, после которого соединение клиента разрывается. Значения по умолчанию: Минимальное значение = Максимальное значение = |
comment string | Информация об этом виртуальном сервере. |
cookiedomain string | . Минимальная длина = 1 |
cookietimeout string | . Минимальное значение = Максимальное значение = |
dbprofilename string | Имя профиля базы данных. Минимальная длина = 1 Максимальная длина = 127 |
disabled boolean | Когда установлено в Когда установлено в Обратите внимание, что из-за ограничений базового API NITRO изменение состояния Варианты:
|
disableprimaryondown string | Продолжать переадресовывать трафик на резервный виртуальный сервер даже после того, как основной сервер перейдет из состояния DOWN в состояние UP. Варианты:
|
dnsprofilename string | Имя DNS-профиля, который будет связан с VServer. Свойства DNS-профиля будут применены к транзакциям, обрабатываемым VServer. Этот параметр действителен только для VServer DNS и DNS-TCP. Минимальная длина = 1 Максимальная длина = 127 |
domainname string | Доменное имя, для которого необходимо изменить время существования (TTL) и/или резервный IP-адрес службы. Минимальная длина = 1 |
downstateflush string | Очистить все активные транзакции, связанные с виртуальным сервером, состояние которого переходит из UP в DOWN. Не включайте этот параметр для приложений, которым необходимо завершить свои транзакции. Варианты:
|
httpprofilename string | Имя HTTP-профиля, содержащего параметры конфигурации HTTP для виртуального сервера. Тип службы виртуального сервера должен быть либо Минимальная длина = 1 Максимальная длина = 127 |
icmpvsrresponse string | Может быть активным или пассивным. Варианты:
|
insertvserveripport string | Вставить IP-адрес и номер порта виртуального сервера в заголовок запроса. Доступные значения работают следующим образом:
Варианты:
|
ipmask string | IP-маска в точечной десятичной нотации для параметра IP Pattern. Может содержать ведущие или конечные ненулевые октеты (например, |
ippattern string | Шаблон IP-адреса в точечной десятичной нотации для идентификации пакетов, которые должны приниматься виртуальным сервером. Параметр IP Mask указывает, какая часть целевого IP-адреса сопоставляется с шаблоном. Взаимоисключающий с параметром IP Address. Например, если IP-шаблон, назначенный виртуальному серверу, равен Если целевой IP-адрес соответствует нескольким IP-шаблонам, выбирается шаблон с самым длинным совпадением, и связанный с ним виртуальный сервер обрабатывает запрос. Например, если виртуальные серверы |
ipv46 string | IP-адрес виртуального сервера переключения содержимого. Минимальная длина = 1 |
l2conn boolean | Использовать параметры L2 для идентификации соединения. Варианты:
|
lbvserver string | Виртуальный сервер балансировки нагрузки по умолчанию. |
listenpolicy string | Строка, указывающая политику прослушивания для виртуального сервера переключения содержимого. Может быть либо именем существующего выражения, либо встроенным выражением. |
mssqlserverversion string | Версия сервера MSSQL. Варианты:
|
mysqlcharacterset string | Кодировка символов, возвращаемая mysql vserver. |
mysqlprotocolversion string | Версия протокола, возвращаемая mysql vserver. |
mysqlservercapabilities string | Возможности сервера, возвращаемые mysql vserver. |
mysqlserverversion string | Строка версии сервера, возвращаемая mysql vserver. Минимальная длина = 1 Максимальная длина = 31 |
name string | Имя для виртуального сервера переключения содержимого. Должно начинаться с буквенно-цифрового символа ASCII или символа подчеркивания Не может быть изменено после создания виртуального сервера CS. Минимальная длина = 1 |
netprofile string | Имя сетевого профиля. Минимальная длина = 1 Максимальная длина = 127 |
nitro_pass string / required | Пароль для аутентификации на узле Netscaler. |
nitro_protocol string | Протокол, используемый при доступе к объектам API Nitro. Варианты:
|
nitro_timeout float | Время в секундах до возникновения ошибки тайм-аута при установлении нового сеанса с Netscaler. По умолчанию: |
nitro_user string / required | Имя пользователя для аутентификации на узле Netscaler. |
nsip string / required | IP-адрес устройства Netscaler, к которому будут осуществляться вызовы API Nitro. Номер порта может быть указан с помощью двоеточия (:). Например, 192.168.1.1:555. |
oracleserverversion string | Версия сервера Oracle. Варианты:
|
port string | Номер порта для виртуального сервера переключения контента. Минимальное значение = 1 Диапазон * в CLI представлен как 65535 в NITRO API |
precedence string | Тип приоритета, используемый для политик на основе ПРАВИЛ и URL-адресов на виртуальном сервере переключения контента. С настройкой по умолчанию Варианты:
|
push string | Обработка трафика с помощью виртуального сервера push, привязанного к этому виртуальному серверу переключения контента (указан параметром Push VServer). Тип службы виртуального сервера push должен быть либо Варианты:
|
pushlabel string | Выражение для извлечения метки из ответа, полученного от сервера. Эта строка может быть либо существующим именем правила, либо встроенным выражением. Тип службы виртуального сервера должен быть либо |
pushmulticlients boolean | Разрешить нескольким подключениям Web 2.0 от одного клиента подключаться к виртуальному серверу и ожидать обновлений. Варианты:
|
pushvserver string | Имя виртуального сервера балансировки нагрузки типа Минимальная длина = 1 |
range string | Количество последовательных IP-адресов, начиная с адреса, указанного параметром IP-адрес, для включения в диапазон адресов, назначенных этому виртуальному серверу. Минимальное значение = Максимальное значение = |
redirectportrewrite string | Состояние переписывания порта при выполнении HTTP-перенаправления. Варианты:
|
redirecturl string | URL-адрес, на который перенаправляется трафик, если виртуальный сервер становится недоступен. Тип службы виртуального сервера должен быть либо Внимание: Убедитесь, что домен в URL-адресе не совпадает с доменом, указанным для политики переключения контента. Если это так, запросы постоянно перенаправляются на недоступный виртуальный сервер. Минимальная длина = 1 |
rhistate string | Маршрут хоста вставляется в соответствии с настройкой на виртуальных серверах. * Если установлено значение * Если установлено значение * Если установлено значение Варианты:
|
rtspnat boolean | Включить преобразование сетевых адресов (NAT) для подключений протокола потоковой передачи в реальном времени (RTSP). Варианты:
|
save_config boolean | Если Модуль не будет сохранять конфигурацию на узле netscaler, если он не внес никаких изменений. Варианты:
|
servicetype string | Протокол, используемый виртуальным сервером. Варианты:
|
sitedomainttl string | . Минимальное значение = |
sobackupaction string | Действие, которое будет выполнено, если переполнение должно вступить в силу, но нет доступной или существующей резервной цепочки для переполнения. Варианты:
|
somethod string | Тип переполнения, используемый для перенаправления трафика на резервный виртуальный сервер, когда основной виртуальный сервер достигает порогового значения переполнения. Переполнение соединений основано на количестве соединений. Переполнение полосы пропускания основано на общей скорости входящего и исходящего трафика в Кбит/с. Варианты:
|
sopersistence string | Сохранять постоянство на основе исходного IP-адреса на основных и резервных виртуальных серверах. Варианты:
|
sopersistencetimeout string | Значение тайм-аута, в минутах, для постоянства переполнения. Минимальное значение = Максимальное значение = |
sothreshold string | В зависимости от метода переполнения, максимальное количество соединений или максимальная общая пропускная способность (Кбит/с), которую может обрабатывать виртуальный сервер, прежде чем произойдет переполнение. Минимальное значение = Максимальное значение = |
ssl_certkey string | Имя SSL-сертификата, привязанного к этой службе. SSL-сертификат должен уже существовать. Создание сертификата можно выполнить с помощью модуля community.network.netscaler_ssl_certkey. Этот параметр применим только тогда, когда |
state string | Состояние ресурса, настраиваемого модулем на узле netscaler. При наличии ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При отсутствии ресурс будет удален с узла netscaler. Варианты:
|
stateupdate string | Включить обновления состояния для определенного виртуального сервера переключения контента. По умолчанию виртуальный сервер переключения контента всегда находится в состоянии UP, независимо от состояния виртуальных серверов балансировки нагрузки, привязанных к нему. Этот параметр взаимодействует с глобальной настройкой следующим образом: Глобальный уровень | Уровень виртуального сервера | Результат enabled enabled enabled enabled disabled enabled disabled enabled enabled disabled disabled disabled Если вы хотите включить обновления состояния только для некоторых виртуальных серверов переключения контента, обязательно отключите параметр обновления состояния. Варианты:
|
targettype string | Тип целевого виртуального сервера. Варианты:
|
tcpprofilename string | Имя TCP-профиля, содержащего параметры конфигурации TCP для виртуального сервера. Минимальная длина = 1 Максимальная длина = 127 |
td string | Целочисленное значение, однозначно идентифицирующее трафиковый домен, в котором вы хотите настроить сущность. Если вы не укажете ID, сущность станет частью домена трафика по умолчанию, который имеет ID 0. Минимальное значение = 0 Максимальное значение = 4094 |
ttl string | . Минимальное значение = |
validate_certs boolean | Если Варианты:
|
vipheader string | Имя заголовка 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
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 словарь | Список различий между фактически настроенным объектом и конфигурацией, указанной в модуле Возвращается: при ошибке Пример: |
loglines список / элементы=строка | список сообщений, записанных модулем Возвращается: всегда Пример: |
msg строка | Сообщение, описывающее причину ошибки Возвращается: при ошибке Пример: |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/netscaler_cs_vserver_module.html