Spec-Zone.ru › Ansible 2.10

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

Примечание

Этот плагин является частью коллекции community.network (версия 1.3.0).

Для его установки используйте: 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
булево
    Варианты:
  • нет ←
  • да
При установке в yes состояние группы сервисов будет установлено в ВЫКЛЮЧЕНО.
При установке в no состояние группы сервисов будет установлено в ВКЛЮЧЕНО.
Обратите внимание, что из-за ограничений в базовом API NITRO, изменение состояния disabled не приводит к изменению статуса в отчете модуля.
downstateflush
строка
    Варианты:
  • enabled
  • disabled
Очистить все активные транзакции, связанные со всеми службами в группе служб, чье состояние переходит из ВКЛЮЧЕНО в ВЫКЛЮЧЕНО. Не включайте этот параметр для приложений, которые должны завершить свои транзакции.
graceful
булево
    Варианты:
  • no
  • yes
Подождать завершения всех существующих подключений к службе перед отключением службы.
healthmonitor
булево
    Варианты:
  • no
  • yes
Отслеживать работоспособность этой службы. Доступные настройки функционируют следующим образом:
yes - Отправлять запросы для проверки работоспособности службы.
no - Не отправлять запросы для проверки работоспособности службы. В режиме НЕТ приложение всегда отображает службу как ВКЛЮЧЕНУЮ.
httpprofilename
строка
Имя HTTP-профиля, содержащего настройки HTTP для группы сервисов.
Минимальная длина = 1
Максимальная длина = 127
maxbandwidth
строка
Максимальная пропускная способность в Кбит/с, выделенная для всех сервисов в группе сервисов.
Минимальное значение = 0
Максимальное значение = 4294967287
maxclient
строка
Максимальное количество одновременных открытых подключений для группы сервисов.
Минимальное значение = 0
Максимальное значение = 4294967294
maxreq
строка
Максимальное количество запросов, которые могут быть отправлены по постоянному подключению к группе сервисов.
Примечание: запросы подключений сверх этого значения отклоняются.
Минимальное значение = 0
Максимальное значение = 65535
memberport
строка
порт члена.
monitorbindings
строка
Список имен мониторов, привязанных к этой службе
Обратите внимание, что мониторы должны быть предварительно настроены, возможно, с использованием модуля community.network.netscaler_lb_monitor или каким-либо другим способом.
monitorname
строка
Имя монитора для привязки к этой группе сервисов.
weight
строка
Вес, назначаемый привязке между монитором и группой сервисов.
monthreshold
строка
Минимальная сумма весов мониторов, привязанных к этой службе. Используется для определения, пометить ли службу как ВКЛЮЧЕННУЮ или ВЫКЛЮЧЕННУЮ.
Минимальное значение = 0
Максимальное значение = 65535
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
булево
    Варианты:
  • no
  • yes
Мониторинг пути для кластеризации.
pathmonitorindv
булево
    Варианты:
  • no
  • yes
Отдельные решения по мониторингу путей.
rtspsessionidremap
булево
    Варианты:
  • no
  • yes
Включить отображение ID сеанса RTSP для группы сервисов.
save_config
булево
    Варианты:
  • no
  • да ←
Если yes, модуль сохранит конфигурацию на узле Netscaler, если внесёт какие-либо изменения.
Модуль не сохранит конфигурацию на узле Netscaler, если не внесёт никаких изменений.
servicegroupname
строка
Имя группы сервисов. Должно начинаться с ASCII буквенного или символа подчеркивания _, и должно содержать только ASCII буквенно-цифровые, символы подчеркивания _, хэштега #, точки ., пробела, двоеточия :, знака @ @, знака равно =, и дефиса - символы. Может быть изменён после создания имени.
Минимальная длина = 1
servicemembers
строка
Список словарей, описывающих каждого члена группы сервисов.
customserverid
строка
Идентификатор этой пары IP:Порт.
Используется, когда тип персистентности установлен на Custom Server ID.
hashid
строка
Идентификатор хэша для службы.
Он должен быть уникальным для каждой службы.
Этот параметр используется методами распределения нагрузки на основе хэширования.
Минимальное значение = 1
ip
строка
IP-адрес службы. Не должен пересекаться с существующим сервером, определенным по имени.
port
строка
Номер порта сервера.
Диапазон 1 - 65535
* в CLI представлен как 65535 в API NITRO
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
словарь
failure
Список различий между фактически настроенным объектом и конфигурацией, указанной в модуле

Пример:
{'clttimeout': 'difference. ours: (float) 10.0 other: (float) 20.0'}
loglines
список / элементы=строка
всегда
список сообщений, зарегистрированных модулем

Пример:
['сообщение 1', 'сообщение 2']
msg
строка
failure
Сообщение, содержащее причину ошибки

Пример:
Действие не существует


Авторы

  • 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.10/collections/community/network/netscaler_servicegroup_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API