netscaler_servicegroup - Управление конфигурацией группы служб в Netscaler
Новая версия 2.4.
Описание
- Управление конфигурацией группы служб в Netscaler.
- Этот модуль предназначен для работы как на контроллере Ansible, так и на бастионе (шлюзе) с доступом к фактической инстанции netscaler.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- nitro python sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| appflowlog |
| Включить протоколирование информации AppFlow для указанной группы служб. | |
| autoscale |
| Вариант автомасштабирования для группы служб. | |
| cacheable |
| Использовать виртуальный сервер прозрачной переадресации кэша для перенаправления запроса на сервер кэша. Примечание: Не устанавливайте этот параметр, если вы установили параметр Cache Type. | |
| cachetype |
| Тип кэширования, поддерживаемый сервером кэша. | |
| cip |
| Вставить заголовок 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 |
| Очистить все активные транзакции, связанные со всеми службами в группе служб, состояние которых переходит от UP к DOWN. Не включайте этот параметр для приложений, которые должны завершить свои транзакции. | |
| graceful |
| Подождать завершения всех существующих соединений со службой перед отключением службы. | |
| healthmonitor |
| Отслеживать состояние этой службы. Доступные настройки работают следующим образом: 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 обязательно | Пароль для аутентификации на узле Netscaler. | ||
| nitro_protocol |
| Какой протокол использовать при доступе к объектам 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, модуль сохранит конфигурацию на узле Netscaler, если он внес какие-либо изменения. Модуль не сохранит конфигурацию на узле Netscaler, если не внес никаких изменений. | |
| servicegroupname | Имя группы служб. Должно начинаться с ASCII-буквы или символа нижнего подчеркивания _, и должно содержать только ASCII-буквы, цифры, символ нижнего подчеркивания _, знак решетки #, точку ., пробел, двоеточие :, символ @ @, знак равенства =, и дефис -. Может быть изменено после создания имени.Минимальная длина = 1 | ||
| servicemembers | Список словарей, описывающих каждого участника службы в группе служб. | ||
| weight | Вес, назначаемый серверам в группе служб. Указывает ёмкость серверов относительно других серверов в конфигурации балансировки нагрузки. Чем выше вес, тем выше процент запросов, отправляемых на службу. Минимальное значение = 1Максимальное значение = 100 | ||
| ip | IP-адрес службы. Не должен совпадать с существующим сервером, определённым по имени. | ||
| servername | Имя сервера, к которому привязать группу служб. Сервер должен быть уже настроен как именованный сервер. Минимальная длина = 1 | ||
| state |
| Начальное состояние службы после привязки. | |
| customserverid | Идентификатор этой пары IP:Порт. Используется, когда тип сохранения настроен на Custom Server ID. | ||
| hashid | Идентификатор хеша для службы. Он должен быть уникальным для каждой службы. Этот параметр используется методами балансировки нагрузки на основе хеширования. Минимальное значение = 1 | ||
| serverid | Идентификатор службы. Используется, когда тип сохранения настроен на Custom Server ID. | ||
| port | Номер порта сервера. Диапазон 1 - 65535* в CLI представлен как 65535 в NITRO API | ||
| servicetype |
| Протокол, используемый для обмена данными с сервисом. | |
| sp |
| Включить защиту от всплесков для группы сервисов. | |
| state |
| Состояние ресурса, настраиваемого модулем на узле netscaler. При значении present ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При значении absent ресурс будет удален с узла netscaler. | |
| svrtimeout | Время в секундах, после которого прервать неактивное соединение с сервером. Минимальное значение = 0Максимальное значение = 31536000 | ||
| tcpb |
| Включить буферизацию TCP для группы сервисов. | |
| tcpprofilename | Имя профиля TCP, содержащего настройки TCP для группы сервисов. Минимальная длина = 1 Максимальная длина = 127 | ||
| useproxyport |
| Использовать порт прокси в качестве исходного порта при установлении соединений с сервером. При значении NO используется порт соединения на стороне клиента в качестве исходного порта для соединения на стороне сервера. Примечание: Этот параметр доступен только при включенном параметре Использовать исходный IP usip, установленный в значение yes. | |
| usip | Использовать IP-адрес клиента в качестве исходного IP-адреса при установлении соединения с сервером. При значении NO, по умолчанию, используется сопоставленный IP-адрес (MIP) или подсеточный IP-адрес (SNIP) в качестве исходного IP-адреса для инициации соединений с сервером. | ||
| validate_certs | По умолчанию: да | Если 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': 'различие. наше: (float) 10.0 другое: (float) 20.0'} |
| loglines список | всегда | Список зарегистрированных сообщений модуля Пример: ['сообщение 1', 'сообщение 2'] |
| msg строка | ошибка | Сообщение, описывающее причину ошибки Пример: Действие не существует |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- 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.5/modules/netscaler_servicegroup_module.html
