Spec-Zone.ru › Ansible 2.8

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

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

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

Обзор

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

Требования

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

  • nitro python sdk

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
appflowlog
-
    Варианты:
  • enabled
  • disabled
Включить протоколирование информации AppFlow для указанной группы служб.
autoscale
-
    Варианты:
  • DISABLED
  • DNS
  • POLICY
Параметр автоматического масштабирования для группы служб.
cacheable
boolean
    Варианты:
  • no
  • yes
Использовать виртуальный сервер прозрачного кеширования для перенаправления запроса на сервер кеширования.
Примечание: Не устанавливайте этот параметр, если вы задали Cache Type.
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
boolean
    Варианты:
  • no
  • yes
Включить keep-alive для клиента для группы служб.
clttimeout
-
Время в секундах, по истечении которого происходит закрытие неактивного соединения клиента.
Минимальное значение = 0
Максимальное значение = 31536000
cmp
boolean
    Варианты:
  • no
  • yes
Включить сжатие для указанной службы.
comment
-
Любая информация о группе служб.
disabled
boolean
    Варианты:
  • no ←
  • yes
При установке в yes состояние группы служб будет установлено в DISABLED.
При установке в no состояние группы служб будет установлено в ENABLED.
Обратите внимание, что из-за ограничений базового API NITRO изменение состояния disabled не приводит к сообщению об изменении статуса модулем.
downstateflush
-
    Варианты:
  • enabled
  • disabled
Очистить все активные транзакции, связанные со всеми службами в группе служб, чей статус переходит из UP в DOWN. Не включайте этот параметр для приложений, которые должны завершить свои транзакции.
graceful
boolean
    Варианты:
  • no
  • yes
Подождать, пока все существующие подключения к службе завершатся, прежде чем остановить службу.
healthmonitor
boolean
    Варианты:
  • 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
string / обязательно
Пароль для аутентификации на узле Netscaler.
nitro_protocol
string
    Варианты:
  • http ←
  • https
Протокол для доступа к объектам API nitro.
nitro_timeout
float
По умолчанию:
310
Время в секундах до возникновения ошибки таймаута при установке нового сеанса с Netscaler
nitro_user
string / обязательно
Имя пользователя для аутентификации на узле Netscaler.
nsip
string / обязательно
IP-адрес устройства Netscaler, на котором будут выполняться вызовы API nitro.
Порт можно указать с двоеточием (:). Например, 192.168.1.1:555.
pathmonitor
boolean
    Варианты:
  • no
  • yes
Мониторинг путей для кластеризации.
pathmonitorindv
boolean
    Варианты:
  • no
  • yes
Индивидуальные решения мониторинга путей.
rtspsessionidremap
boolean
    Варианты:
  • no
  • yes
Включить отображение идентификаторов сеансов RTSP для группы служб.
save_config
boolean
    Варианты:
  • no
  • yes ←
Если 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
-
Имя сервера, к которому следует привязать группу служб.
Сервер должен быть уже настроен как именованный сервер.
Минимальная длина = 1
state
-
    Варианты:
  • enabled
  • disabled
Начальное состояние службы после привязки.
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
boolean
    Варианты:
  • no
  • yes
Включить защиту от перегрузки для группы служб.
state
string
    Варианты:
  • absent
  • present ←
Состояние ресурса, настраиваемого модулем на узле netscaler.
При значении present ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля.
При значении absent ресурс будет удалён с узла netscaler.
svrtimeout
-
Время в секундах, после которого следует завершить неактивное соединение сервера.
Минимальное значение = 0
Максимальное значение = 31536000
tcpb
boolean
    Варианты:
  • no
  • yes
Включить буферизацию TCP для группы служб.
tcpprofilename
-
Имя 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
  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': 'difference. ours: (float) 10.0 other: (float) 20.0'}
loglines
список
 всегда
список сообщений, записанных модулем

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

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


Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается сообществом 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.8/modules/netscaler_servicegroup_module.html

Spec-Zone.ru

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