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

Новая в версии 2.4.

Синопсис
Требования (к хосту, на котором выполняется модуль)
Параметры
Примеры
Возвращаемые значения
- Статус

Синопсис

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

Требования (к хосту, на котором выполняется модуль)

nitro python sdk

Параметры

параметр обязательный значение по умолчанию значения комментарии

appflowlog

нет

enabled
disabled

Включить протоколирование информации AppFlow для указанной группы сервисов.

autoscale

нет

DISABLED
DNS
POLICY

Опция автоматического масштабирования для группы сервисов.

cacheable

нет

да
нет

Использовать виртуальный сервер прозрачного кэширования для перенаправления запроса на сервер кэша.

Примечание: Не устанавливайте этот параметр, если задан тип кэша.

cachetype

нет

TRANSPARENT
REVERSE
FORWARD

Тип кэша, поддерживаемый сервером кэша.

cip

нет

enabled
disabled

Вставить заголовок Client IP в запросы, перенаправленные на сервис.

cipheader

нет

Имя HTTP-заголовка, значение которого должно быть установлено на IP-адрес клиента. Используется с параметром Client IP. Если включена вставка IP-адреса клиента, а заголовок IP-адреса клиента не указан, используется значение параметра Client IP Header или значение, установленное командой set ns config, как имя заголовка IP-адреса клиента.

Минимальная длина = 1

cka

нет

да
нет

Включить клиентский keep-alive для группы сервисов.

clttimeout

нет

Время в секундах, после которого прекращается бездействующее клиентское соединение.

Минимальное значение = 0

Максимальное значение = 31536000

cmp

нет

да
нет

Включить сжатие для указанного сервиса.

comment

нет

Любая информация о группе сервисов.

disabled

нет

да
нет

При установке значения yes состояние группы сервисов установится в DISABLED.

При установке значения no состояние группы сервисов установится в ENABLED.

Обратите внимание, что из-за ограничений базового API NITRO изменение состояния disabled не приводит к тому, что модуль сообщает о изменении статуса.

downstateflush

нет

enabled
disabled

Очистить все активные транзакции, связанные со всеми сервисами в группе сервисов, чье состояние переходит с UP на DOWN. Не включайте эту опцию для приложений, которые должны завершить свои транзакции.

graceful

нет

да
нет

Подождать завершения всех существующих подключений к сервису перед отключением сервиса.

healthmonitor

нет

да
нет

Отслеживать состояние данного сервиса. Доступные настройки функционируют следующим образом:

yes - Отправлять запросы для проверки состояния сервиса.

no - Не отправлять запросы для проверки состояния сервиса. В этом случае устройство всегда показывает сервис как UP.

httpprofilename

нет

Имя HTTP-профиля, содержащего настройки HTTP для группы сервисов.

Минимальная длина = 1

Максимальная длина = 127

maxbandwidth

нет

Максимальная пропускная способность в Кбит/с, выделенная для всех сервисов в группе сервисов.

Минимальное значение = 0

Максимальное значение = 4294967287

maxclient

нет

Максимальное количество одновременных открытых подключений для группы сервисов.

Минимальное значение = 0

Максимальное значение = 4294967294

maxreq

нет

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

Примечание: Запросы на подключение сверх этого значения отклоняются.

Минимальное значение = 0

Максимальное значение = 65535

memberport

нет

Порт члена.

monitorbindings

нет

Список имен мониторов, которые необходимо связать с этим сервисом.

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

**Словарь monitorbindings**
параметр	обязательный	значение по умолчанию	значения	комментарии
monitorname	нет			Имя монитора, которое необходимо привязать к этой группе сервисов.
weight	нет			Вес, присваиваемый связи между монитором и группой сервисов.

monthreshold

нет

Минимальная сумма весов мониторов, связанных с этим сервисом. Используется для определения, следует ли помечать сервис как UP или DOWN.

Минимальное значение = 0

Максимальное значение = 65535

netprofile

нет

Сеть профиль для группы сервисов.

Минимальная длина = 1

Максимальная длина = 127

nitro_pass

да

Пароль для аутентификации на узле Netscaler.

nitro_protocol

нет

http

http
https

Протокол для доступа к объектам API nitro.

nitro_timeout

нет

310

Время в секундах до возникновения ошибки таймаута при установлении нового сеанса с Netscaler.

nitro_user

да

Имя пользователя для аутентификации на узле Netscaler.

nsip

да

IP-адрес устройства Netscaler, на котором будут выполняться вызовы API nitro.

Порт можно указать с использованием двоеточия (:). Например, 192.168.1.1:555.

pathmonitor

нет

Мониторинг путей для кластеризации.

