netscaler_service - Управление конфигурацией службы в Netscaler
Новая в версии 2.4.0.
Обзор
- Управление конфигурацией службы в Netscaler.
- Этот модуль позволяет создавать, удалять и изменять службы Netscaler.
- Этот модуль предназначен для выполнения как на контрольном узле ansible, так и на бастионе (шлюзе) с доступом к фактической инстанции netscaler.
- Этот модуль поддерживает режим проверки.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- nitro python sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| accessdown | По умолчанию: "нет" | Использовать режим уровня 2 для перенаправления пакетов, отправленных в эту службу, если она отмечена как ВЫКЛЮЧЕНА. Если служба ВЫКЛЮЧЕНА, а этот параметр отключен, пакеты будут отклонены. | |
| appflowlog |
| Включить протоколирование информации AppFlow. | |
| cacheable | По умолчанию: "нет" | Использовать виртуальный сервер прозрачного кеширования для перенаправления запросов на сервер кеширования. Примечание: Не указывайте этот параметр, если вы задали параметр Тип кеширования. | |
| cachetype |
| Тип кеширования, поддерживаемый сервером кеширования. | |
| cip |
| Перед переадресацией запроса на службу вставить HTTP-заголовок с IP-адресом клиента (IPv4 или IPv6) в качестве значения. Используется, если серверу требуется IP-адрес клиента для безопасности, учёта или других целей, и использование параметра «Использовать IP-адрес источника» не является жизнеспособным вариантом. | |
| cipheader | Имя HTTP-заголовка, значение которого должно быть установлено в IP-адрес клиента. Используется с параметром «IP-адрес клиента». Если вы задали параметр «IP-адрес клиента», но не указали имя заголовка, устройство использует имя заголовка, заданное для глобального параметра «Заголовок IP-адреса клиента» (параметр cipHeader в команде CLI set ns param или параметр «Заголовок IP-адреса клиента» в диалоговом окне «Настройка HTTP-параметров» в разделе «Система» > «Настройки» > «Изменить параметры HTTP»). Если глобальный параметр «Заголовок IP-адреса клиента» не указан, устройство вставляет заголовок с именем «client-ip». Минимальная длина = 1 | ||
| cka | Включить keep-alive для клиента для службы. | ||
| cleartextport | Порт, на который должны отправляться данные в открытом виде после расшифровки устройством входящего SSL-трафика. Применимо к прозрачным SSL-службам. Минимальное значение = 1 | ||
| clttimeout | Время в секундах, после которого следует завершить неактивное подключение клиента. Минимальное значение = 0 Максимальное значение = 31536000 | ||
| cmp | Включить сжатие для службы. | ||
| comment | Любая информация о службе. | ||
| customserverid | По умолчанию: "Нет" | Уникальный идентификатор службы. Используется, когда тип постоянства для виртуального сервера установлен на «Пользовательский идентификатор сервера». | |
| disabled bool |
| При установке в 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 | Имя монитора. | ||
| weight | Вес, который нужно назначить связи между монитором и службой. | ||
| dup_state |
| Состояние монитора. Настройка состояния для монитора заданного типа влияет на все мониторы этого типа. Например, если HTTP-монитор включен, все HTTP-мониторы на устройстве также включены (или остаются включенными). Если HTTP-монитор выключен, все HTTP-мониторы на устройстве выключены. | |
| dup_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 * в CLI соответствует 65535 в API NITRO | ||
| processlocal |
| Включив этот параметр, пакеты, предназначенные для службы в кластере, не будут подвергаться перенаправлению. Включите этот параметр для режима запроса ответа на основе отдельного пакета или когда устройство upstream выполняет правильную функцию RSS для распределения на основе подключения. | |
| rtspsessionidremap | По умолчанию: "нет" | Включить сопоставление идентификаторов сеансов RTSP для службы. | |
| save_config bool |
| Если true, модуль сохранит конфигурацию на узле Netscaler, если он внес какие-либо изменения. Модуль не будет сохранять конфигурацию на узле Netscaler, если не внес никаких изменений. | |
| serverid | Идентификатор службы. Используется, когда тип постоянства установлен на «Пользовательский идентификатор сервера». | ||
| servername | Имя сервера, на котором размещена служба. Минимальная длина = 1 | ||
| servicetype |
| Протокол обмена данными с сервисом. | |
| sp | Включить защиту от всплесков для сервиса. | ||
| state |
| Состояние ресурса, настраиваемого модулем на узле netscaler. При значении present ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При значении absent ресурс будет удален с узла netscaler. | |
| svrtimeout | Время в секундах, по истечении которого будет прервано неактивное соединение с сервером. Минимальное значение = 0 Максимальное значение = 31536000 | ||
| tcpb | Включить буферизацию TCP для сервиса. | ||
| tcpprofilename | Имя профиля TCP, содержащего настройки TCP для сервиса. Минимальная длина = 1 Максимальная длина = 127 | ||
| td | Целое значение, уникально идентифицирующее домен трафика, в котором требуется настроить сущность. Если не указать ID, сущность станет частью стандартного домена трафика с ID 0. Минимальное значение = 0 Максимальное значение = 4094 | ||
| useproxyport | Использовать порт прокси в качестве исходного порта при установлении соединения с сервером. При значении NO используется порт подключения клиента в качестве исходного порта для подключения сервера. Примечание: Этот параметр доступен только при установке параметра Use Source IP (USIP) в значение YES. | ||
| 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 dict | failure | Словарь со списком различий между фактическим настроенным объектом и конфигурацией, указанной в модуле Пример: { 'clttimeout': 'различие. наши: (float) 10.0 другие: (float) 20.0' } |
| loglines list | всегда | список сообщений, записанных модулем Пример: ['сообщение 1', 'сообщение 2'] |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Георгий Николопулос (@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.6/modules/netscaler_service_module.html
