community.network.avi_virtualservice модуль — Модуль для настройки объекта VirtualService Avi RESTful

active_standby_se_tag

строка

Эта конфигурация применяется только в случае, если виртуальная служба находится в режиме HA активный/резервный legacy, и включено распределение нагрузки между активным и резервным.

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

Виртуальные службы с разными тегами будут иметь разные активные сервис-энжины.

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

Перераспределение виртуальных служб может быть ручным или автоматическим при восстановлении вышедшего из строя сервис-энжина.

Перераспределение основано на свойстве автоматического перераспределения группы сервис-энжинов.

Варианты перечисления — ACTIVE_STANDBY_SE_1, ACTIVE_STANDBY_SE_2.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как ACTIVE_STANDBY_SE_1.

allow_invalid_client_cert

булево

Обрабатывать запрос даже если предоставлен недействительный сертификат клиента.

Для обработки таких запросов необходимо использовать API Datascript.

Поле введено в 18.2.3.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

• false
• true

analytics_policy

строка

Определяет параметры аналитики для приложения.

analytics_profile_ref

строка

Указывает параметры, относящиеся к аналитике.

Это ссылка на объект типа analyticsprofile.

api_context

словарь

Контекст API Avi, включающий текущий идентификатор сеанса и маркер CSRF.

Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс.

api_version

строка

Версия API Avi для использования с API Avi и объектами.

По умолчанию: "16.4.4"

apic_contract_graph

строка

Имя контракта/графа, связанного с виртуальной службой.

Должно быть в формате <имя контракта> <имя графа>.

Это применимо только для режима интеграции служб с контроллером Cisco APIC.

Поле введено в 17.2.12,18.1.2.

application_profile_ref

строка

Включение функций, специфичных для прикладного уровня, для виртуальной службы.

Это ссылка на объект типа applicationprofile.

auto_allocate_floating_ip

булево

Автоматическое выделение плавающего/упругого IP-адреса из инфраструктуры облака.

Поле устарело в 17.1.1.

Варианты:

• false
• true

auto_allocate_ip

булево

Автоматическое выделение VIP из указанной подсети.

Поле устарело в 17.1.1.

Варианты:

• false
• true

availability_zone

строка

Зона доступности для размещения виртуальной службы.

Поле устарело в 17.1.1.

avi_allocated_fip

булево

(внутреннее использование) выделенный Avi FIP в инфраструктуре облака.

Поле устарело в 17.1.1.

Варианты:

• false
• true

avi_allocated_vip

булево

(внутреннее использование) выделенный Avi VIP в инфраструктуре облака.

Поле устарело в 17.1.1.

Варианты:

• false
• true

avi_api_patch_op

строка

Операция исправления для использования при использовании avi_api_update_method в качестве исправления.

Варианты:

• "add"
• "replace"
• "delete"

avi_api_update_method

строка

Метод по умолчанию для обновления объекта — HTTP PUT.

Установка в исправление переопределит это поведение для использования HTTP PATCH.

Варианты:

• "put" ← (по умолчанию)
• "patch"

avi_credentials

словарь

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

api_version

строка

Версия контроллера Avi

По умолчанию: "16.4.4"

controller

строка

IP-адрес или SQDN контроллера Avi

csrftoken

string

Токен csrf контроллера Avi для повторного использования существующей сессии с идентификатором сессии

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

password

string

Пароль контроллера Avi

port

string

Порт контроллера Avi

session_id

string

Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken

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

tenant

string

Тенд контроллера Avi

По умолчанию: "admin"

tenant_uuid

string

UUID клиента контроллера Avi

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

timeout

string

Таймаут запроса контроллера Avi

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

token

string

Токен API контроллера Avi

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

username

string

Имя пользователя контроллера Avi

avi_disable_session_cache_as_fact

boolean

Отключает кеширование информации о сессии Avi как факта.

Варианты:

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

azure_availability_set

string

(для внутреннего использования)применимо только для Azure.

Набор доступности Azure, к которому связан этот vs.

Внутренне устанавливается коннектором облака.

Поле добавлено в 17.2.12, 18.1.2.

bulk_sync_kvcache

boolean

(это бета-функция).

Синхронизация кэша значений ключей с новой сессией при масштабировании vs.

Например, сессии ssl хранятся в кэше значений ключей vs.

При масштабировании vs информация о сессии ssl синхронизируется с новым se, что позволяет повторно использовать существующие сессии ssl на новом се.

Поле добавлено в 17.2.7, 18.1.1.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

• false
• true

client_auth

string

