community.network.netscaler_service – Управление конфигурацией службы в Netscaler
Примечание
Этот плагин входит в коллекцию community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в playbook, укажите: community.network.netscaler_service.
Обзор
- Управление конфигурацией службы в Netscaler.
- Этот модуль позволяет создавать, удалять и изменять службы Netscaler.
- Этот модуль предназначен для выполнения либо на контрольном узле ansible, либо на бастионе (прокси-сервере) с доступом к фактической инстанции netscaler.
- Этот модуль поддерживает режим проверки.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- nitro python sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| accessdown логический тип |
| Использовать режим уровня 2 для перехвата пакетов, отправленных этому сервису, если он помечен как ВЫКЛЮЧЕН. Если служба ВЫКЛЮЧЕНА, а этот параметр отключён, пакеты будут отброшены. | |
| appflowlog строка |
| Включить протоколирование информации AppFlow. | |
| cacheable логический тип |
| Использовать виртуальный сервер прозрачного кеширования для перенаправления запросов на сервер кеширования. Примечание: не указывайте этот параметр, если вы задали параметр Тип кеширования. | |
| cachetype строка |
| Тип кеширования, поддерживаемый сервером кеширования. | |
| cip строка |
| Перед пересылкой запроса службе вставить в HTTP-заголовок адрес IPv4 или IPv6 клиента. Используется, если серверу необходим адрес IP клиента для безопасности, учёта или других целей, а установка параметра Использовать адрес источника не подходит. | |
| cipheader строка | Имя HTTP-заголовка, значение которого должно быть установлено в адрес IP клиента. Используется с параметром Адрес клиента. Если вы задали параметр Адрес клиента, но не указали имя заголовка, прибор использует имя заголовка, указанное для глобального параметра Заголовок адреса клиента (параметр cipHeader в команде CLI set ns param или параметр Заголовок адреса клиента в диалоговом окне Настройка параметров HTTP в разделе Система > Настройки > Изменить параметры HTTP). Если глобальный параметр Заголовок адреса клиента не указан, прибор вставляет заголовок с именем «client-ip». Минимальная длина = 1 | ||
| cka логический тип |
| Включить keep-alive для клиента для службы. | |
| cleartextport строка | Порт, на который должны быть отправлены данные в открытом виде после расшифровки прибором входящего SSL-трафика. Применимо к прозрачным SSL-службам. Минимальное значение = 1 | ||
| clttimeout строка | Время в секундах, после которого следует прервать неактивное соединение клиента. Минимальное значение = 0 Максимальное значение = 31536000 | ||
| cmp логический тип |
| Включить сжатие для службы. | |
| comment строка | Любая информация о службе. | ||
| customserverid строка | Значение по умолчанию: "None" | Уникальный идентификатор службы. Используется, когда тип персистентности для виртуального сервера установлен на 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 строка | Список мониторов балансировки нагрузки, которые необходимо привязать к этой службе. Каждая запись монитора представляет собой словарь, который может содержать следующие опции. Обратите внимание, что если не используются встроенные мониторы, они должны быть предварительно настроены. | ||
| dup_state строка |
| Состояние монитора. Настройка состояния монитора определенного типа влияет на все мониторы этого типа. Например, если монитор HTTP включен, все мониторы HTTP на приборе также (или остаются) включены. Если монитор HTTP выключен, все мониторы HTTP на приборе выключены. | |
| dup_weight строка | Вес, назначаемый связи между монитором и службой. | ||
| monitorname строка | Имя монитора. | ||
| 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 строка |
| Включив этот параметр, пакеты, предназначенные для службы в кластере, не будут подвергаться перенаправлению. Включите этот параметр для режима запроса-ответа на один пакет или когда устройство вышестоящего уровня выполняет правильное RSS для распределения на основе соединения. | |
| rtspsessionidremap логический |
| Включить отображение идентификаторов сеансов RTSP для службы. | |
| save_config логический |
| Если yes модуль сохранит конфигурацию на узле Netscaler, если внесёт какие-либо изменения.Модуль не сохранит конфигурацию на узле Netscaler, если не внесёт никаких изменений. | |
| serverid строка | Идентификатор службы. Используется, когда тип сохранения задан как «Идентификатор сервера пользовательского типа». | ||
| servername строка | Имя сервера, на котором размещена служба. Минимальная длина = 1 | ||
| servicetype строка |
| Протокол обмена данными со службой. | |
| sp логический |
| Включить защиту от пиковых нагрузок для службы. | |
| state строка |
| Состояние ресурса, настраиваемого модулем на узле Netscaler. При значении «существует» ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При значении «отсутствует» ресурс будет удален с узла Netscaler. | |
| svrtimeout строка | Время в секундах, после которого следует завершить неактивное подключение к серверу. Минимальное значение = 0 Максимальное значение = 31536000 | ||
| tcpb логический |
| Включить буферизацию TCP для службы. | |
| tcpprofilename строка | Имя профиля TCP, содержащего параметры конфигурации TCP для службы. Минимальная длина = 1 Максимальная длина = 127 | ||
| td строка | Целочисленное значение, уникально идентифицирующее домен трафика, в котором вы хотите настроить сущность. Если вы не укажете идентификатор, сущность станет частью стандартного домена трафика, у которого идентификатор 0. Минимальное значение = 0 Максимальное значение = 4094 | ||
| useproxyport логический |
| Использовать порт прокси как порт источника при установлении соединений с сервером. При значении «нет» используется порт соединения на стороне клиента как порт источника для соединения на стороне сервера. Примечание: этот параметр доступен только при значении «да» для параметра «Использовать IP-адрес источника (USIP»). | |
| usip логический |
| Использовать IP-адрес клиента в качестве IP-адреса источника при установлении соединения с сервером. При создании службы, если этот параметр не задан, служба наследует глобальное значение параметра «Использовать IP-адрес источника» (доступно в командах CLI enable ns mode и disable ns mode или в диалоговом окне System > Settings > Configure modes > Configure Modes). Однако вы можете переопределить это значение после создания службы. | |
| validate_certs логический |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под личным контролем, использующих самозаверенные сертификаты. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Citrix NetScaler см. на странице https://www.ansible.com/ansible-netscaler.
Примеры
# Monitor monitor-1 must have been already setup
- name: Setup http service
gather_facts: False
delegate_to: localhost
community.network.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 словарь | ошибка | Словарь со списком различий между фактическим настроенным объектом и конфигурацией, указанной в модуле Пример: { '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.10/collections/community/network/netscaler_service_module.html
