Spec-Zone.ru › Ansible

community.network.netscaler_service модуль — Управление конфигурацией сервиса в Netscaler

Примечание

Этот модуль является частью коллекции community.network (версия 5.0.3).

Вы, возможно, уже установили эту коллекцию, если используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.network. Для использования этого модуля требуются дополнительные зависимости, см. Требования для получения подробностей.

Чтобы использовать его в playbook, укажите: community.network.netscaler_service.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Управление конфигурацией сервиса в Netscaler.
  • Этот модуль позволяет создавать, удалять и изменять сервисы Netscaler.
  • Этот модуль предназначен для работы на узле управления Ansible или на бастионе (прокси-сервере) с доступом к фактической инстанции Netscaler.
  • Этот модуль поддерживает режим проверки.

Псевдонимы: network.netscaler.netscaler_service

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • nitro python sdk
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

accessdown

boolean

Использовать режим уровня 2 для перенаправления пакетов, отправленных этому сервису, если он помечен как ВЫКЛЮЧЕН. Если сервис ВЫКЛЮЧЕН, и этот параметр отключён, пакеты будут отброшены.

Варианты:

  • false ← (по умолчанию)
  • true

appflowlog

string

Включить протоколирование информации AppFlow.

Варианты:

  • "enabled"
  • "disabled"

cacheable

boolean

Использовать виртуальный сервер прозрачного кэширования для перенаправления запросов на сервер кэширования.

Примечание: Не указывайте этот параметр, если вы задали параметр Тип кэша.

Варианты:

  • false ← (по умолчанию)
  • true

cachetype

string

Тип кэша, поддерживаемый сервером кэширования.

Варианты:

  • "TRANSPARENT"
  • "REVERSE"
  • "FORWARD"

cip

string

Перед пересылкой запроса на сервис вставить HTTP-заголовок с IP-адресом клиента (IPv4 или IPv6) в качестве значения. Используется, если серверу необходим IP-адрес клиента для обеспечения безопасности, учёта или других целей, и установка параметра Использовать IP-адрес источника не является целесообразным вариантом.

Варианты:

  • "enabled"
  • "disabled"

cipheader

string

Имя HTTP-заголовка, значение которого должно быть установлено в IP-адрес клиента. Используется с параметром IP-адрес клиента. Если вы задаёте параметр IP-адрес клиента, и не указываете имя заголовка, прибор использует имя заголовка, заданное для глобального параметра Заголовок IP-адреса клиента (параметр cipHeader в команде CLI set ns param или параметр Заголовок IP-адреса клиента в диалоговом окне Настройка параметров HTTP в разделе Система > Настройки > Изменение параметров HTTP). Если глобальный параметр Заголовок IP-адреса клиента не указан, прибор вставляет заголовок с именем «client-ip».

Минимальная длина = 1

cka

boolean

Включить client keep-alive для сервиса.

Варианты:

  • false
  • true

healthmonitor

boolean

Отслеживать работоспособность данного сервиса

Варианты:

  • false
  • true ← (по умолчанию)

httpprofilename

string

Имя HTTP-профиля, содержащего настройки HTTP-конфигурации для сервиса.

Минимальная длина = 1

Максимальная длина = 127

ip

string

IP-адрес, назначаемый службе.

Минимальная длина = 1

ipaddress

string

Новый IP-адрес службы.

maxbandwidth

string

Максимальная пропускная способность, в Кбит/с, выделенная службе.

Минимальное значение = 0

Максимальное значение = 4294967287

maxclient

string

Максимальное количество одновременных открытых подключений к службе.

Минимальное значение = 0

Максимальное значение = 4294967294

maxreq

string

Максимальное количество запросов, которые могут быть отправлены по постоянно открытому подключению к службе.

Примечание: Запросы подключений, превышающие это значение, отклоняются.

Минимальное значение = 0

Максимальное значение = 65535

monitor_bindings

string

Список мониторов балансировки нагрузки, которые необходимо привязать к данной службе.

Каждый элемент монитора — словарь, который может содержать следующие параметры.

Обратите внимание, что если используются не встроенные мониторы, их необходимо сначала настроить.

dup_state

string

Состояние монитора.

Установка состояния монитора определенного типа влияет на все мониторы этого типа.

Например, если HTTP-монитор включен, все HTTP-мониторы на устройстве включены (или остаются включенными).

Если HTTP-монитор выключен, все HTTP-мониторы на устройстве выключаются.

