avi_virtualservice – Модуль для настройки VirtualService Avi RESTful Объекта
Новая версия 2.3.
Обзор
- Этот модуль используется для настройки объекта VirtualService
- Дополнительные примеры по адресу https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| active_standby_se_tag - | Эта настройка применяется только в том случае, если виртуальная служба находится в режиме резервного копирования активной службы и включено распределение нагрузки между активной и резервной службой. Это поле используется для маркировки виртуальной службы, чтобы виртуальные службы с одинаковой меткой использовали один и тот же активный двигатель обслуживания. Виртуальные службы с разными метками будут иметь разные активные двигатели обслуживания. Если один из двигателей обслуживания в группе двигателей обслуживания выходит из строя, все виртуальные службы будут использовать один и тот же активный двигатель обслуживания. Перераспределение виртуальных служб может быть ручным или автоматическим при восстановлении вышедшего из строя двигателя обслуживания. Перераспределение основано на свойстве автоматического перераспределения группы двигателей обслуживания. Варианты перечисления - 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 для использования с API Avi и объектами. |
| application_profile_ref - | Включить функции, специфичные для уровня приложения, для виртуальной службы. Это ссылка на объект типа applicationprofile. | |
| auto_allocate_floating_ip булево |
| Автоматическое выделение плавающего/упругого IP-адреса из облачной инфраструктуры. Поле устарело в 17.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. |
| auto_allocate_ip булево |
| Автоматическое выделение VIP из предоставленной подсети. Поле устарело в 17.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. |
| availability_zone - | Зона доступности для размещения виртуальной службы. Поле устарело в 17.1.1. | |
| avi_allocated_fip булево |
| (для внутреннего использования) IP-адрес, выделенный Avi в облачной инфраструктуре. Поле устарело в 17.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. |
| avi_allocated_vip булево |
| (для внутреннего использования) VIP, выделенный Avi в облачной инфраструктуре. Поле устарело в 17.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. |
| avi_api_patch_op - добавлено в 2.5 |
| Операция исправления для использования при использовании avi_api_update_method в качестве исправления. |
| avi_api_update_method - добавлено в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в «patch» переопределит это поведение для использования HTTP PATCH. |
| avi_credentials словарь добавлено в 2.5 | Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в контроллер Avi. | |
| bulk_sync_kvcache булево добавлено в 2.6 |
| (эта функция находится в стадии бета-тестирования). Синхронизация кэша значений ключей с новой сессией при масштабировании VS. Например, сессии SSL хранятся с помощью кэша значений ключей VS. Когда VS масштабируется, информация о сессиях SSL синхронизируется с новым SE, что позволяет повторно использовать существующие сессии SSL на новом SE. Поле введено в 17.2.7, 18.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. |
| client_auth - | Настройка аутентификации HTTP для защищенных ресурсов. | |
| close_client_conn_on_config_update булево добавлено в 2.5 |
| Закрыть подключение клиента при обновлении конфигурации 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 булево |
| Выберите алгоритм для обеспечения справедливости QoS. Это определяет, как несколько виртуальных служб, использующих одни и те же двигатели обслуживания, будут приоритезировать трафик по перегруженному сетевому каналу. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. |
| description - | Пользовательское описание объекта. | |
| discovered_network_ref - | (для внутреннего использования) обнаруженные сети, обеспечивающие доступность для IP-адреса виртуальной службы, обращенного к клиенту. Это поле устарело. Это ссылка на объект типа сеть. Поле устарело в 17.1.1. | |
| discovered_networks - | (для внутреннего использования) обнаруженные сети, обеспечивающие доступность для IP-адреса виртуальной службы, обращенного к клиенту. Это поле используется внутренне Avi, его нельзя редактировать пользователем. Поле устарело в 17.1.1. | |
| discovered_subnet - | (для внутреннего использования) обнаруженные подсети, обеспечивающие доступность для IP-адреса виртуальной службы, обращенного к клиенту. Это поле устарело. Поле устарело в 17.1.1. | |
| dns_info - | Данные, специфичные для обнаружения служб, включая полное доменное имя, тип и время жизни записи DNS. Обратите внимание, что разрешено только одно из значений fqdn и dns_info. |
| dns_policies - added in 2.4 | DNS-политики, применяемые к DNS-трафику виртуальной службы. Поле введено в 17.1.1. | |
| east_west_placement boolean |
| Принудительное размещение на всех серверах в группе служб (только режим mesos). Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| enable_autogw boolean |
| Трафик ответа клиентам будет отправлен обратно по исходному MAC-адресу подключения, а не статически отправлен на шлюз по умолчанию. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. |
| enable_rhi boolean |
| Включить инъекцию состояния маршрута с использованием конфигурации BGP в контексте VRF. |
| enable_rhi_snat boolean |
| Включить инъекцию состояния маршрута для адресов плавающего IP, снабженных исходным NAT, с использованием конфигурации BGP в контексте VRF. |
| enabled boolean |
| Включить или отключить виртуальную службу. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. |
| error_page_profile_ref - added in 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 boolean |
| Игнорировать ограничения сетевой доступности серверов пула для размещения виртуальной службы. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| ip_address - | IP-адрес виртуальной службы. Поле устарело в 17.1.1. | |
| ipam_network_subnet - | Подсеть и/или сеть для выделения IP-адреса виртуальной службы модулем поставщика IPAM. Поле устарело в 17.1.1. | |
| l4_policies - added in 2.6 | L4-политики, применяемые к трафику данных виртуальной службы. Поле введено в 17.2.7. | |
| limit_doser boolean |
| Ограничить потенциальных атакующих DDoS, которые значительно превышают 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 - / required | Имя виртуальной службы. | |
| network_profile_ref - | Определяет сетевые настройки, такие как протокол (TCP или UDP), и связанные параметры для протокола. Это ссылка на объект типа networkprofile. | |
| network_ref - | Вручную переопределить сеть, в которой размещена виртуальная служба. Это ссылка на объект типа network. Поле устарело в 17.1.1. | |
| network_security_policy_ref - | Политики сетевой безопасности для виртуальной службы. Это ссылка на объект типа networksecuritypolicy. | |
| nsx_securitygroup - added in 2.4 | Список NSX-групп служб, представляющих клиентов, которые могут получить доступ к виртуальному IP-адресу виртуальной службы. Поле введено в 17.1.1. | |
| password string | Default: "" | Пароль пользователя 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 boolean |
| Удалить порт прослушивания, если виртуальная служба выведена из строя. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| requests_rate_limit - | Ограничить скорость входящих запросов для этой виртуальной службы. |
| scaleout_ecmp boolean |
| Отключить перераспределение потоков по службам для виртуальной службы. Включить, если сеть сама выполняет хэширование потоков с ecmp в средах, таких как gcp. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| se_group_ref - | Группа серверных узлов для этой виртуальной службы. Переход в новую группу серверных узлов нарушит существующие подключения к этой виртуальной службе. Это ссылка на объект типа serviceenginegroup. | |
| server_network_profile_ref - | Определяет профиль настроек сети для серверной стороны подключений с TCP проксированием. Оставьте пустым, чтобы использовать те же настройки, что и для клиентской стороны подключения к виртуальной службе. Это ссылка на объект типа networkprofile. | |
| service_metadata - добавлен в 2.4 | Метаданные, относящиеся к услуге, предоставляемой этой виртуальной службой. В средах openshift/kubernetes сохраняется информация о контейнерах egress. Любой ввод пользователя в это поле будет перезаписан системой Avi vantage. | |
| service_pool_select - | Выбрать пул на основе порта назначения. | |
| services - | Список служб, определенных для этой виртуальной службы. | |
| sideband_profile - добавлен в 2.4 | Настройка канала передачи данных для использования этой виртуальной службой. Может использоваться для отправки трафика на VIP канала передачи данных для внешней проверки и т. д. | |
| snat_ip - | Виртуальный IP-адрес(ы) источника для подключения к серверам. | |
| sp_pool_refs - добавлен в 2.5 | Используемые пулы GSLB для управления функциональностью сохранения сайта. Каждый пул сохранения сайта содержит виртуальные службы во всех других сайтах, которые автоматически генерируются менеджером GSLB. Это поле только для чтения для пользователя. Это ссылка на объект типа пул. Поле введено в 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 - |
| Состояние, которое должно быть применено к объекту. |
| 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_uuid строка | По умолчанию: "" | UUID клиента, используемого для всех вызовов API Avi и контекста объекта. |
| traffic_clone_profile_ref - добавлен в 2.4 | Сеть серверов или список серверов для клонирования трафика. Это ссылка на объект типа trafficcloneprofile. Поле введено в 17.1.1. | |
| traffic_enabled boolean добавлен в 2.6 |
| Переключатель для включения трафика виртуальной службы на назначенных серверных узлах. Эта настройка эффективна только при установленном флаге enabled в true. Поле введено в 17.2.8. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. |
| 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 boolean |
| Использовать IP-адрес моста в качестве VIP на каждом узле в развертываниях mesos. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| use_vip_as_snat boolean добавлен в 2.5 |
| Использовать виртуальный IP-адрес в качестве IP-адреса SNAT для мониторинга состояния и отправки трафика на серверы бэкэнда вместо IP-адреса интерфейса серверного узла. Ограничение включения этого параметра заключается в том, что виртуальная служба не может быть настроена в режиме активной-активной HA. Необходимо использовать многоадресное решение на основе DNS для HA и бесперебойных обновлений. Поле введено в 17.1.9, 17.2.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| username строка | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. |
| uuid - | UUID виртуальной службы. | |
| vh_domain_name - | Точное имя, запрошенное из поля имени домена TLS hello с поддержкой SNI клиента. Если это совпадение, родительская виртуальная служба перенаправит подключение на эту дочернюю виртуальную службу. | |
| vh_parent_vs_uuid - | Указывает виртуальную службу, действующую как родительская виртуальная служба виртуального хостинга (SNI). | |
| vip - добавлен в 2.4 | Список IP-адресов виртуальной службы. При создании общей виртуальной службы используйте vsvip_ref для указания на общие объекты. Поле введено в 17.1.1. | |
| vrf_context_ref - | Виртуальный контекст маршрутизации, к которому привязана виртуальная служба. Это используется для изоляции набора сетей, к которым подключено приложение. Это ссылка на объект типа vrfcontext. | |
| vs_datascripts - | Сценарии данных, применяемые к трафику данных виртуальной службы. |
| vsvip_ref - added in 2.4 | В основном используется при создании общих виртуальных сервисов (vs), это поле относится к сущностям, которые могут быть совместно использованы между виртуальными сервисами. Это ссылка на объект типа vsvip. Поле добавлено в 17.1.1. | |
| waf_policy_ref - added in 2.5 | Политика WAF для виртуального сервиса. Это ссылка на объект типа wafpolicy. Поле добавлено в 17.2.1. | |
| weight - | Вес качества обслуживания для назначения трафика, передаваемого от этого виртуального сервиса. Более высокий вес будет приоритезировать трафик по сравнению с другими виртуальными сервисами, использующими те же движки сервиса. Допустимые значения — от 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 словарь | success, changed | Объект VirtualService (api/virtualservice) |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Gaurav Rastogi (@grastogi23) <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.8/modules/avi_virtualservice_module.html
