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

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

Описание
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Описание

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

Требования

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

nitro python sdk

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
appflowlog		Варианты: enabled disabled	Включить протоколирование информации AppFlow для указанной группы сервисов.
autoscale		Варианты: DISABLED DNS POLICY	Параметр автоматического масштабирования для группы сервисов.
cacheable bool		Варианты: no yes	Использовать виртуальный сервер прозрачного кеширования для перенаправления запроса на сервер кэша. Примечание: Не устанавливайте этот параметр, если вы установили Cache Type.
cachetype		Варианты: TRANSPARENT REVERSE FORWARD	Тип кэширования, поддерживаемый сервером кэша.
cip		Варианты: enabled disabled	Вставить заголовок Client IP в запросы, перенаправляемые сервису.
cipheader			Имя HTTP-заголовка, значение которого должно быть установлено в IP-адрес клиента. Используется с параметром Client IP. Если вставка IP-адреса клиента включена, и заголовок IP-адреса клиента не указан, используется значение параметра Заголовок IP-адреса клиента или значение, установленное командой set ns config. Минимальная длина = 1
cka bool		Варианты: no yes	Включить клиентскую поддержку keep-alive для группы сервисов.
clttimeout			Время в секундах, после которого неактивное клиентское соединение закрывается. Минимальное значение = `0` Максимальное значение = `31536000`
cmp bool		Варианты: no yes	Включить сжатие для указанного сервиса.
comment			Любая информация о группе сервисов.
disabled bool		Варианты: no ← yes	При установке в `yes` состояние группы сервисов установится в DISABLED. При установке в `no` состояние группы сервисов установится в ENABLED. Обратите внимание, что из-за ограничений базового API NITRO изменение состояния `disabled` не приводит к отображению изменённого статуса в результате работы модуля.
downstateflush		Варианты: enabled disabled	Очистить все активные транзакции, связанные со всеми сервисами в группе сервисов, чьё состояние изменилось с UP на DOWN. Не включайте этот параметр для приложений, требующих завершения транзакций.
graceful bool		Варианты: no yes	Подождать завершения всех существующих подключений к сервису перед остановкой сервиса.
healthmonitor bool		Варианты: no yes	Отслеживать работоспособность этого сервиса. Доступные настройки работают следующим образом: `yes` - Отправлять зонды для проверки работоспособности сервиса. `no` - Не отправлять зонды для проверки работоспособности сервиса. При значении NO приложение всегда отображает сервис как UP.
httpprofilename			Имя HTTP-профиля, содержащего настройки HTTP для группы сервисов. Минимальная длина = 1 Максимальная длина = 127
maxbandwidth			Максимальная пропускная способность в Кбит/с, выделенная для всех сервисов в группе сервисов. Минимальное значение = `0` Максимальное значение = `4294967287`
maxclient			Максимальное количество одновременных открытых подключений для группы сервисов. Минимальное значение = `0` Максимальное значение = `4294967294`
maxreq			Максимальное количество запросов, которое может быть отправлено по постоянно подключению к группе сервисов. Примечание: Запросы подключения, превышающие это значение, отклоняются. Минимальное значение = `0` Максимальное значение = `65535`
memberport			Порт члена.
	monitorbindings		Список имён мониторов, привязанных к этому сервису Обратите внимание, что мониторы должны быть настроены, возможно, с помощью модуля netscaler_lb_monitor или другим способом.
	monitorname		Имя монитора, привязанного к этой группе сервисов.
	weight		Вес, назначаемый связи между монитором и группой сервисов.
monthreshold			Минимальная сумма весов мониторов, привязанных к этому сервису. Используется для определения, следует ли отмечать сервис как UP или DOWN. Минимальное значение = `0` Максимальное значение = `65535`
netprofile			Сеть профиль для группы сервисов. Минимальная длина = 1 Максимальная длина = 127
nitro_pass required			Пароль для аутентификации на узле Netscaler.
nitro_protocol		Варианты: http ← https	Протокол для доступа к объектам API Nitro.
nitro_timeout		По умолчанию: 310	Время в секундах до возникновения ошибки таймаута при установке нового сеанса с Netscaler
nitro_user required			Имя пользователя для аутентификации на узле Netscaler.
nsip required			IP-адрес устройства Netscaler, на котором будут выполняться вызовы API Nitro. Порт может быть указан с двоеточием (:). Например, 192.168.1.1:555.
pathmonitor			Мониторинг путей для кластеризации.
pathmonitorindv			Индивидуальные решения по мониторингу путей.
rtspsessionidremap bool		Варианты: no yes	Включить сопоставление идентификаторов сеансов RTSP для группы сервисов.
save_config bool		Варианты: no yes ←	Если true, модуль сохранит конфигурацию на узле Netscaler, если были внесены изменения. Модуль не сохранит конфигурацию на узле Netscaler, если изменений не было.
servicegroupname			Имя группы сервисов. Должно начинаться с ASCII-буквенного или символа подчёркивания `_`, и должно содержать только ASCII-буквенно-цифровые символы, символ подчёркивания `_`, символ решётки `#`, точка `.`, пробел, двоеточие `:`, символ "@" `@`, знак равенства `=`, и дефис `-`. Может быть изменено после создания имени. Минимальная длина = 1
servicemembers			Список словарей, описывающих каждого члена группы сервисов.
	ip		IP-адрес сервиса. Не должен пересекаться с существующим сервером, определённым по имени.
	port		Номер порта сервера. Диапазон `1` - `65535` * в CLI представлен как 65535 в API NITRO
	state	Варианты: enabled disabled	Начальное состояние сервиса после привязки.
	hashid		Идентификатор хэша для сервиса. Должен быть уникальным для каждого сервиса. Этот параметр используется методами балансировки нагрузки на основе хэширования. Минимальное значение = `1`
	serverid		Идентификатор сервиса. Используется при установке типа персистентности на Custom Server ID.
	servername		Имя сервера, к которому следует привязать группу сервисов. Сервер должен быть предварительно настроен как именованный сервер. Минимальная длина = 1
	customserverid		Идентификатор этой пары IP:Порт. Используется при установке типа персистентности на Custom Server ID.
	weight		Вес, назначаемый серверам в группе сервисов. Указывает на ёмкость серверов относительно других серверов в конфигурации балансировки нагрузки. Чем выше вес, тем большая часть запросов отправляется на сервис. Минимальное значение = `1` Максимальное значение = `100`

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

Примечания

Примечание

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

Примеры

# 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 dict	failure	Список различий между фактически настроенным объектом и конфигурацией, указанной в модуле Пример: {'clttimeout': 'различие. наше: (float) 10.0 другое: (float) 20.0'}
loglines list	всегда	список сообщений журнала, записанных модулем Пример: ['сообщение 1', 'сообщение 2']
msg str	failure	Сообщение, описывающее причину ошибки Пример: Действие не существует

Статус

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

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/netscaler_servicegroup_module.html