community.network.netscaler_service – Управление конфигурацией сервиса в Netscaler
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.netscaler_service.
Описание
- Управление конфигурацией сервиса в 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 строка | Значение по умолчанию: "Нет" | Уникальный идентификатор службы. Используется, когда тип персистентности для виртуального сервера установлен на 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 строка |
| Включив этот параметр, пакеты, предназначенные для службы в кластере, не будут подвергаться перенаправлению. Включите этот параметр для режима запроса-ответа одного пакета или когда устройство upstream выполняет правильный 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-адрес источника» (доступную в командах интерфейса командной строки enable ns mode и disable ns mode или в диалоговом окне «Система» > «Настройки» > «Настройка режимов» > «Настройка режимов»). Однако вы можете переопределить эту настройку после создания службы. | |
| validate_certs логическое |
| Если 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
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/netscaler_service_module.html
