netscaler_service – Управление конфигурацией службы в Netscaler

Новое в версии 2.4.0.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Управление конфигурацией службы в Netscaler.
Этот модуль позволяет создавать, удалять и изменять службы Netscaler.
Этот модуль предназначен для работы либо на узле управления Ansible, либо на бастионе (шлюзе) с доступом к фактической инстанции netscaler.
Этот модуль поддерживает режим проверки.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

nitro python sdk

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
accessdown boolean		Варианты: нет ← да	Использовать режим уровня 2 для перенаправления пакетов, отправленных в эту службу, если она отмечена как ВЫКЛЮЧЕНА. Если служба ВЫКЛЮЧЕНА, и этот параметр отключён, пакеты будут отброшены.
appflowlog -		Варианты: включено выключено	Включить протоколирование информации AppFlow.
cacheable boolean		Варианты: нет ← да	Использовать виртуальный сервер прозрачного кеширования для перенаправления запросов на сервер кеширования. Примечание: не указывайте этот параметр, если вы установили параметр Тип кеширования.
cachetype -		Варианты: ПРОЗРАЧНЫЙ ОБРАТНЫЙ ПРЯМОЙ	Тип кеширования, поддерживаемый сервером кеширования.
cip -		Варианты: включено выключено	Перед переадресацией запроса на службу вставить заголовок HTTP с IP-адресом клиента (IPv4 или IPv6) в качестве значения. Используется, если серверу необходим IP-адрес клиента для обеспечения безопасности, учёта или других целей, и использование параметра Использовать IP-адрес источника не является подходящим вариантом.
cipheader -			Имя заголовка HTTP, значение которого должно быть установлено в IP-адрес клиента. Используется с параметром IP-адрес клиента. Если вы устанавливаете параметр IP-адрес клиента, и не указываете имя заголовка, устройство использует имя заголовка, указанное для глобального параметра Заголовок IP-адреса клиента (параметр cipHeader в команде CLI set ns param или параметр Заголовок IP-адреса клиента в диалоговом окне Настройка параметров HTTP в разделе Система > Настройки > Изменить параметры HTTP). Если глобальный параметр Заголовок IP-адреса клиента не указан, устройство вставляет заголовок с именем «client-ip». Минимальная длина = 1
cka boolean		Варианты: нет да	Включить поддержку keep-alive для клиента в службе.
cleartextport -			Порт, на который должны быть отправлены данные в открытом виде после расшифровки устройства входящего SSL-трафика. Применимо к прозрачным SSL-службам. Минимальное значение = 1
clttimeout -			Время в секундах, после которого следует завершить неактивное соединение клиента. Минимальное значение = 0 Максимальное значение = 31536000
cmp boolean		Варианты: нет да	Включить сжатие для службы.
comment -			Любая информация о службе.
customserverid -		По умолчанию: "Нет"	Уникальный идентификатор службы. Используется, когда тип сохранения для виртуального сервера установлен на «Пользовательский идентификатор сервера».
disabled boolean		Варианты: нет ← да	При установке в `yes` состояние службы будет установлено в ВЫКЛЮЧЕНО. При установке в `no` состояние службы будет установлено в ВКЛЮЧЕНО. Обратите внимание, что из-за ограничений в базовом API NITRO изменение состояния `disabled` в одиночку не приводит к тому, что модуль отображает изменение статуса.
dnsprofilename -			Имя профиля DNS, которое должно быть связано со службой. Свойства профиля DNS будут применены к операциям, обрабатываемым службой. Этот параметр действителен только для служб ADNS и ADNS-TCP. Минимальная длина = 1 Максимальная длина = 127
downstateflush -		Варианты: включено выключено	Очистить все активные операции, связанные со службой, состояние которой переходит из ВКЛЮЧЕНО в ВЫКЛЮЧЕНО. Не включайте этот параметр для приложений, которые должны завершить свои операции.
graceful boolean		Варианты: нет ← да	Произвести плавное завершение, не принимая новые соединения и отключив службу, когда все её соединения будут закрыты.
hashid -			Числовой идентификатор, который может использоваться методами балансировки нагрузки на основе хеширования. Должен быть уникальным для каждой службы. Минимальное значение = 1
healthmonitor boolean		Варианты: нет да ←	Мониторить состояние этой службы
httpprofilename -			Имя профиля HTTP, содержащего параметры конфигурации HTTP для службы. Минимальная длина = 1 Максимальная длина = 127
ip -			IP-адрес, который нужно назначить службе. Минимальная длина = 1
ipaddress -			Новый IP-адрес службы.
maxbandwidth -			Максимальная пропускная способность, в Кбит/с, выделенная для службы. Минимальное значение = 0 Максимальное значение = 4294967287
maxclient -			Максимальное количество одновременных открытых соединений со службой. Минимальное значение = 0 Максимальное значение = 4294967294
maxreq -			Максимальное количество запросов, которые могут быть отправлены по постоянно открытому соединению со службой. Примечание: запросы на подключение, превышающие это значение, отклоняются. Минимальное значение = 0 Максимальное значение = 65535
monitor_bindings -			Список мониторов балансировки нагрузки, которые нужно привязать к этой службе. Каждая запись монитора — это словарь, который может содержать следующие параметры. Примечание: если вы не используете встроенные мониторы, их сначала необходимо настроить.
	dup_state -	Варианты: включено выключено	Состояние монитора. Установленное значение состояния для монитора определенного типа влияет на все мониторы этого типа. Например, если монитор HTTP включен, все мониторы HTTP на устройстве включены (или остаются включенными). Если монитор HTTP отключён, все мониторы HTTP на устройстве отключены.
	dup_weight -		Вес, который нужно присвоить привязке между монитором и службой.
	monitorname -		Имя монитора.
	weight -		Вес, который нужно присвоить привязке между монитором и службой.