Варианты:

  • "enabled"
  • "disabled"

dup_weight

string

Вес, назначаемый связи между монитором и службой.

monitorname

string

Имя монитора.

weight

string

Вес, назначаемый связи между монитором и службой.

monthreshold

string

Минимальная сумма весов мониторов, привязанных к этой службе. Используется для определения, следует ли помечать службу как активную или неактивную.

Минимальное значение = 0

Максимальное значение = 65535

name

string

Имя службы. Должно начинаться с ASCII-буквы или символа подчеркивания _, и содержать только ASCII-буквы, цифры, символ подчеркивания _, символ решетки #, точку ., пробел, двоеточие :, символ «@» @, знак равенства =, и дефис -. Не может быть изменено после создания службы.

Минимальная длина = 1

netprofile

string

Используемый сетевой профиль для службы.

Минимальная длина = 1

Максимальная длина = 127

nitro_pass

string / обязательно

Пароль для аутентификации на узле netscaler.

nitro_protocol

string

Используемый протокол при доступе к объектам API Nitro.

Варианты:

  • "http" ← (по умолчанию)
  • "https"

nitro_timeout

float

Время в секундах до сброса тайм-аута при установлении нового сеанса с Netscaler

По умолчанию: 310.0

nitro_user

string / обязательно

Имя пользователя для аутентификации на узле netscaler.

nsip

string / обязательно

IP-адрес устройства netscaler, на котором будут выполняться вызовы API Nitro.

Порт можно указать с двоеточием (:). Например, 192.168.1.1:555.

pathmonitor

string

Мониторинг путей для кластеризации.

pathmonitorindv

string

Индивидуальные решения по мониторингу путей.

END_OF_DOCUMENT_MARKER

port

string

Номер порта сервиса.

Диапазон 1 - 65535

* в CLI представлен как 65535 в NITRO API

processlocal

string

Включив этот параметр, пакеты, предназначенные для сервиса в кластере, не будут подвергаться перенаправлению. Включите этот параметр для режима запроса-ответа на один пакет или когда устройство upstream выполняет надлежащий RSS для распределения по соединениям.

Варианты:

  • "enabled"
  • "disabled"

rtspsessionidremap

boolean

Включить отображение ID сеанса RTSP для сервиса.

Варианты:

  • false ← (по умолчанию)
  • true

save_config

boolean

Если yes, модуль сохранит конфигурацию на узле NetScaler, если внесены какие-либо изменения.

Модуль не сохранит конфигурацию на узле NetScaler, если изменения не были внесены.

Варианты:

  • false
  • true ← (по умолчанию)

serverid

string

Идентификатор сервиса. Используется, когда тип персистентности установлен на «Custom Server ID».

servername

string

Имя сервера, на котором размещен сервис.

Минимальная длина = 1

servicetype

string

Протокол обмена данными с сервисом.

Варианты:

  • "HTTP"
  • "FTP"
  • "TCP"
  • "UDP"
  • "SSL"
  • "SSL_BRIDGE"
  • "SSL_TCP"
  • "DTLS"
  • "NNTP"
  • "RPCSVR"
  • "DNS"
  • "ADNS"
  • "SNMP"
  • "RTSP"
  • "DHCPRA"
  • "ANY"
  • "SIP_UDP"
  • "SIP_TCP"
  • "SIP_SSL"
  • "DNS_TCP"
  • "ADNS_TCP"
  • "MYSQL"
  • "MSSQL"
  • "ORACLE"
  • "RADIUS"
  • "RADIUSListener"
  • "RDP"
  • "DIAMETER"
  • "SSL_DIAMETER"
  • "TFTP"
  • "SMPP"
  • "PPTP"
  • "GRE"
  • "SYSLOGTCP"
  • "SYSLOGUDP"
  • "FIX"
  • "SSL_FIX"

sp

boolean

Включить защиту от всплесков для сервиса.

Варианты:

  • false
  • true

state

string

Состояние ресурса, настраиваемого модулем на узле NetScaler.

При наличии ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля.

При отсутствии ресурс будет удален с узла NetScaler.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

Примечания

Примечание

  • Дополнительную информацию об использовании 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": "difference. ours: (float) 10.0 other: (float) 20.0"}

loglines

список / элементы=строка

Список сообщений, зарегистрированных модулем

Возвращается: всегда

Пример: ["['message 1'", " 'message 2']"]

Авторы

  • Георгий Николопулос (@giorgos-nikolopoulos)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/netscaler_service_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API