community.network.avi_pool – Модуль для настройки объекта Pool Avi RESTful
Примечание
Этот плагин является частью коллекции community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в плейбуке укажите: community.network.avi_pool.
Обзор
- Этот модуль используется для конфигурации объекта Pool
- Дополнительные примеры на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| a_pool строка | Имя контейнерного облачного приложения, которое образует пул в конфигурации a-b пулов, если отличается от vs-приложения. Поле устарело в версии 18.1.2. | ||
| ab_pool строка | Конфигурация A/B пула. Поле устарело в версии 18.1.2. | ||
| ab_priority строка | Приоритет данного пула в паре a-b пулов. Внутреннее использование. Поле устарело в версии 18.1.2. | ||
| analytics_policy строка | Определяет настройки аналитики для пула. Поле добавлено в версии 18.1.5, 18.2.1. | ||
| analytics_profile_ref строка | Указывает настройки, связанные с аналитикой. Это ссылка на объект типа analyticsprofile. Поле добавлено в версиях 18.1.4, 18.2.1. | ||
| api_context словарь | Контекст API Avi, включающий текущий ID сеанса и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | ||
| api_version строка | Значение по умолчанию: "16.4.4" | Версия API Avi, используемая для API Avi и объектов. | |
| apic_epg_name строка | Синхронизирует членов cisco apic epg с серверами пула. | ||
| application_persistence_profile_ref строка | Персистентность обеспечит, что один и тот же пользователь будет привязан к одному и тому же серверу в течение желаемого периода времени. Это ссылка на объект типа applicationpersistenceprofile. | ||
| autoscale_launch_config_ref строка | Если настроено, Avi будет инициировать оркестрацию создания и удаления серверов пула. Поддерживается только для контейнерных облаков, таких как mesos, openshift, kubernetes, docker и т.д. Это ссылка на объект типа autoscalelaunchconfig. | ||
| autoscale_networks строка | Идентификаторы сетей для конфигурации запуска. | ||
| autoscale_policy_ref строка | Ссылка на политику автоматического масштабирования серверов. Это ссылка на объект типа serverautoscalepolicy. | ||
| avi_api_patch_op строка |
| Операция исправления, используемая при использовании avi_api_update_method как patch. | |
| avi_api_update_method строка |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в Avi-контроллер. | ||
| api_version строка | Значение по умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или FQDN контроллера | ||
| csrftoken строка | Маркер csrf контроллера Avi API для повторного использования существующего сеанса с ID сеанса | ||
| password строка | Пароль контроллера Avi | ||
| port строка | Порт контроллера Avi | ||
| session_id строка | ID сеанса API контроллера Avi для повторного использования существующего сеанса с csrftoken | ||
| tenant строка | Значение по умолчанию: "admin" | Домен контроллера Avi | |
| tenant_uuid строка | UUID домена контроллера Avi | ||
| timeout строка | Значение по умолчанию: 300 | Таймаут запроса контроллера Avi | |
| token строка | Токен API контроллера Avi | ||
| username строка | Имя пользователя контроллера Avi | ||
| avi_disable_session_cache_as_fact булево |
| Отключает кеширование информации о сеансе Avi в качестве факта. | |
| capacity_estimation булево |
| Встроенная оценка емкости серверов. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| capacity_estimation_ttfb_thresh строка | Максимальное время до первого байта сервера. Допустимые значения от 1 до 5000. Специальные значения 0 — 'автоматически'. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0. | ||
| cloud_config_cksum строка | Контрольная сумма конфигурации облака для пула. Внутренне устанавливается соединителем облака. | ||
| cloud_ref строка | Это ссылка на объект типа cloud. | ||
| conn_pool_properties строка | Свойства пула подключений. Поле добавлено в версии 18.2.1. | ||
| connection_ramp_duration строка | Продолжительность, в течение которой новые подключения будут постепенно наращиваться до сервера, недавно подключенного к сети. Полезно для алгоритмов балансировки нагрузки, которые наименее зависят от подключений. Допустимые значения от 1 до 300. Специальные значения 0 — 'немедленно'. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 10. | ||
| controller строка | Значение по умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| created_by строка | Имя создателя. | ||
| default_server_port строка | Для трафика, отправляемого на серверы, используется этот порт назначения сервера, если не переопределен в атрибуте порта конкретного сервера. Флаг ssl позволяет Avi использовать шифрование сервера. Допустимые значения от 1 до 65535. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 80. | ||
| delete_server_on_dns_refresh булево |
| Указывает, отключаются ли существующие IP-адреса (false) или удаляются (true) при обновлении имени хоста DNS. При обновлении DNS некоторые IP-адреса, установленные в пуле, могут больше не возвращаться резолвером. Эти IP-адреса удаляются из пула, когда этот ключ установлен в значение true. Они отключаются, если ключ установлен в значение false. Поле добавлено в версии 18.2.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| description строка | Описание пула. | ||
| domain_name строка | Список доменных имен, разделенных запятыми, которые будут использоваться для проверки общих имен или имен альтернативных субъектов, представленных сертификатами серверов. Выполняется только при включенном host_check_enabled для проверки имени хоста. | ||
| east_west булево |
| Наследуемая конфигурация из virtualservice. | |
| enabled булево |
| Включить или отключить пул. Отключение приведет к завершению всех открытых подключений и приостановке мониторов состояния. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| external_autoscale_groups строка | Имена внешних групп автоматического масштабирования для серверов пула. В настоящее время доступно только для aws и azure. Поле добавлено в версии 17.1.2. | ||
| fail_action строка | Включить действие — закрыть подключение, перенаправление HTTP или локальный HTTP-ответ — при возникновении сбоя в пуле. По умолчанию подключение будет закрыто в случае сбоя в пуле. | ||
| fewest_tasks_feedback_delay строка | Периодичность отзывов для алгоритма выбора сервера с наименьшим количеством задач. Допустимые значения от 1 до 300. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 10. | ||
| graceful_disable_timeout string | Используется для плавного отключения сервера. Виртуальная служба ожидает указанное время перед завершением существующих подключений к серверам, которые отключены. Допустимые значения от 1 до 7200. Специальные значения: 0 — «немедленно», -1 — «бесконечно». Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1. | ||
| gslb_sp_enabled boolean |
| Указывает, является ли пул пулом с сохранением состояния сайта. Поле введено в 17.2.1. | |
| health_monitor_refs string | Проверка состояния сервера путём применения одного или нескольких мониторов состояния. Активные мониторы генерируют синтетический трафик с каждого движка службы и помечают сервер как «включен» или «выключен» на основе ответа. Пассивный монитор прослушивает только общение клиент-сервер. Он повышает или понижает соотношение трафика, предназначенного для сервера, на основе успешных ответов. Это ссылка на объект типа healthmonitor. | ||
| host_check_enabled boolean |
| Включить проверку общего имени для сертификата сервера. Если включено и явное доменное имя не указано, Avi будет использовать входящий заголовок хоста для сопоставления. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| inline_health_monitor boolean |
| Пассивный монитор будет отслеживать соединения и запросы клиент-сервер и корректировать нагрузку трафика на серверы на основе успешных ответов. Это может изменить ожидаемое поведение метода lb, например, round robin. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| ipaddrgroup_ref string | Использование списка серверов из группы IP-адресов. Это ссылка на объект типа ipaddrgroup. | ||
| lb_algorithm string | Алгоритм балансировки нагрузки выберет сервер из списка доступных серверов пула. Варианты перечисления — LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH, LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER, LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как LB_ALGORITHM_LEAST_CONNECTIONS. | ||
| lb_algorithm_consistent_hash_hdr string | Имя HTTP-заголовка, используемого для ключа хэша. | ||
| lb_algorithm_core_nonaffinity string | Степень неаффинити для выбора сервера на основе аффинити к ядру. Допустимые значения от 1 до 65535. Поле введено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2. | ||
| lb_algorithm_hash string | Критерии, используемые в качестве ключа для определения хэша между клиентом и сервером. Варианты перечисления — LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT, LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS. | ||
| lookup_server_by_name boolean |
| Разрешить поиск сервера по имени. Поле введено в 17.1.11, 17.2.4. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| max_concurrent_connections_per_server string | Максимальное количество одновременных подключений, разрешенных для каждого сервера в пуле. Примечание: применённое значение будет не меньше количества движков службы, на которых размещен пул. Если установлено в 0, ограничение не применяется. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0. | ||
| max_conn_rate_per_server string | Ограничение скорости подключений к каждому серверу. | ||
| min_health_monitors_up string | Минимальное количество мониторов состояния в состоянии «включено» для обозначения сервера как «включённого». Поле введено в 18.2.1, 17.2.12. | ||
| min_servers_up string | Минимальное количество серверов в состоянии «включено» для обозначения пула как «включённого». Поле введено в 18.2.1, 17.2.12. | ||
| name string / required | Имя пула. | ||
| networks string | (внутреннее использование) сети, обозначенные как содержащие серверы для этого пула. Серверы могут быть дополнительно сужены фильтром. Это поле используется внутри Avi, оно не редактируется пользователем. | ||
| nsx_securitygroup string | Список NSX-групп служб, где создаются серверы для пула. Поле введено в 17.1.1. | ||
| password string | Значение по умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения AVI_PASSWORD. | |
| pki_profile_ref string | Avi проверит присутствующий сертификат SSL сервера по отношению к выбранному профилю pki. Это ссылка на объект типа pkiprofile. | ||
| placement_networks string | Ручное выделение сетей и подсетей, используемых для обеспечения доступности серверов пула. Укажите подсеть с помощью следующего синтаксиса 10-1-1-0/24. Используйте статические маршруты в конфигурации vrf, когда серверы пула не подключены напрямую, но доступны из движка службы. | ||
| prst_hdr_name string | Имя заголовка для сохранения пользовательского заголовка. Поле устарело в 18.1.2. | ||
| request_queue_depth string | Минимальное количество запросов, которые необходимо поставить в очередь, когда пул заполнен. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 128. | ||
| request_queue_enabled boolean |
| Включить очередь запросов, когда пул заполнен. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| rewrite_host_header_to_server_name boolean |
| Переписать входящий заголовок хоста на имя сервера, на который перенаправляется запрос. Включение этой функции переписывает заголовок хоста для запросов ко всем серверам в пуле. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| rewrite_host_header_to_sni boolean |
| Если указано имя сервера sni, переписать входящий заголовок хоста на имя сервера sni. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| server_auto_scale boolean |
| Автомасштабирование серверов. Больше не используется. Поле устарело в 18.1.2. | |
| server_count string | Поле устарело в 18.2.1. | ||
| server_name string | Полное доменное имя DNS, которое будет использоваться в расширении TLS sni в соединениях сервера, если sni включен. Если значение не указано, Avi будет использовать входящий заголовок хоста вместо него. | ||
| server_reselect string | Конфигурация повторного выбора сервера для HTTP-запросов. | ||
| server_timeout string | Значение таймаута сервера указывает время, в течение которого необходимо установить соединение с сервером и завершить обмен запросом-ответом между Avi и сервером. Значение 0 приводит к использованию таймаута по умолчанию в 60 минут. Допустимые значения от 0 до 3600000. Поле введено в 18.1.5, 18.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0. | ||
| servers string | Пул направляет сбалансированный по нагрузке трафик на этот список целевых серверов. Серверы можно настроить по IP-адресу, имени, сети или с помощью группы IP-адресов. | ||
| service_metadata string | Метаданные, относящиеся к услуге, предоставляемой этим пулом. В средах Openshift/Kubernetes хранится информация о метаданных приложения. Любой пользовательский ввод в это поле будет перезаписан Avi vantage. Поле введено в 17.2.14, 18.1.5, 18.2.1. | ||
| sni_enabled boolean |
| Включить TLS sni для соединений сервера. Если отключено, Avi не будет отправлять расширение sni в рамках процесса рукопожатия. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| ssl_key_and_certificate_ref строка | Сервисные движки представят серверу клиентский сертификат ssl. Это ссылка на объект типа sslkeyandcertificate. | ||
| ssl_profile_ref строка | При включенном режиме avi повторно шифрует трафик для серверов бэкэнда. Конкретный профиль ssl определяет, какие шифры и версии ssl будут поддерживаться. Это ссылка на объект типа sslprofile. | ||
| state строка |
| Состояние, которое должно быть применено к сущности. | |
| tenant строка | Значение по умолчанию: "admin" | Имя клиента, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref строка | Это ссылка на объект типа клиент. | ||
| tenant_uuid строка | Значение по умолчанию: "" | UUID клиента, используемого для всех вызовов API Avi и контекста объекта. | |
| url строка | URL контроллера Avi для объекта. | ||
| use_service_port булево |
| Не переводить порт назначения клиента при отправке соединения на сервер. Порт сервиса, указанный в пуле или серверах, по-прежнему будет использоваться для мониторинга состояния. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| username строка | Значение по умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | |
| uuid строка | Uuid пула. | ||
| vrf_ref строка | Виртуальный контекст маршрутизации, к которому привязан пул. Это используется для обеспечения изоляции набора сетей, к которым подключен пул. Пул наследует виртуальный контекст маршрутизации виртуальной службы, и это поле используется только внутри и устанавливается pb-transform. Это ссылка на объект типа vrfcontext. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Create a Pool with two servers and HTTP monitor
community.network.avi_pool:
controller: 10.10.1.20
username: avi_user
password: avi_password
name: testpool1
description: testpool1
state: present
health_monitor_refs:
- '/api/healthmonitor?name=System-HTTP'
servers:
- ip:
addr: 10.10.2.20
type: V4
- ip:
addr: 10.10.2.21
type: V4
- name: Patch pool with a single server using patch op and avi_credentials
community.network.avi_pool:
avi_api_update_method: patch
avi_api_patch_op: delete
avi_credentials: "{{avi_credentials}}"
name: test-pool
servers:
- ip:
addr: 10.90.64.13
type: 'V4'
register: pool
when:
- state | default("present") == "present"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj словарь | успех, изменилось | Объект пула (api/pool) |
Авторы
- 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.10/collections/community/network/avi_pool_module.html
