community.network.netscaler_servicegroup модуль — Управление конфигурацией группы служб в Netscaler
Примечание
Этот модуль входит в коллекцию community.network (версия 5.0.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.
Для использования в плейбуке укажите: community.network.netscaler_servicegroup.
Обзор
- Управление конфигурацией группы служб в Netscaler.
- Этот модуль предназначен для выполнения как на контрольном узле Ansible, так и на бастионе (шлюзе) с доступом к фактической инстанции Netscaler.
Псевдонимы: network.netscaler.netscaler_servicegroup
Требования
Ниже перечислены требования, необходимые на узле, на котором выполняется этот модуль.
- nitro python sdk
Параметры
Параметр | Комментарии |
|---|---|
appflowlog string | Включить логирование информации AppFlow для указанной группы сервисов. Варианты:
|
autoscale string | Параметр автоматического масштабирования для группы сервисов. Варианты:
|
cacheable boolean | Использовать виртуальный сервер прозрачного кэширования для перенаправления запроса на кэш-сервер. Примечание: Не устанавливайте этот параметр, если вы устанавливаете тип кэша. Варианты:
|
cachetype string | Тип кэша, поддерживаемый кэш-сервером. Варианты:
|
cip string | Вставить заголовок Client IP в запросы, перенаправленные на сервис. Варианты:
|
cipheader string | Имя HTTP-заголовка, значение которого должно быть установлено в IP-адрес клиента. Используется с параметром Client IP. Если вставка IP-адреса клиента включена, а заголовок IP-адреса клиента не указан, используется значение параметра Client IP Header или значение, установленное командой set ns config, в качестве имени заголовка IP-адреса клиента. Минимальная длина = 1 |
cka boolean | Включить постоянное соединение клиента для группы сервисов. Варианты:
|
clttimeout string | Время в секундах, после которого будет разорвано бездействующее соединение клиента. Минимальное значение = Максимальное значение = |
cmp boolean | Включить сжатие для указанного сервиса. Варианты:
|
comment string | Любая информация о группе сервисов. |
disabled boolean | При установке в При установке в Обратите внимание, что из-за ограничений базового API NITRO одно изменение состояния Варианты:
|
downstateflush string | Сбросить все активные транзакции, связанные со всеми сервисами в группе сервисов, состояние которых переходит из UP в DOWN. Не включайте этот параметр для приложений, которым необходимо завершить свои транзакции. Варианты:
|
graceful boolean | Ожидать завершения всех существующих соединений с сервисом перед выключением сервиса. Варианты:
|
healthmonitor boolean | Мониторинг состояния этого сервиса. Доступные параметры работают следующим образом:
Варианты:
|
httpprofilename string | Имя HTTP-профиля, содержащего параметры конфигурации HTTP для группы сервисов. Минимальная длина = 1 Максимальная длина = 127 |
maxbandwidth string | Максимальная полоса пропускания в Кбит/с, выделенная для всех сервисов в группе сервисов. Минимальное значение = Максимальное значение = |
maxclient string | Максимальное количество одновременных открытых соединений для группы сервисов. Минимальное значение = Максимальное значение = |
maxreq string | Максимальное количество запросов, которые могут быть отправлены по постоянному соединению с группой сервисов. Примечание: Запросы на соединение, превышающие это значение, отклоняются. Минимальное значение = Максимальное значение = |
memberport string | порт члена. |
monitorbindings string | Список имен мониторов, которые нужно привязать к этой службе. Обратите внимание, что мониторы должны быть уже настроены, возможно, с помощью модуля community.network.netscaler_lb_monitor или каким-либо другим методом. |
|
monitorname string |
Имя монитора, которое нужно привязать к этой группе служб. |
|
weight string |
Вес, который нужно назначить связи между монитором и группой служб. |
monthreshold string | Минимальная сумма весов мониторов, привязанных к этой службе. Используется для определения, следует ли отмечать службу как активную или неактивную. Минимальное значение = Максимальное значение = |
netprofile string | Сетевой профиль для группы служб. Минимальная длина = 1 Максимальная длина = 127 |
nitro_pass string / обязательно | Пароль для аутентификации на узле netscaler. |
nitro_protocol string | Протокол, который нужно использовать при доступе к объектам API nitro. Варианты:
|
nitro_timeout float | Время в секундах до сброса таймаута при установлении нового сеанса с Netscaler По умолчанию: |
nitro_user string / обязательно | Имя пользователя для аутентификации на узле netscaler. |
nsip string / обязательно | IP-адрес устройства netscaler, на котором будут выполняться вызовы API nitro. Порт можно указать с помощью двоеточия (:). Например, 192.168.1.1:555. |
pathmonitor boolean | Мониторинг путей для кластеризации. Варианты:
|
pathmonitorindv boolean | Индивидуальные решения по мониторингу путей. Варианты:
|
rtspsessionidremap boolean | Включить сопоставление идентификаторов сеансов RTSP для группы служб. Варианты:
|
save_config boolean | Если Модуль не сохранит конфигурацию на узле netscaler, если не внесённых изменений. Варианты:
|
servicegroupname string | Имя группы служб. Должно начинаться с ASCII-буквенного или символа подчеркивания Минимальная длина = 1 |
servicemembers string | Список словарей, описывающих каждого участника группы служб. |
|
customserverid string |
Идентификатор этой пары IP:Порт. Используется, когда тип персистенции установлен на «Идентификатор пользовательского сервера». |
|
hashid string |
Идентификатор хэша для службы. Он должен быть уникальным для каждой службы. Этот параметр используется методами балансировки нагрузки на основе хэширования. Минимальное значение = |
|
ip string |
IP-адрес службы. Не должен перекрываться с существующим серверным элементом, определенным по имени. |
|
port string |
Номер порта сервера. Диапазон * в CLI представлен как 65535 в NITRO API |
|
serverid string |
Идентификатор службы. Используется, когда тип персистентности установлен на «Custom Server ID». |
|
servername string |
Имя сервера, к которому нужно привязать группу служб. Сервер должен быть уже настроен как именованный сервер. Минимальная длина = 1 |
|
state string |
Начальное состояние службы после привязки. Варианты:
|
|
weight string |
Вес, назначаемый серверам в группе служб. Определяет емкость серверов относительно других серверов в конфигурации балансировки нагрузки. Чем выше вес, тем выше процент запросов, отправляемых на службу. Минимальное значение = Максимальное значение = |
servicetype string | Протокол, используемый для обмена данными со службой. Варианты:
|
sp boolean | Включить защиту от пиковых нагрузок для группы служб. Варианты:
|
state string | Состояние ресурса, настраиваемого модулем на узле netscaler. При наличии ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При отсутствии ресурс будет удалён с узла netscaler. Варианты:
|
svrtimeout string | Время в секундах, после которого прервать неактивное соединение сервера. Минимальное значение = Максимальное значение = |
tcpb boolean | Включить буферизацию TCP для группы служб. Варианты:
|
tcpprofilename string | Имя профиля TCP, содержащего настройки TCP для группы служб. Минимальная длина = 1 Максимальная длина = 127 |
useproxyport boolean | Использовать порт прокси в качестве исходного порта при установлении соединений с сервером. С настройкой NO используется порт подключения клиента как исходный порт для серверного подключения. Примечание: Этот параметр доступен только при настройке параметра «Use Source IP» Варианты:
|
usip boolean | Использовать IP-адрес клиента в качестве исходного IP-адреса при установлении соединения с сервером. С настройкой NO (по умолчанию) используется сопоставленный IP-адрес (MIP) или подсетевой IP-адрес (SNIP) в качестве исходного IP-адреса для инициации соединений со стороны сервера. Варианты:
|
validate_certs boolean | Если Варианты:
|
Примечания
Примечание
- Дополнительную информацию об использовании 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 словарь | Список различий между фактически настроенным объектом и конфигурацией, указанной в модуле Возвращается: ошибка Пример: |
loglines список / элементы=строка | Список сообщений, записанных модулем Возвращается: всегда Пример: |
msg строка | Сообщение, описывающее причину ошибки Возвращается: ошибка Пример: |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/netscaler_servicegroup_module.html