Конфигурация проверки подлинности HTTP для защищенных ресурсов.

close_client_conn_on_config_update

boolean

Закрыть клиентское соединение при обновлении конфигурации vs.

Поле добавлено в 17.2.4.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

• false
• true

cloud_config_cksum

string

Контрольная сумма конфигурации облака для vs.

Внутренне устанавливается коннектором облака.

cloud_ref

string

Ссылка на объект типа cloud.

cloud_type

string

Варианты перечисления — cloud_none, cloud_vcenter, cloud_openstack, cloud_aws, cloud_vca, cloud_apic, cloud_mesos, cloud_linuxserver, cloud_docker_ucp,

cloud_rancher, cloud_oshift_k8s, cloud_azure, cloud_gcp.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как CLOUD_NONE.

connections_rate_limit

string

Ограничение скорости входящих соединений для этого виртуального сервиса.

content_rewrite

string

Профиль, используемый для сопоставления и переписывания строк в теле запроса и/или ответа.

controller

string

IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER.

created_by

string

Имя создателя.

delay_fairness

boolean

Выбор алгоритма для справедливости qos.

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

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

• false
• true

description

string

Описание объекта, определяемое пользователем.

discovered_network_ref

string

(внутреннее использование) обнаруженные сети, обеспечивающие доступность для IP-адреса виртуальной службы, ориентированной на клиента.

Это поле устарело.

Это ссылка на объект типа network.

Поле устарело в версии 17.1.1.

discovered_networks

string

(внутреннее использование) обнаруженные сети, обеспечивающие доступность для IP-адреса виртуальной службы, ориентированной на клиента.

Это поле используется внутренне Avi, не редактируется пользователем.

Поле устарело в версии 17.1.1.

discovered_subnet

string

(внутреннее использование) обнаруженные подсети, обеспечивающие доступность для IP-адреса виртуальной службы, ориентированной на клиента.

Это поле устарело.

Поле устарело в версии 17.1.1.

dns_info

string

Данные, специфичные для обнаружения служб, включая полное доменное имя, тип и время жизни записи DNS.

Обратите внимание, что разрешено только одно из настроек fqdn и dns_info.

dns_policies

string

Политики DNS, применяемые к трафику DNS виртуальной службы.

Поле добавлено в версии 17.1.1.

east_west_placement

boolean

Принудительное размещение на всех SE в группе служб (только режим Mesos).

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

• false
• true

enable_autogw

boolean

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

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.

Варианты:

• false
• true

enable_rhi

boolean

Включить инъекцию состояния маршрута с использованием конфигурации BGP в контексте VRF.

Варианты:

• false
• true

enable_rhi_snat

boolean

Включить инъекцию состояния маршрута для IP-адреса плавающего SNAT с использованием конфигурации BGP в контексте VRF.

Варианты:

• false
• true

enabled

boolean

Включить или отключить виртуальную службу.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.

Варианты:

• false
• true

error_page_profile_ref

string

Профиль страницы ошибок, который будет использоваться для этой виртуальной службы. Этот профиль используется для отправки клиенту пользовательской страницы ошибок, созданной прокси-сервером.

Это ссылка на объект типа errorpageprofile.

Поле добавлено в версии 17.2.4.

floating_ip

string

Плавающий IP-адрес для ассоциации с этой виртуальной службой.

Поле устарело в версии 17.1.1.

floating_subnet_uuid

string

Если auto_allocate_floating_ip равно true и существует более одной подсети с плавающими IP-адресами, то подсеть для выделения IP-адреса.

Это поле применимо только если виртуальная служба принадлежит облаку OpenStack или AWS.

В облаке OpenStack или AWS это требуется, когда выбран auto_allocate_floating_ip.

Поле устарело в версии 17.1.1.

flow_dist

string

Критерии для распределения потоков между SE.

Варианты перечисления - LOAD_AWARE, CONSISTENT_HASH_SOURCE_IP_ADDRESS, CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как LOAD_AWARE.

flow_label_type

string

Критерии для маркировки потоков.

Варианты перечисления - NO_LABEL, APPLICATION_LABEL, SERVICE_LABEL.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как NO_LABEL.

fqdn

string

Разрешаемое DNS, полное доменное имя виртуальной службы.

Разрешена только одна конфигурация из «fqdn» и «dns_info».

host_name_xlate

string

Преобразовать имя хоста, отправленное на серверы, в это значение.

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

http_policies

string

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

ign_pool_net_reach

boolean

Игнорировать ограничения доступности сети серверов пула для размещения виртуальной службы.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Choices:

• false
• true

