netscaler_service - Управление конфигурацией службы в Netscaler
Новое в версии 2.4.0.
- Синопсис
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
Синопсис
- Управление конфигурацией службы в Netscaler.
- Этот модуль позволяет создавать, удалять и изменять службы Netscaler.
- Этот модуль предназначен для выполнения либо на узле управления Ansible, либо на бастионе (шлюзе), имеющем доступ к фактической инстанции netscaler.
- Этот модуль поддерживает режим проверки.
Требования (к хосту, на котором выполняется модуль)
- nitro python sdk
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accessdown | нет | Используйте режим уровня 2 для перенаправления пакетов, отправленных в этот сервис, если он помечен как ОТКЛЮЧЕН. Если сервис ОТКЛЮЧЕН, а этот параметр отключен, пакеты будут отброшены. | |||||||||||||||||||||||||||
| appflowlog | нет |
| Включить протоколирование информации AppFlow. | ||||||||||||||||||||||||||
| cacheable | нет | Использовать виртуальный сервер прозрачного кэширования для переадресации запросов на сервер кэширования. Примечание: Не указывайте этот параметр, если вы установили параметр Тип кэширования. | |||||||||||||||||||||||||||
| cachetype | нет |
| Тип кэширования, поддерживаемый сервером кэширования. | ||||||||||||||||||||||||||
| cip | нет |
| Перед переадресацией запроса на сервис вставить HTTP-заголовок с адресом 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 | нет | None | Уникальный идентификатор сервиса. Используется, когда тип сохранения для виртуального сервера установлен в «Custom Server ID». | ||||||||||||||||||||||||||
| disabled | нет |
| При установке в yes состояние сервиса будет установлено в ОТКЛЮЧЕН.При установке в no состояние сервиса будет установлено в ВКЛЮЧЕНО.Обратите внимание, что из-за ограничений базового API NITRO простое изменение состояния disabled не приводит к тому, что модуль отображает изменение статуса. | ||||||||||||||||||||||||||
| dnsprofilename | нет | Имя профиля DNS, которое будет ассоциировано с сервисом. Свойства профиля DNS будут применяться к транзакциям, обрабатываемым сервисом. Этот параметр действителен только для сервисов ADNS и ADNS-TCP. Минимальная длина = 1 Максимальная длина = 127 | |||||||||||||||||||||||||||
| downstateflush | нет |
| Очистить все активные транзакции, связанные с сервисом, состояние которого переходит из СОЕДИНЕННО в ОТКЛЮЧЕН. Не включайте этот параметр для приложений, которые должны завершить свои транзакции. | ||||||||||||||||||||||||||
| graceful | нет | Плавно завершить работу, не принимая новые подключения и отключив сервис, когда все его подключения будут закрыты. | |||||||||||||||||||||||||||
| hashid | нет | Числовой идентификатор, который может использоваться методами балансировки нагрузки на основе хеширования. Должен быть уникальным для каждого сервиса. Минимальное значение = 1 | |||||||||||||||||||||||||||
| healthmonitor | нет | True | Отслеживать состояние этого сервиса | ||||||||||||||||||||||||||
| httpprofilename | нет | Имя HTTP-профиля, содержащего настройки HTTP для сервиса. Минимальная длина = 1 Максимальная длина = 127 | |||||||||||||||||||||||||||
| ip | нет | IP-адрес, который необходимо назначить сервису. Минимальная длина = 1 | |||||||||||||||||||||||||||
| ipaddress | нет | Новый IP-адрес сервиса. | |||||||||||||||||||||||||||
| maxbandwidth | нет | Максимальная пропускная способность, в Кбит/с, выделенная для сервиса. Минимальное значение = 0 Максимальное значение = 4294967287 | |||||||||||||||||||||||||||
| maxclient | нет | Максимальное количество одновременных открытых подключений к сервису. Минимальное значение = 0 Максимальное значение = 4294967294 | |||||||||||||||||||||||||||
| maxreq | нет | Максимальное количество запросов, которые могут быть отправлены по постоянному подключению к сервису. Примечание: Запросы подключений сверх этого значения отклоняются. Минимальное значение = 0 Максимальное значение = 65535 | |||||||||||||||||||||||||||
| monitor_bindings | нет | Список мониторов балансировки нагрузки, которые необходимо привязать к этому сервису. Каждая запись монитора — это словарь, который может содержать следующие параметры. Обратите внимание, что если не используются встроенные мониторы, их необходимо сначала настроить. |
|||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
| monthreshold | нет | Минимальная сумма весов мониторов, привязанных к этому сервису. Используется для определения, следует ли отмечать сервис как СОЕДИНЕН или ОТКЛЮЧЕН. Минимальное значение = 0 Максимальное значение = 65535 | |||||||||||||||||||||||||||
| name | нет | Имя сервиса. Должно начинаться с ASCII-буквенного или подчеркивающего _ символа и содержать только ASCII-буквенно-цифровые, подчеркивающие _, хэш #, точки ., пробелы , двоеточия :, знаки «@» @, знаки «=» =, и дефисы - символы. Не может быть изменено после создания сервиса.Минимальная длина = 1 | |||||||||||||||||||||||||||
| netprofile | нет | Сеть-профиль для использования в сервисе. Минимальная длина = 1 Максимальная длина = 127 | |||||||||||||||||||||||||||
| nitro_pass | да | Пароль для аутентификации на узле Netscaler. | |||||||||||||||||||||||||||
| nitro_protocol | нет | http |
| Протокол для доступа к объектам 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 | нет | Включить отображение ID сеанса RTSP для сервиса. | |||||||||||||||||||||||||||
| save_config | нет | True |
| Если true, модуль сохранит конфигурацию на узле Netscaler, если внесет какие-либо изменения. Модуль не сохранит конфигурацию на узле Netscaler, если не внес никаких изменений. | |||||||||||||||||||||||||
| serverid | нет | Идентификатор сервиса. Используется, когда тип сохранения установлен в «Custom Server ID». | |||||||||||||||||||||||||||
| servername | нет | Имя сервера, на котором размещен сервис. Минимальная длина = 1 | |||||||||||||||||||||||||||
| тип_сервиса | нет |
| Протокол, в котором происходит обмен данными с сервисом. | |
| sp | нет | Включить защиту от импульсных перенапряжений для сервиса. | ||
| состояние | нет | присутствует |
| Состояние ресурса, настраиваемого модулем на узле netscaler. При значении "присутствует" ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При значении "отсутствует" ресурс будет удален с узла netscaler. |
| svrtimeout | нет | Время в секундах, после которого будет прервано неактивное соединение с сервером. Минимальное значение = 0 Максимальное значение = 31536000 | ||
| tcpb | нет | Включить буферизацию TCP для сервиса. | ||
| имя_профиля_tcp | нет | Имя профиля TCP, содержащего настройки TCP для сервиса. Минимальная длина = 1 Максимальная длина = 127 | ||
| td | нет | Целочисленное значение, уникально идентифицирующее домен трафика, в котором требуется настроить сущность. Если идентификатор не указан, сущность становится частью стандартного домена трафика с идентификатором 0. Минимальное значение = 0 Максимальное значение = 4094 | ||
| использовать_порт_прокси | нет | Использовать порт прокси в качестве исходного порта при установлении соединений с сервером. При значении "нет" используется порт подключения клиента в качестве исходного порта для соединения со стороны сервера. Примечание: Этот параметр доступен только при установке параметра Использовать IP-адрес источника (USIP) в значение ДА. | ||
| usip | нет | Использовать IP-адрес клиента в качестве исходного IP-адреса при установлении соединения с сервером. При создании сервиса, если этот параметр не задан, сервис наследует глобальную настройку Использовать IP-адрес источника (доступна в командах CLI enable ns mode и disable ns mode, или в диалоговом окне System > Settings > Configure modes > Configure Modes). Однако вы можете переопределить эту настройку после создания сервиса. | ||
| validate_certs | нет | да | Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов. |
Примеры
# 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 | { 'clttimeout': 'разница. наше: (float) 10.0 другое: (float) 20.0' } |
| loglines | список журнальных сообщений, записанных модулем | всегда | list | ['сообщение 1', 'сообщение 2'] |
Состояние
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для получения помощи в разработке на модулях, если вы заинтересованы, пожалуйста, прочитайте Информацию о сообществе и сотрудничестве, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/netscaler_service_module.html