pathmonitorindv

нет

Отдельные решения мониторинга путей.

rtspsessionidremap

нет

да
нет

Включить отображение идентификаторов сеансов RTSP для группы сервисов.

save_config

нет

True

да
нет

Если true, модуль сохранит конфигурацию на узле Netscaler, если внесет изменения.

Модуль не сохранит конфигурацию на узле Netscaler, если не внес изменений.

servicegroupname

нет

Имя группы сервисов. Должно начинаться с ASCII-буквенного или символа подчеркивания _, и должно содержать только ASCII-буквенно-цифровые символы, символ подчеркивания _, символ решётки #, точку ., пробел, двоеточие :, символ @ @, знак равенства =, и дефис -. Может быть изменено после создания имени.

Минимальная длина = 1

servicemembers

нет

Список словарей, описывающих каждого члена группы сервисов.

**Словарь servicemembers**
параметр	обязательный	комментарии
hashid	нет	Идентификатор хэша для сервиса. Это значение должно быть уникальным для каждого сервиса. Этот параметр используется методами балансировки нагрузки на основе хэша. Минимальное значение = `1`
weight	нет	Вес, присваиваемый серверам в группе сервисов. Указывает ёмкость серверов по отношению к другим серверам в конфигурации балансировки нагрузки. Чем выше вес, тем выше процент запросов, отправляемых на сервис. Минимальное значение = `1` Максимальное значение = `100`
ip	нет	IP-адрес сервиса. Не должен совпадать с существующим сервером, определённым по имени.
customserverid	нет	Идентификатор этой пары IP:Порт. Используется, когда тип персистенции установлен на Custom Server ID.
servername	нет	Имя сервера, к которому привязать группу сервисов. Сервер должен быть уже настроен как сервер с именем. Минимальная длина = 1
serverid	нет	Идентификатор сервиса. Используется, когда тип персистенции установлен на Custom Server ID.
port	нет	Номер порта сервера. Диапазон `1` - `65535` * в командной строке соответствует 65535 в API NITRO

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	нет	присутствует	присутствует отсутствует	Состояние ресурса, настраиваемого модулем на узле netscaler. При значении «присутствует» ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При значении «отсутствует» ресурс будет удален с узла netscaler.
svrtimeout	нет			Время в секундах, после которого прервать подключение к неактивному серверу. Минимальное значение = `0` Максимальное значение = `31536000`
tcpb	нет		да нет	Включить буферизацию TCP для группы служб.
tcpprofilename	нет			Имя профиля TCP, содержащего настройки TCP для группы служб. Минимальная длина = 1 Максимальная длина = 127
useproxyport	нет		да нет	Использовать порт прокси в качестве исходного порта при подключении к серверу. При значении «нет» используется порт подключения клиента в качестве исходного порта для подключения к серверу. Примечание: Этот параметр доступен только при установке параметра Use Source IP `usip` в значение `yes`.
usip	нет			Использовать IP-адрес клиента в качестве исходного IP-адреса при подключении к серверу. При значении «нет», которое является значением по умолчанию, используется сопоставленный IP-адрес (MIP) или IP-адрес подсети (SNIP) в качестве исходного IP-адреса для подключения к серверу.
validate_certs	нет	да		Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов.

Примеры

# The LB Monitors monitor-1 and monitor-2 must already exist
# Service members defined by C(ip) must not redefine an existing server's ip address.
# Service members defined by C(servername) must already exist.

- name: Setup http service with ip members
  delegate_to: localhost
  netscaler_servicegroup:
    nsip: 172.18.0.2
    nitro_user: nsroot
    nitro_pass: nsroot

    state: present

    servicegroupname: service-group-1
    servicetype: HTTP
    servicemembers:
      - ip: 10.78.78.78
        port: 80
        weight: 50
      - ip: 10.79.79.79
        port: 80
        weight: 40
      - servername: server-1
        port: 80
        weight: 10

    monitorbindings:
      - monitorname: monitor-1
        weight: 50
      - monitorname: monitor-2
        weight: 50

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

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

имя	описание	возвращается	тип	образец
diff	Список различий между фактически настроенным объектом и конфигурацией, указанной в модуле	ошибка	словарь	{'clttimeout': 'различие. наше: (число с плавающей точкой) 10.0 другое: (число с плавающей точкой) 20.0'}
loglines	Список зарегистрированных сообщений модулем	всегда	список	['сообщение 1', 'сообщение 2']
msg	Сообщение, описывающее причину ошибки	ошибка	строка	Действия не существует

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет совместим со старыми версиями.

Для помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочитайте Информация о сообществе и вклад, Тестирование 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_servicegroup_module.html