ip_address

string

IP-адрес виртуальной службы.

Поле устарело в версии 17.1.1.

ipam_network_subnet

string

Подсеть и/или сеть для выделения IP-адреса виртуальной службы модулем поставщика IPAM.

Поле устарело в версии 17.1.1.

l4_policies

string

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

Поле добавлено в версии 17.2.7.

limit_doser

boolean

Ограничивать потенциальных злоумышленников, осуществляющих DoS-атаки, которые значительно превышают max_cps_per_client, до доли max_cps_per_client на некоторое время.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Choices:

• false
• true

max_cps_per_client

string

Максимальное количество подключений в секунду на один IP-адрес клиента.

Допустимые значения: 10-1000.

Специальные значения: 0 - «неограниченное».

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.

microservice_ref

string

Микросервис, представляющий виртуальную службу.

Это ссылка на объект типа microservice.

min_pools_up

string

Минимальное количество активных пулов для пометки VS как активной.

Поле добавлено в версиях 18.2.1, 17.2.12.

name

string / required

Имя для виртуальной службы.

network_profile_ref

string

Определяет сетевые настройки, такие как протокол (TCP или UDP) и связанные параметры для протокола.

Это ссылка на объект типа networkprofile.

network_ref

string

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

Это ссылка на объект типа network.

Поле устарело в версии 17.1.1.

network_security_policy_ref

string

Политики безопасности сети для виртуальной службы.

Это ссылка на объект типа networksecuritypolicy.

nsx_securitygroup

string

Список групп служб NSX, представляющих клиентов, которые могут получить доступ к виртуальному IP-адресу виртуальной службы.

Поле добавлено в версии 17.1.1.

password

string

Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD.

performance_limits

string

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

pool_group_ref

string

Группа пулов — это объект, содержащий пулы.

Это ссылка на объект типа poolgroup.

pool_ref

string

Пул — это объект, содержащий целевые серверы и связанные атрибуты, такие как балансировка нагрузки и постоянство.

Это ссылка на объект типа pool.

port_uuid

string

(внутреннее использование) сетевой порт, назначенный IP-адресу виртуальной службы.

Поле устарело в версии 17.1.1.

remove_listening_port_on_vs_down

boolean

Удалить порт прослушивания, если виртуальная служба не работает.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Choices:

• false
• true

requests_rate_limit

string

Ограничить скорость входящих запросов к этой виртуальной службе.

saml_sp_config

string

Конфигурация SAML, специфичная для приложения.

Поле добавлено в версии 18.2.3.

scaleout_ecmp

boolean

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

Включите, если сама сеть выполняет хеширование потоков с ecmp в таких средах, как gcp.

Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

• false
• true

se_group_ref

string

Группа служб обработки, которая будет использоваться для этой виртуальной службы.

Переход в новую группу служб обработки приводит к прерыванию существующих соединений для этой виртуальной службы.

Это ссылка на объект типа serviceenginegroup.

security_policy_ref

string

Политика безопасности, применяемая к трафику виртуальной службы.

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

Это ссылка на объект типа securitypolicy.

Поле добавлено в версии 18.2.1.

server_network_profile_ref

string

Определяет профиль сетевых настроек для серверной стороны проксированных TCP-соединений.

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

Это ссылка на объект типа networkprofile.

service_metadata

string

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

В средах OpenShift/Kubernetes хранится информация о исходящих pod.

Любой пользовательский ввод в это поле будет перезаписан Avi Vantage.

service_pool_select

string

Выбор пула на основе порта назначения.

services

string

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

sideband_profile

string

Конфигурация боковой полосы, которая будет использоваться для этой виртуальной службы. Она может использоваться для отправки трафика на виртуальные IP-адреса боковой полосы для внешнего анализа и т. д.

snat_ip

string

NAT'ed плавающие IP-адреса источника для входящего соединения с серверами.

sp_pool_refs

string

Пулы GSLB, используемые для управления функциональностью сохранения сеанса.

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

Это поле доступно только для чтения для пользователя.

Это ссылка на объект типа pool.

Поле добавлено в версии 17.2.2.

ssl_key_and_certificate_refs

string

Выберите или создайте один или два сертификата, EC и/или RSA, которые будут представлены для завершенных SSL/TLS-соединений.

Это ссылка на объект типа sslkeyandcertificate.

ssl_profile_ref

string

Определяет набор версий SSL и шифров, которые будут приниматься для завершенных SSL/TLS-соединений.

Это ссылка на объект типа sslprofile.

ssl_profile_selectors

string