monthreshold -			Минимальная сумма весов мониторов, привязанных к данной службе. Используется для определения, нужно ли отмечать службу как ВКЛЮЧЕНО или ВЫКЛЮЧЕНО. Минимальное значение = 0 Максимальное значение = 65535
name -			Имя службы. Должно начинаться с ASCII-буквы или символа нижнего подчеркивания `_`, и должно содержать только ASCII-буквы, цифры, символ нижнего подчеркивания `_`, символ решётки `#`, точку `.`, пробел, двоеточие `:`, символ «@» `@`, символ «=» `=`, и дефис `-`. Не может быть изменено после создания службы. Минимальная длина = 1
netprofile -			Профиль сети, который нужно использовать для службы. Минимальная длина = 1 Максимальная длина = 127

nitro_pass строка / обязательно		Пароль для аутентификации на узле netscaler.
nitro_protocol строка	Варианты: http ← https	Протокол для доступа к объектам API nitro.
nitro_timeout число с плавающей точкой	По умолчанию: 310	Время в секундах до возникновения ошибки таймаута при установлении нового сеанса с Netscaler
nitro_user строка / обязательно		Имя пользователя для аутентификации на узле netscaler.
nsip строка / обязательно		IP-адрес устройства netscaler, к которому будут выполняться вызовы API nitro. Порт можно указать с двоеточием (:). Например, 192.168.1.1:555.
pathmonitor -		Мониторинг путей для кластеризации.
pathmonitorindv -		Индивидуальные решения по мониторингу путей.
port -		Номер порта службы. Диапазон 1 - 65535 * в CLI представлен как 65535 в NITRO API
processlocal -	Варианты: enabled disabled	Включив этот параметр, пакеты, предназначенные для службы в кластере, не будут подвергаться перенаправлению. Включите этот параметр для режима запроса-ответа на основе одиночных пакетов или когда верхнее устройство выполняет правильный RSS для распределения на основе соединений.
rtspsessionidremap булево	Варианты: no ← yes	Включить сопоставление идентификаторов сеансов RTSP для службы.
save_config булево	Варианты: no yes ←	Если `yes`, модуль сохранит конфигурацию на узле netscaler, если внесёт какие-либо изменения. Модуль не сохранит конфигурацию на узле netscaler, если не внесён никаких изменений.
serverid -		Идентификатор службы. Используется, когда тип персистентности задан как Custom Server ID.
servername -		Имя сервера, на котором размещена служба. Минимальная длина = 1
servicetype -	Варианты: HTTP FTP TCP UDP SSL SSL_BRIDGE SSL_TCP DTLS NNTP RPCSVR DNS ADNS SNMP RTSP DHCPRA ANY SIP_UDP SIP_TCP SIP_SSL DNS_TCP ADNS_TCP MYSQL MSSQL ORACLE RADIUS RADIUSListener RDP DIAMETER SSL_DIAMETER TFTP SMPP PPTP GRE SYSLOGTCP SYSLOGUDP FIX SSL_FIX	Протокол обмена данными со службой.
sp булево	Варианты: no yes	Включить защиту от всплеска для службы.
state строка	Варианты: absent present ←	Состояние ресурса, настраиваемого модулем на узле netscaler. В случае present, ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. В случае absent, ресурс будет удалён с узла netscaler.
svrtimeout -		Время в секундах, после которого будет прервано неактивное соединение сервера. Минимальное значение = 0 Максимальное значение = 31536000
tcpb булево	Варианты: no yes	Включить буферизацию TCP для службы.
tcpprofilename -		Имя TCP-профиля, содержащего настройки TCP для службы. Минимальная длина = 1 Максимальная длина = 127
td -		Целочисленное значение, которое однозначно идентифицирует домен трафика, в котором вы хотите настроить сущность. Если вы не укажете идентификатор, сущность станет частью стандартного домена трафика, у которого идентификатор 0. Минимальное значение = 0 Максимальное значение = 4094
useproxyport булево	Варианты: no yes	Использовать порт прокси в качестве исходного порта при установлении соединений с сервером. С настройкой NO используется порт подключения на стороне клиента в качестве исходного порта для подключения на стороне сервера. Примечание: этот параметр доступен только в том случае, если параметр Использовать исходный IP (USIP) установлен в значение ДА.
usip булево	Варианты: no yes	Использовать IP-адрес клиента в качестве исходного IP-адреса при установлении соединения с сервером. При создании службы, если вы не установите этот параметр, служба наследует глобальную настройку Использовать исходный IP (доступна в командах CLI enable ns mode и disable ns mode или в диалоговом окне System > Settings > Configure modes > Configure Modes). Однако вы можете переопределить эту настройку после создания службы.
validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяющие сертификаты.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Citrix NetScaler Network см. на странице https://www.ansible.com/ansible-netscaler.

Примеры

# Monitor monitor-1 must have been already setup

- name: Setup http service
  gather_facts: False
  delegate_to: localhost
  netscaler_service:
    nsip: 172.18.0.2
    nitro_user: nsroot
    nitro_pass: nsroot

    state: present

    name: service-http-1
    servicetype: HTTP
    ipaddress: 10.78.0.1
    port: 80

    monitor_bindings:
      - monitor-1

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
diff словарь	failure	Словарь со списком различий между фактически настроенным объектом и конфигурацией, указанной в модуле Пример: { 'clttimeout': 'difference. ours: (число с плавающей точкой) 10.0 other: (число с плавающей точкой) 20.0' }
loglines список	всегда	Список сообщений, записанных модулем Пример: ['сообщение 1', 'сообщение 2']

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом 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.9/modules/netscaler_service_module.html