netscaler_service - Управление конфигурацией сервиса в Netscaler
Новая версия с 2.4.0.
Обзор
- Управление конфигурацией сервиса в Netscaler.
- Этот модуль позволяет создавать, удалять и изменять сервисы Netscaler.
- Этот модуль предназначен для работы как на контрольном узле ansible, так и на бастионе (jumpserver) с доступом к фактической инстанции netscaler.
- Этот модуль поддерживает режим проверки.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- nitro python sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| accessdown | По умолчанию: нет | Использовать режим уровня 2 для пересылки пакетов, отправленных в эту службу, если она помечена как ВНЕ СТРОЯ. Если служба находится ВНЕ СТРОЯ, и этот параметр отключен, пакеты будут отброшены. | |
| appflowlog |
| Включить протоколирование информации AppFlow. | |
| cacheable | По умолчанию: нет | Использовать виртуальный сервер прозрачной перенаправленности кэша для пересылки запросов на сервер кэша. Примечание: Не указывайте этот параметр, если вы задали параметр Тип кэша. | |
| cachetype |
| Тип кэша, поддерживаемый сервером кэша. | |
| cip |
| Перед пересылкой запроса на службу вставить заголовок HTTP с IP-адресом клиента (IPv4 или IPv6) в качестве его значения. Используется, если серверу нужен IP-адрес клиента для обеспечения безопасности, учёта или других целей, и установка параметра Использовать IP-адрес источника не является жизнеспособным вариантом. | |
| cipheader | Имя заголовка HTTP, значение которого должно быть установлено в IP-адрес клиента. Используется с параметром IP-адрес клиента. Если вы задали параметр IP-адрес клиента и не указали имя заголовка, устройство использует имя заголовка, указанное для глобального параметра Заголовок IP клиента (параметр cipHeader в командной строке set ns param или параметр Заголовок IP клиента в диалоговом окне Настройка параметров HTTP в разделе Система > Настройки > Изменение параметров HTTP). Если глобальный параметр Заголовок IP клиента не указан, устройство вставляет заголовок с именем «client-ip». Минимальная длина = 1 | ||
| cka | Включить поддержку client keep-alive для службы. | ||
| cleartextport | Порт, на который должны быть отправлены данные в открытом тексте после расшифровки устройством входящего трафика SSL. Применимо к прозрачным службам SSL. Минимальное значение = 1 | ||
| clttimeout | Время в секундах, после которого следует завершать неактивное соединение клиента. Минимальное значение = 0 Максимальное значение = 31536000 | ||
| cmp | Включить сжатие для службы. | ||
| comment | Любая информация о службе. | ||
| customserverid | По умолчанию: Нет | Уникальный идентификатор службы. Используется, когда тип персистентности для виртуального сервера установлен на Custom Server ID. | |
| disabled |
| При установке в yes состояние службы будет установлено в ВЫКЛЮЧЕНО.При установке в no состояние службы будет установлено в ВКЛЮЧЕНО.Обратите внимание, что из-за ограничений в базовом API NITRO изменение состояния disabled не приводит к тому, что модуль сообщает о смене статуса. | |
| dnsprofilename | Имя профиля DNS, который необходимо связать со службой. Свойства профиля DNS будут применяться к транзакциям, обрабатываемым службой. Этот параметр допустим только для служб ADNS и ADNS-TCP. Минимальная длина = 1 Максимальная длина = 127 | ||
| downstateflush |
| Очистить все активные транзакции, связанные со службой, состояние которой переходит из ВКЛЮЧЕНО в ВЫКЛЮЧЕНО. Не включайте этот параметр для приложений, которым необходимо завершить свои транзакции. | |
| graceful | По умолчанию: нет | Выключиться плавно, не принимая новых подключений и отключая службу, когда все её подключения будут закрыты. | |
| hashid | Числовой идентификатор, который можно использовать методами распределения нагрузки на основе хеширования. Должен быть уникальным для каждой службы. Минимальное значение = 1 | ||
| healthmonitor | По умолчанию: да | Мониторинг работоспособности этой службы | |
| httpprofilename | Имя HTTP-профиля, содержащего параметры конфигурации HTTP для службы. Минимальная длина = 1 Максимальная длина = 127 | ||
| ip | IP-адрес, который необходимо назначить службе. Минимальная длина = 1 | ||
| ipaddress | Новый IP-адрес службы. | ||
| maxbandwidth | Максимальная пропускная способность, в Кбит/с, выделенная для службы. Минимальное значение = 0 Максимальное значение = 4294967287 | ||
| maxclient | Максимальное количество одновременных открытых подключений к службе. Минимальное значение = 0 Максимальное значение = 4294967294 | ||
| maxreq | Максимальное количество запросов, которые могут быть отправлены по постоянно подключению к службе. Примечание: Запросы подключений сверх этого значения отклоняются. Минимальное значение = 0 Максимальное значение = 65535 | ||
| monitor_bindings | Список мониторов распределения нагрузки, которые необходимо привязать к этой службе. Каждый элемент монитора — словарь, который может содержать следующие параметры. Обратите внимание, что если вы не используете встроенные мониторы, их необходимо предварительно настроить. | ||
| monitorname | Имя монитора. | ||
| dup_state |
| Состояние монитора. Настройка состояния монитора данного типа влияет на все мониторы этого типа. Например, если HTTP-монитор включен, все HTTP-мониторы на устройстве также включены. Если HTTP-монитор выключен, все HTTP-мониторы на устройстве выключены. | |
| dup_weight | Вес, присваиваемый связи между монитором и службой. | ||
| weight | Вес, присваиваемый связи между монитором и службой. | ||
| monthreshold | Минимальная сумма весов мониторов, привязанных к этой службе. Используется для определения, следует ли отмечать службу как ВКЛЮЧЕНА или ВЫКЛЮЧЕНА. Минимальное значение = 0 Максимальное значение = 65535 | ||
| name | Имя службы. Должно начинаться с символа ASCII-буквы или символа подчеркивания _, и должно содержать только ASCII-буквы, цифры, символы подчеркивания _, символ решётки #, точку ., пробел, двоеточие :, символ @ @, равно =, и дефис - . Не может быть изменено после создания службы.Минимальная длина = 1 | ||
| 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 | Решение для индивидуального мониторинга путей. | ||
| port | Номер порта службы. Диапазон 1 - 65535 * в командной строке представлен как 65535 в API NITRO | ||
| processlocal |
| Включив этот параметр, пакеты, предназначенные для службы в кластере, не будут подвергаться направлению. Включите этот параметр для режима запроса-ответа одного пакета или когда конечное устройство выполняет надлежащее RSS для распределения на основе соединений. | |
| rtspsessionidremap | По умолчанию: нет | Включить сопоставление идентификаторов сеансов RTSP для службы. | |
| save_config |
| Если значение истина, модуль сохранит конфигурацию на узле Netscaler, если он внесёт какие-либо изменения. Модуль не сохранит конфигурацию на узле Netscaler, если не внес никаких изменений. | |
| serverid | Идентификатор службы. Используется, когда тип персистентности установлен на Custom Server ID. | ||
| servername | Имя сервера, на котором размещена служба. Минимальная длина = 1 | ||
| servicetype |
| Протокол обмена данными с сервисом. | |
| sp | Включить защиту от пиковых нагрузок для сервиса. | ||
| state |
| Состояние ресурса, настраиваемого модулем на узле Netscaler. При значении present ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При значении absent ресурс будет удалён с узла Netscaler. | |
| svrtimeout | Время в секундах, после которого будет прервано соединение с неактивным сервером. Минимальное значение = 0 Максимальное значение = 31536000 | ||
| tcpb | Включить буферизацию TCP для сервиса. | ||
| tcpprofilename | Имя профиля TCP, содержащего настройки TCP для сервиса. Минимальная длина = 1 Максимальная длина = 127 | ||
| td | Целое значение, уникально идентифицирующее домен трафика, в котором вы хотите настроить сущность. Если вы не укажете идентификатор, сущность станет частью стандартного домена трафика с идентификатором 0. Минимальное значение = 0 Максимальное значение = 4094 | ||
| useproxyport | Использовать порт прокси в качестве порта источника при установлении соединений с сервером. При значении NO используется порт подключения клиента как порт источника для соединения с сервером. Примечание: этот параметр доступен только при значении YES для параметра Use Source IP (USIP). | ||
| usip | Использовать IP-адрес клиента в качестве IP-адреса источника при установлении соединения с сервером. При создании сервиса, если этот параметр не задан, сервис наследует глобальное значение Use Source IP (доступное в командах CLI enable ns mode и disable ns mode, или в диалоговом окне System > Settings > Configure modes > Configure Modes). Однако вы можете переопределить это значение после создания сервиса. | ||
| validate_certs | По умолчанию: yes | Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых вами лично, использующих самозаверяющие сертификаты. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Citrix NetScaler Network см. в https://www.ansible.com/ansible-netscaler.
Примеры
# Monitor monitor-1 must have been already setup
- name: Setup http service
gather_facts: False
delegate_to: localhost
netscaler_service:
nsip: 172.18.0.2
nitro_user: nsroot
nitro_pass: nsroot
state: present
name: service-http-1
servicetype: HTTP
ipaddress: 10.78.0.1
port: 80
monitor_bindings:
- monitor-1
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| diff словарь | failure | Словарь со списком различий между фактически настроенным объектом и конфигурацией, указанной в модуле Пример: { 'clttimeout': 'различие. наше: (float) 10.0 другое: (float) 20.0' } |
| loglines список | всегда | список сообщений журнала, созданных модулем Пример: ['сообщение 1', 'сообщение 2'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.
Автор
- 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_service_module.html