Выбор профиля SSL на основе соответствия IP-адреса клиента.

Поле добавлено в версии 18.2.3.

ssl_sess_cache_avg_size

string

Ожидаемое количество записей в кэше сеансов SSL (может быть превышено).

Допустимые значения: 1024-16383.

Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 1024.

sso_policy

string

Политика аутентификации и авторизации клиента для виртуальной службы.

Поле устарело в версии 18.2.3.

Поле добавлено в версии 18.2.1.

sso_policy_ref

string

Политика SSO, прикрепленная к виртуальной службе.

Это ссылка на объект типа ssopolicy.

Поле добавлено в версии 18.2.3.

state

string

Состояние, которое должно быть применено к объекту.

Варианты:

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

static_dns_records

string

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

Это статические записи, и мониторинг работоспособности не выполняется для IP-адресов.

subnet

string

Подсеть, обеспечивающая доступность для клиентского IP-адреса виртуальной службы.

Поле устарело в версии 17.1.1.

subnet_uuid

string

Представляет подсеть для выделения IP-адреса виртуальной службы, когда auto_allocate_ip имеет значение true. Применимо только в облаке OpenStack или AWS.

Это поле обязательно, если auto_allocate_ip имеет значение true.

Поле устарело в версии 17.1.1.

tenant

string

Имя клиента, используемого для всех вызовов Avi API и контекста объекта.

По умолчанию: "admin"

tenant_ref

string

Это ссылка на объект типа tenant.

tenant_uuid

string

UUID арендатора, используемый для всех вызовов Avi API и контекста объекта.

Default: ""

topology_policies

string

Политики топологии, применяемые к DNS-трафику виртуальной службы на основе алгоритма топологии GSLB.

Поле добавлено в версии 18.2.3.

traffic_clone_profile_ref

string

Серверная сеть или список серверов для клонирования трафика.

Это ссылка на объект типа trafficcloneprofile.

Поле добавлено в версии 17.1.1.

traffic_enabled

boolean

Переключатель для включения трафика виртуальной службы на назначенных ей сервисных модулях.

Эта настройка эффективна только тогда, когда флаг enabled установлен в true.

Поле добавлено в версии 17.2.8.

Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как True.

Choices:

• false
• true

type

string

Укажите, является ли это обычной виртуальной службой или родительской/дочерней виртуальной службой с поддержкой SNI.

Варианты перечисления - VS_TYPE_NORMAL, VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD.

Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как VS_TYPE_NORMAL.

url

string

URL контроллера Avi объекта.

use_bridge_ip_as_vip

boolean

Использовать bridge IP в качестве VIP на каждом хосте в развертываниях Mesos.

Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False.

Choices:

• false
• true

use_vip_as_snat

boolean

Использовать виртуальный IP в качестве SNAT IP для мониторинга работоспособности и отправки трафика на серверы бэкенда вместо IP-адреса интерфейса сервисного модуля.

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

Для обеспечения высокой доступности и бесперебойного обновления необходимо использовать решение с несколькими VIP-адресами на основе DNS.

Поле добавлено в версиях 17.1.9, 17.2.3.

Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False.

Choices:

• false
• true

username

string

Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME.

uuid

string

Uuid виртуальной службы.

vh_domain_name

string

Точное имя, запрошенное из поля имени домена TLS Hello, поддерживающего SNI, от клиента.

Если это совпадение, родительская VS перенаправит соединение этой дочерней VS.

vh_parent_vs_uuid

string

Указывает виртуальную службу, выступающую в качестве родительской службы виртуального хостинга (SNI).

vip

string

Список IP-адресов виртуальной службы.

При создании «общей VS» используйте vsvip_ref для указания на общие сущности.

Поле добавлено в версии 17.1.1.

vrf_context_ref

string

Контекст виртуального маршрутизации, к которому привязана виртуальная служба.

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

Это ссылка на объект типа vrfcontext.

vs_datascripts

string

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

vsvip_cloud_config_cksum

string

Контрольная сумма конфигурации облака для vsvip.

Внутренне устанавливается соединителем облака.

Поле добавлено в версиях 17.2.9, 18.1.2.

vsvip_ref

string

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

Это ссылка на объект типа vsvip.

Поле добавлено в версии 17.1.1.

waf_policy_ref

string

Политика WAF для виртуальной службы.

Это ссылка на объект типа wafpolicy.

Поле добавлено в версии 17.2.1.

weight

string

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

Более высокий вес будет приоритезировать трафик по сравнению с другими виртуальными службами, использующими одни и те же сервисные модули.

Допустимые значения — 1-128.

Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как 1.