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

Примечание

Этот плагин входит в коллекцию community.network (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.network.

Для использования в плейбуке укажите: community.network.netscaler_servicegroup.

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

Обзор

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

Требования

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

nitro python sdk

Параметры

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

	servername string		Имя сервера, к которому следует привязать группу сервисов. Сервер должен быть уже настроен как именованный сервер. Минимальная длина = 1
	state string	Варианты: enabled disabled	Начальное состояние сервиса после привязки.
	weight string		Вес, назначаемый серверам в группе сервисов. Определяет емкость серверов по отношению к другим серверам в конфигурации балансировки нагрузки. Чем выше вес, тем выше процент запросов, отправляемых на сервис. Минимальное значение = `1` Максимальное значение = `100`
servicetype string		Варианты: 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 boolean		Варианты: no yes	Включить защиту от пиковых нагрузок для группы сервисов.
state string		Варианты: absent present ←	Состояние ресурса, настраиваемого модулем на узле netscaler. При значении present ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При значении absent ресурс будет удален с узла netscaler.
svrtimeout string			Время в секундах, по истечении которого прервать неактивное соединение сервера. Минимальное значение = `0` Максимальное значение = `31536000`
tcpb boolean		Варианты: no yes	Включить буферизацию TCP для группы сервисов.
tcpprofilename string			Имя профиля TCP, содержащего настройки TCP для группы сервисов. Минимальная длина = 1 Максимальная длина = 127
useproxyport boolean		Варианты: no yes	Использовать порт прокси в качестве порта источника при установлении соединений с сервером. При значении NO используется порт подключения клиента как порт источника для подключения сервера. Примечание: Этот параметр доступен только при установке параметра Use Source IP `usip` в значение `yes`
usip boolean		Варианты: no yes	Использовать IP-адрес клиента в качестве IP-адреса источника при установлении соединения с сервером. При значении NO, по умолчанию, используется сопоставленный IP-адрес (MIP) или подсетевой IP-адрес (SNIP) в качестве IP-адреса источника для инициации подключений к серверу.
validate_certs boolean		Варианты: no 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
  community.network.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': 'различие. наше: (float) 10.0 другое: (float) 20.0'}
loglines список / элементы=строка	всегда	список сообщений, записанных модулем Пример: ['сообщение 1', 'сообщение 2']
msg строка	неудача	Сообщение, подробно описывающее причину ошибки Пример: Действия не существует

Авторы

Георгий Николопулос (@giorgos-nikolopoulos)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/netscaler_servicegroup_module.html