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

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

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

Описание

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

Требования

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

nitro python sdk

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
accessdown -		По умолчанию: "нет"	Использовать режим уровня 2 для перепривязки пакетов, отправленных этому сервису, если он помечен как НЕАКТИВЕН. Если сервис НЕАКТИВЕН, и этот параметр отключен, пакеты отбрасываются.
appflowlog -		Варианты: включено выключено	Включить протоколирование информации AppFlow.
cacheable -		По умолчанию: "нет"	Использовать виртуальный сервер прозрачной перенаправленя кэша для пересылки запросов на сервер кэша. Примечание: Не указывайте этот параметр, если вы установили параметр Тип кэша.
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 -			Включить keep-alive для клиента для сервиса.
cleartextport -			Порт, на который должны отправляться данные в открытом виде после расшифровки устройством входящего SSL-трафика. Применимо к прозрачным SSL-сервисам. Минимальное значение = 1
clttimeout -			Время в секундах, после которого следует завершить неактивное клиентское соединение. Минимальное значение = 0 Максимальное значение = 31536000
cmp -			Включить сжатие для сервиса.
comment -			Любая информация о сервисе.
customserverid -		По умолчанию: "Нет"	Уникальный идентификатор для сервиса. Используется, когда тип сохранения для виртуального сервера установлен на "Уникальный идентификатор сервера".
disabled boolean		Варианты: нет ← да	При установке в `yes` состояние сервиса будет установлено в ВЫКЛЮЧЕНО. При установке в `no` состояние сервиса будет установлено в ВКЛЮЧЕНО. Обратите внимание, что из-за ограничений базового API NITRO, изменение состояния `disabled` не приводит к тому, что модуль результата сообщит об изменении статуса.
dnsprofilename -			Имя профиля DNS, которое должно быть связано с сервисом. Свойства профиля DNS будут применяться к транзакциям, обрабатываемым сервисом. Этот параметр действителен только для сервисов ADNS и ADNS-TCP. Минимальная длина = 1 Максимальная длина = 127
downstateflush -		Варианты: включено выключено	Очистить все активные транзакции, связанные с сервисом, состояние которого переходит из ВКЛЮЧЕНО в ВЫКЛЮЧЕНО. Не включайте этот параметр для приложений, которые должны завершить свои транзакции.
graceful -		По умолчанию: "нет"	Плавно выключиться, не принимая новых подключений и отключив сервис, когда все его подключения закрыты.
hashid -			Числовой идентификатор, который может использоваться методами балансировки нагрузки на основе хеширования. Должен быть уникальным для каждого сервиса. Минимальное значение = 1
healthmonitor -		По умолчанию: "да"	Мониторить состояние этого сервиса
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"	Включить отображение ID сеанса RTSP для сервиса.
save_config boolean	Варианты: no yes ←	Если true, модуль сохранит конфигурацию на узле 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 -		Включить защиту от импульсных помех для сервиса.
state -	Варианты: present ← absent	Состояние ресурса, настраиваемого модулем на узле NetScaler. При present ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При absent ресурс будет удален с узла NetScaler.
svrtimeout -		Время в секундах, после которого будет разорвано неактивное подключение сервера. Минимальное значение = 0 Максимальное значение = 31536000
tcpb -		Включить буферизацию TCP для сервиса.
tcpprofilename -		Имя профиля TCP, содержащего параметры конфигурации TCP для сервиса. Минимальная длина = 1 Максимальная длина = 127
td -		Целочисленное значение, уникально идентифицирующее домен трафика, в котором требуется настройка сущности. Если не указать ID, сущность станет частью по умолчанию домена трафика, у которого ID 0. Минимальное значение = 0 Максимальное значение = 4094
useproxyport -		Использовать порт прокси в качестве исходного порта при установлении соединений с сервером. С установкой NO используется порт подключения клиента в качестве исходного порта для подключения сервера. Примечание: этот параметр доступен только при установке параметра Использовать исходный IP-адрес (USIP) в значение YES.
usip -		Использовать IP-адрес клиента в качестве исходного IP-адреса при установлении соединения с сервером. При создании сервиса, если этот параметр не задан, сервис наследует глобальную настройку «Использовать исходный IP-адрес» (доступна в командах CLI enable ns mode и disable ns mode, или в диалоговом окне System > Settings > Configure modes > Configure Modes). Однако вы можете переопределить эту настройку после создания сервиса.
validate_certs -	По умолчанию: "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 словарь	неудача	Словарь с списком различий между фактически настроенным объектом и конфигурацией, указанной в модуле Пример: { 'clttimeout': 'difference. ours: (float) 10.0 other: (float) 20.0' }
loglines список	всегда	список сообщений, записанных модулем Пример: ['message 1', 'message 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.7/modules/netscaler_service_module.html