avi_virtualservice - Модуль для настройки виртуальной службы Avi RESTful объекта

Новая версия 2.3.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

Этот модуль используется для настройки объекта виртуальной службы
больше примеров по адресу https://github.com/avinetworks/devops

Требования

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

avisdk

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
active_standby_se_tag		Эта конфигурация применяется только если виртуальная служба находится в режиме резервного копирования legacy active standby ha и включено распределение нагрузки между активным и резервным. Это поле используется для маркировки виртуальной службы, чтобы виртуальные службы с одинаковой меткой использовали один и тот же активный движок сервисов. Виртуальные службы с различными метками будут иметь разные активные движки сервисов. Если один из движков сервисов в группе движков сервисов выходит из строя, все виртуальные службы будут использовать один и тот же активный движок сервисов. Перераспределение виртуальных служб может быть ручным или автоматическим при восстановлении вышедшего из строя движка сервисов. Перераспределение основано на свойстве автоматического перераспределения группы движков сервисов. Варианты перечисления - ACTIVE_STANDBY_SE_1, ACTIVE_STANDBY_SE_2. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как ACTIVE_STANDBY_SE_1.
analytics_policy		Определяет параметры аналитики для приложения.
analytics_profile_ref		Указывает параметры, связанные с аналитикой. Это ссылка на объект типа analyticsprofile.
api_context (добавлено в 2.5)		Контекст API Avi, который включает текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию.
api_version	По умолчанию: 16.4.4	Версия API Avi для использования в Avi API и объектов.
application_profile_ref		Включить функции, специфичные для прикладного уровня, для виртуальной службы. Это ссылка на объект типа applicationprofile.
auto_allocate_floating_ip	Варианты: no yes	Автоматическое выделение плавающего/упругого IP-адреса из инфраструктуры облака. Поле устарело в 17.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False.
auto_allocate_ip	Варианты: no yes	Автоматическое выделение VIP из указанной подсети. Поле устарело в 17.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False.
availability_zone		Зона доступности для размещения виртуальной службы. Поле устарело в 17.1.1.
avi_allocated_fip	Варианты: no yes	(для внутреннего использования) fip, выделенный Avi в инфраструктуре облака. Поле устарело в 17.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False.
avi_allocated_vip	Варианты: no yes	(для внутреннего использования) vip, выделенный Avi в инфраструктуре облака. Поле устарело в 17.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False.
avi_api_patch_op (добавлено в 2.5)	Варианты: add replace delete	Операция исправления, которая должна использоваться при использовании avi_api_update_method как patch.
avi_api_update_method (добавлено в 2.5)	Варианты: put ← patch	Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение на использование HTTP PATCH.
avi_credentials (добавлено в 2.5)		Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в систему контроллера Avi.
client_auth		Конфигурация аутентификации HTTP для защищённых ресурсов.
close_client_conn_on_config_update (добавлено в 2.5)	Варианты: no yes	Закрыть клиентское соединение при обновлении конфигурации vs. Поле добавлено в 17.2.4. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False.
cloud_config_cksum		Контрольная сумма конфигурации облака для vs. Внутренне устанавливается облачным адаптером.
cloud_ref		Это ссылка на объект типа cloud.
cloud_type		Варианты перечисления - 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. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как CLOUD_NONE.
connections_rate_limit		Ограничить скорость входящих подключений к этой виртуальной службе.
content_rewrite		Профиль, используемый для сопоставления и переписывания строк в теле запроса и/или ответа.
controller	По умолчанию:	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
created_by		Имя создателя.
delay_fairness	Варианты: no yes	Выберите алгоритм для справедливости qos. Это определяет, как несколько виртуальных служб, использующих одни и те же движки сервисов, будут приоритезировать трафик при перегрузке сети. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False.
description		Определение пользователя для объекта.
discovered_network_ref		(для внутреннего использования) обнаруженные сети, обеспечивающие достижимость для виртуального IP-адреса виртуальной службы, обращённой к клиенту. Это поле устарело. Это ссылка на объект типа network. Поле устарело в 17.1.1.
discovered_networks		(для внутреннего использования) обнаруженные сети, обеспечивающие достижимость для виртуального IP-адреса виртуальной службы, обращённой к клиенту. Это поле используется внутри Avi, его нельзя изменить пользователю. Поле устарело в 17.1.1.
discovered_subnet		(для внутреннего использования) обнаруженные подсети, обеспечивающие достижимость для виртуального IP-адреса виртуальной службы, обращённой к клиенту. Это поле устарело. Поле устарело в 17.1.1.
dns_info		Данные, специфичные для обнаружения служб, включая полное доменное имя, тип и время жизни записи DNS. Обратите внимание, что разрешено только одно из значений: fqdn и dns_info.
dns_policies (добавлено в 2.4)		Политики DNS, применяемые к трафику DNS виртуальной службы. Поле добавлено в 17.1.1.
east_west_placement	Варианты: no yes	Принудительное размещение на всех движках сервисов в группе сервисов (только режим mesos). Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False.
enable_autogw	Варианты: no yes	Трафик ответа клиентам будет отправлен обратно по исходному MAC-адресу соединения, а не статически отправлен на шлюз по умолчанию. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как True.
enable_rhi	Варианты: no yes	Включить инъекцию состояния маршрута, используя конфигурацию bgp в контексте vrf.
enable_rhi_snat	Варианты: no yes	Включить инъекцию состояния маршрута для адреса плавающего IP, перенаправленного по источнику, используя конфигурацию bgp в контексте vrf.
enabled	Варианты: no yes	Включить или отключить виртуальную службу. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как True.
error_page_profile_ref (добавлено в 2.5)		Профиль страницы ошибки, который будет использоваться для этой виртуальной службы. Этот профиль используется для отправки на клиент пользовательской страницы ошибки, сгенерированной прокси. Это ссылка на объект типа errorpageprofile. Поле добавлено в 17.2.4.
floating_ip		Плавающий IP-адрес, который нужно связать с этой виртуальной службой. Поле устарело в 17.1.1.
floating_subnet_uuid		Если auto_allocate_floating_ip равно true и существует более одной подсети плавающего IP-адреса, то подсеть для выделения плавающего IP-адреса. Это поле применимо только если виртуальная служба принадлежит облаку openstack или aws. В облаках openstack или aws требуется при выборе auto_allocate_floating_ip. Поле устарело в 17.1.1.
flow_dist		Критерии распределения потоков между движками сервисов. Варианты перечисления - LOAD_AWARE, CONSISTENT_HASH_SOURCE_IP_ADDRESS, CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как LOAD_AWARE.
flow_label_type		Критерии присвоения меток потокам. Варианты перечисления - NO_LABEL, APPLICATION_LABEL, SERVICE_LABEL. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как NO_LABEL.

