avi_virtualservice – Модуль для настройки VirtualService Avi RESTful Объекта
Новая версия 2.3.
Обзор
- Этот модуль используется для настройки объекта VirtualService
- Дополнительные примеры по адресу 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 boolean |
| Автоматическое выделение плавающего/эластичного IP-адреса из инфраструктуры облака. Поле устарело в версии 17.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. |
| auto_allocate_ip boolean |
| Автоматическое выделение VIP из указанной подсети. Поле устарело в версии 17.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. |
| availability_zone - | Зона доступности для размещения виртуальной службы. Поле устарело в версии 17.1.1. | |
| avi_allocated_fip boolean |
| (для внутреннего использования) fip, выделенный avi в инфраструктуре облака. Поле устарело в версии 17.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. |
| avi_allocated_vip boolean |
| (для внутреннего использования) vip, выделенный avi в инфраструктуре облака. Поле устарело в версии 17.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. |
| avi_api_patch_op - добавлено в 2.5 |
| Операция обновления для использования при использовании avi_api_update_method как patch. |
| avi_api_update_method - добавлено в 2.5 |
| Метод по умолчанию для обновления объекта - HTTP PUT. Установка на patch переопределит это поведение на использование HTTP PATCH. |
| avi_credentials - добавлено в 2.5 | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | |
| bulk_sync_kvcache boolean добавлено в 2.6 |
| (эта функция находится в стадии бета-тестирования). Синхронизация кэша key-value с новой сессией при масштабировании vs. Например, сессии ssl хранятся с помощью кэша key-value vs. При масштабировании vs информация о сессии ssl синхронизируется с новым се, что позволяет повторно использовать существующие сессии ssl на новом се. Поле введено в 17.2.7, 18.1.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. |
| client_auth - | Конфигурация аутентификации HTTP для защищенных ресурсов. | |
| close_client_conn_on_config_update boolean добавлено в 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 boolean |
| Выберите алгоритм для справедливости качества обслуживания. Это определяет, как несколько виртуальных служб, использующих одни и те же движки обслуживания, будут приоритезировать трафик по перегруженной сети. Значение по умолчанию, если оно не указано в 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 - 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 |
| Ограничить потенциальных атакующих 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 - / 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 - | 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 - added in 2.4 | Метаданные, относящиеся к сервису, предоставляемому этой виртуальной службой. В средах openshift/kubernetes хранится информация о подсети egress. Любой пользовательский ввод в это поле будет перезаписан Avi vantage. | |
| service_pool_select - | Выбор пула на основе порта назначения. | |
| services - | Список сервисов, определенных для этой виртуальной службы. | |
| sideband_profile - added in 2.4 | Настройки sideband, которые будут использоваться для этой виртуальной службы. Их можно использовать для отправки трафика в sideband виртуальные IP-адреса для внешней инспекции и т.д. | |
| snat_ip - | Виртуальный IP-адрес источника для подключений к серверам. | |
| sp_pool_refs - added in 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 - | Default: "admin" | Имя клиента, используемое для всех вызовов API Avi и контекста объекта. |
| tenant_ref - | Это ссылка на объект типа клиент. | |
| tenant_uuid - | Default: "" | UUID клиента, используемого для всех вызовов API Avi и контекста объекта. |
| traffic_clone_profile_ref - added in 2.4 | Сеть сервера или список серверов для клонирования трафика. Это ссылка на объект типа trafficcloneprofile. Поле введено в 17.1.1. | |
| traffic_enabled boolean added in 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 added in 2.5 |
| Использовать виртуальный IP-адрес в качестве IP-адреса SNAT для мониторинга работоспособности и отправки трафика на серверы-обработчики вместо IP-адреса интерфейса движка сервиса. Ограничение при включении этого параметра заключается в том, что виртуальную службу нельзя настроить в режиме активной-активной высокой доступности. Для высокой доступности и бесперебойных обновлений необходимо использовать многоадресное решение на основе DNS. Поле введено в 17.1.9, 17.2.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| username - | Default: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию - переменная среды AVI_USERNAME. |
| uuid - | Uuid виртуальной службы. | |
| vh_domain_name - | Точное имя, запрошенное из поля имени домена tls hello клиента с поддержкой sni. Если это совпадение, родительская vs перенаправит соединение на эту дочернюю vs. | |
| vh_parent_vs_uuid - | Указывает виртуальную службу, действующую как родительская виртуальная служба виртуального хостинга (sni). | |
| vip - added in 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. | |
| 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 словарь | успех, изменения | Объект VirtualService (api/virtualservice) |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Gaurav 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.7/modules/avi_virtualservice_module.html