fqdn		Разрешаемый DNS, полное доменное имя виртуальной службы. Допускается только одна из конфигураций 'fqdn' и 'dns_info'.
host_name_xlate		Перевести имя хоста, отправленное серверам, на это значение. Перевести имя хоста, отправленное с серверов, обратно в значение, используемое клиентом.
http_policies		Применяемые к трафику данных виртуальной службы HTTP-политики.
ign_pool_net_reach	Choices: нет да	Игнорировать ограничения сетевой доступности серверов пула для размещения виртуальной службы. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
ip_address		IP-адрес виртуальной службы. Поле устарело в версии 17.1.1.
ipam_network_subnet		Подсеть и/или сеть для выделения IP-адреса виртуальной службы модулем поставщика IPAM. Поле устарело в версии 17.1.1.
limit_doser	Choices: нет да	Ограничить потенциальных атакующих DoS, которые значительно превышают max_cps_per_client, до некоторой доли max_cps_per_client в течение некоторого времени. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
max_cps_per_client		Максимальное количество подключений в секунду на IP-адрес клиента. Допустимые значения: 10-1000. Специальные значения: 0 — неограниченное. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.
microservice_ref		Микросервис, представляющий виртуальную службу. Это ссылка на объект типа microservice.
name обязательно		Имя виртуальной службы.
network_profile_ref		Определяет сетевые параметры, такие как протокол, TCP или UDP, и связанные параметры протокола. Это ссылка на объект типа networkprofile.
network_ref		Вручную переопределить сеть, на которой размещена виртуальная служба. Это ссылка на объект типа network. Поле устарело в версии 17.1.1.
network_security_policy_ref		Политики сетевой безопасности для виртуальной службы. Это ссылка на объект типа networksecuritypolicy.
nsx_securitygroup (добавлено в 2.4)		Список nsx-групп сервисов, представляющих клиентов, которые могут получить доступ к виртуальному IP-адресу виртуальной службы. Поле добавлено в версии 17.1.1.
password	По умолчанию:	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
performance_limits		Необязательные параметры, определяющие пределы производительности, такие как максимальное количество подключений или пропускная способность.
pool_group_ref		Группа пулов — объект, содержащий пулы. Это ссылка на объект типа poolgroup.
pool_ref		Пул — объект, содержащий целевые серверы и связанные атрибуты, такие как балансировка нагрузки и сохранение состояния. Это ссылка на объект типа pool.
port_uuid		(для внутреннего использования) сетевой порт, назначенный IP-адресу виртуальной службы. Поле устарело в версии 17.1.1.
remove_listening_port_on_vs_down	Choices: нет да	Удалить порт прослушивания, если виртуальная служба выключена. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
requests_rate_limit		Ограничить скорость входящих запросов для этой виртуальной службы.
scaleout_ecmp	Choices: нет да	Отключить перераспределение потоков между движками сервисов для виртуальной службы. Включить, если сеть сама выполняет хэширование потоков с ecmp в таких средах, как gcp. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
se_group_ref		Группа движков сервисов для использования этой виртуальной службы. Переход в новую группу движков сервисов нарушает существующие подключения для данной виртуальной службы. Это ссылка на объект типа serviceenginegroup.
server_network_profile_ref		Определяет профиль сетевых настроек для серверной стороны подключений с проксированием TCP. Оставить пустым, чтобы использовать те же настройки, что и для клиентской стороны подключения к виртуальной службе. Это ссылка на объект типа networkprofile.
service_metadata (добавлено в 2.4)		Метаданные, относящиеся к сервису, предоставляемому этой виртуальной службой. В средах openshift/kubernetes хранится информация о выходящих под-контейнерах. Любой ввод пользователя в это поле будет перезаписан Vantage Avi.
service_pool_select		Выбор пула на основе целевого порта.
services		Список сервисов, определенных для этой виртуальной службы.
sideband_profile (добавлено в 2.4)		Конфигурация sideband, которая будет использоваться для этой виртуальной службы. Может использоваться для отправки трафика на sideband виртуальные IP для внешнего анализа и т.д.
snat_ip		NAT-преобразованный плавающий источник IP-адреса(ов) для входного соединения с серверами.
sp_pool_refs (добавлено в 2.5)		Пулы GSLB, используемые для управления функциональностью site-persistence. Каждый пул site-persistence содержит виртуальные службы во всех других сайтах, автоматически сгенерированные менеджером GSLB. Это поле только для чтения для пользователя. Ссылка на объект типа pool. Поле добавлено в версии 17.2.2.
ssl_key_and_certificate_refs		Выберите или создайте один или два сертификата (EC и/или RSA), которые будут представлены для завершенных ssl/tls-соединений. Это ссылка на объект типа sslkeyandcertificate.
ssl_profile_ref		Определяет набор ssl-версий и шифров для принятия ssl/tls-завершенных соединений. Это ссылка на объект типа sslprofile.
ssl_sess_cache_avg_size		Ожидаемое количество записей кеша ssl-сессий (может быть превышено). Допустимые значения: 1024-16383. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1024.
state	Choices: отсутствует присутствует ←	Состояние, которое должно быть применено к сущности.
static_dns_records		Список статических записей DNS, примененных к этой виртуальной службе. Это статические записи, и мониторинг работоспособности не выполняется для IP-адресов.
subnet		Подсеть, обеспечивающая доступность IP-адреса виртуальной службы, обращенной к клиенту. Поле устарело в версии 17.1.1.
subnet_uuid		Представляет подсеть для выделения IP-адреса виртуальной службы при auto_allocate_ip=true. Применима только в облаках OpenStack или AWS. Это поле необходимо, если auto_allocate_ip=true. Поле устарело в версии 17.1.1.
tenant	По умолчанию: admin	Имя клиента, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref		Ссылка на объект типа tenant.
tenant_uuid	По умолчанию:	UUID клиента, используемого для всех вызовов API Avi и контекста объекта.
traffic_clone_profile_ref (добавлено в 2.4)		Сеть сервера или список серверов для клонирования трафика. Ссылка на объект типа trafficcloneprofile. Поле добавлено в версии 17.1.1.
type		Укажите, является ли это обычной виртуальной службой или она является родительской или дочерней службой виртуальной службы с включенной функцией sni. Варианты перечисления: VS_TYPE_NORMAL, VS_TYPE_VH_PARENT, VS_TYPE_VH_CHILD. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как VS_TYPE_NORMAL.
url		URL контроллера Avi для объекта.
use_bridge_ip_as_vip	Choices: нет да	Использовать IP-адрес моста в качестве VIP на каждом хосте в развертываниях Mesos. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
use_vip_as_snat (добавлено в 2.5)	Choices: нет да	Использовать виртуальный IP-адрес в качестве IP-адреса SNAT для мониторинга работоспособности и отправки трафика на сервера-получатели вместо IP-адреса интерфейса движка сервиса. Ограничение использования этого параметра заключается в том, что виртуальную службу нельзя настроить в режиме активного-активного HA. Для HA и бесперебойных обновлений необходимо использовать многоадресное решение на основе DNS. Поле добавлено в версиях 17.1.9, 17.2.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Имя пользователя	По умолчанию:	Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения `AVI_USERNAME`.
uuid		Uuid виртуальной службы.
vh_domain_name		Точное имя, запрошенное из поля имени домена TLS hello sni-enabled клиента. Если это совпадение, родительский vs перенаправит соединение на этот дочерний vs.
vh_parent_vs_uuid		Указывает виртуальную службу, действующую как родитель виртуального хостинга (sni).
vip (добавлено в 2.4)		Список IP-адресов виртуальной службы. При создании «совместной виртуальной службы» используйте vsvip_ref для указания на общие сущности. Поле введено в 17.1.1.
vrf_context_ref		Виртуальный контекст маршрутизации, к которому привязана виртуальная служба. Это используется для изоляции набора сетей, к которым подключено приложение. Это ссылка на объект типа vrfcontext.
vs_datascripts		Сценарии обработки данных, применяемые к трафику данных виртуальной службы.
vsvip_ref (добавлено в 2.4)		В основном используется при создании совместной виртуальной службы, это поле относится к сущностям, которые можно использовать совместно между виртуальными службами. Это ссылка на объект типа vsvip. Поле введено в 17.1.1.
waf_policy_ref (добавлено в 2.5)		Политика WAF для виртуальной службы. Это ссылка на объект типа wafpolicy. Поле введено в 17.2.1.
вес		Вес качества обслуживания, назначаемый трафику, передаваемому из этой виртуальной службы. Более высокий вес даст приоритет трафику по сравнению с другими виртуальными службами, использующими одни и те же движки служб. Допустимые значения: 1-128. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Create SSL Virtual Service using Pool testpool2
  avi_virtualservice:
    controller: 10.10.27.90
    username: admin
    password: AviNetworks123!
    name: newtestvs
    state: present
    performance_limits:
    max_concurrent_connections: 1000
    services:
        - port: 443
          enable_ssl: true
        - port: 80
    ssl_profile_ref: '/api/sslprofile?name=System-Standard'
    application_profile_ref: '/api/applicationprofile?name=System-Secure-HTTP'
    ssl_key_and_certificate_refs:
        - '/api/sslkeyandcertificate?name=System-Default-Cert'
    ip_address:
    addr: 10.90.131.103
    type: V4
    pool_ref: '/api/pool?name=testpool2'

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
obj dict	успех, изменения	Объект VirtualService (api/virtualservice)

Статус

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

Автор

Гaurav Rastogi (grastogi@avinetworks.com)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/avi_virtualservice_module.html