avi_pool - Модуль для настройки объекта Pool Avi RESTful
Новое в версии 2.3.
Обзор
- Этот модуль используется для настройки объекта Pool
- больше примеров на https://github.com/avinetworks/devops
Требования (к хосту, на котором выполняется модуль)
- avisdk
Параметры
| параметр | обязательно | значение по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| a_pool | нет | Имя контейнерного облачного приложения, которое составляет пул в конфигурации пула a-b, если отличается от vs-приложения. | ||
| ab_pool | нет | Конфигурация пула A/B. | ||
| ab_priority | нет | Приоритет данного пула в паре пулов a-b. Внутреннее использование. | ||
| api_version | нет | Версия API Avi для использования с API Avi и объектами. | ||
| apic_epg_name | нет | Синхронизация членов epg cisco apic с серверами пула. | ||
| application_persistence_profile_ref | нет | Персистентность гарантирует, что один и тот же пользователь остается на одном и том же сервере в течение заданного периода времени. Это ссылка на объект типа applicationpersistenceprofile. | ||
| autoscale_launch_config_ref | нет | При конфигурации Avi запускает оркестрацию создания и удаления серверов пула. Поддерживается только для контейнерных облаков, таких как mesos, opensift, kubernates, docker и т. д. Это ссылка на объект типа autoscalelaunchconfig. | ||
| autoscale_networks | нет | Идентификаторы сетей для конфигурации запуска. | ||
| autoscale_policy_ref | нет | Ссылка на политику автоматического масштабирования серверов. Это ссылка на объект типа serverautoscalepolicy. | ||
| capacity_estimation | нет | Встроенная оценка емкости серверов. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| capacity_estimation_ttfb_thresh | нет | Максимальное время от начала до первого байта сервера. Допустимые значения: 1-5000. Особые значения: 0 — «автоматически». Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0. | ||
| cloud_config_cksum | нет | Контрольная сумма конфигурации облака для пула. Внутренне устанавливается соединителем облака. | ||
| cloud_ref | нет | Это ссылка на объект типа cloud. | ||
| 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. | ||
| description | нет | Описание пула. | ||
| domain_name | нет | Список доменов, разделенных запятыми, которые будут использоваться для проверки общих имен или альтернативных имен субъектов, представленных сертификатами сервера. Выполняется только при включенном host_check_enabled для проверки имени хоста. | ||
| east_west | нет | Наследуемая конфигурация с виртуальной службы. | ||
| enabled | нет | Включить или выключить пул. Отключение приведет к завершению всех открытых соединений и приостановке мониторов работоспособности. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | ||
| external_autoscale_groups | нет | Имена внешних групп автоматического масштабирования для серверов пула. В настоящее время доступно только для AWS. Поле введено в 17.1.2. | ||
| fail_action | нет | Включить действие — закрыть соединение, перенаправить http или локальный http ответ — при сбое пула. По умолчанию соединение закрывается, если пул испытывает сбой. | ||
| fewest_tasks_feedback_delay | нет | Периодичность отзывов для алгоритма выбора сервера с наименьшим количеством задач. Допустимые значения: 1-300. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 10. | ||
| graceful_disable_timeout | нет | Используется для плавного отключения сервера. Виртуальная служба ожидает указанное время перед завершением существующих соединений с серверами, которые отключены. Допустимые значения: 1-60. Особые значения: 0 — «немедленно», -1 — «бесконечно». Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1. | ||
| health_monitor_refs | нет | Проверка работоспособности сервера путем применения одного или нескольких мониторов работоспособности. Активные мониторы генерируют синтетический трафик с каждого движка службы и отмечают сервер как рабочий или нерабочий на основе ответа. Пассивный монитор прослушивает только клиентско-серверное общение. Он увеличивает или уменьшает соотношение трафика, направленного на сервер, на основе успешных ответов. Это ссылка на объект типа healthmonitor. | ||
| host_check_enabled | нет | Включить проверку общего имени для сертификата сервера. Если включено и не указано явное имя домена, Avi будет использовать входящий заголовок хоста для сопоставления. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| inline_health_monitor | нет | Пассивный монитор будет отслеживать соединения и запросы «клиент-сервер» и корректировать нагрузку трафика на серверы на основе успешных ответов. Это может изменить ожидаемое поведение метода балансировки нагрузки, например, round robin. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | ||
| ipaddrgroup_ref | нет | Использование списка серверов из группы IP-адресов. Это ссылка на объект типа ipaddrgroup. | ||
| lb_algorithm | нет | Алгоритм сбалансирования нагрузки выберет сервер в списке доступных серверов пула. Варианты перечисления — 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. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как LB_ALGORITHM_LEAST_CONNECTIONS. | ||
| lb_algorithm_consistent_hash_hdr | нет | Имя заголовка HTTP, используемого для ключа хеширования. | ||
| lb_algorithm_core_nonaffinity (добавлен в 2.4)
| нет | Степень неаффинности для выбора сервера на основе аффинности ядра. Допустимые значения: 1-65535. Поле введено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2. | ||
| lb_algorithm_hash | нет | Критерии, используемые в качестве ключа для определения хеша между клиентом и сервером. Варианты перечисления — 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. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS. | ||
| max_concurrent_connections_per_server | нет | Максимальное количество одновременных подключений к каждому серверу в пуле. Примечание: примененное значение не будет меньше количества движков службы, на которых размещен пул. Если установлено в 0, ограничение не применяется. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0. | ||
| max_conn_rate_per_server | нет | Ограничение скорости подключений к каждому серверу. | ||
| name | да | Имя пула. | ||
| networks | нет | (для внутреннего использования) сети, указанные как содержащие серверы для данного пула. Серверы могут быть далее сужены фильтром. Это поле используется внутренне Avi, его нельзя редактировать пользователем. | ||
| nsx_securitygroup | нет | Список групп безопасности nsx, где создаются серверы для пула. Поле введено в 17.1.1. | ||
| password | нет | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | ||
| pki_profile_ref | нет | Avi проверит сертификат SSL, представленный сервером, по отношению к выбранному профилю pki. Это ссылка на объект типа pkiprofile. | ||
| placement_networks | нет | Ручной выбор сетей и подсетей, используемых для обеспечения доступности серверов пула. Укажите подсеть, используя следующий синтаксис 10-1-1-0/24. Используйте статические маршруты в конфигурации vrf, когда серверы пула не подключены напрямую, но доступны из движка службы. | ||
| prst_hdr_name | нет | Имя заголовка для персистентности пользовательских заголовков. |
| request_queue_depth | нет | Минимальное количество запросов для очереди при полной загрузке пула. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 128. | ||
| request_queue_enabled | нет | Включить очередь запросов при полной загрузке пула. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| rewrite_host_header_to_server_name | нет | Перезаписать заголовок хоста в имя сервера, на который будет проксирован запрос. Включение этой функции перезаписывает заголовок хоста для всех серверов в пуле. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| rewrite_host_header_to_sni | нет | Если указано имя сервера sni, перезаписать заголовок хоста на имя сервера sni. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| server_auto_scale | нет | Автомасштабирование серверов. Больше не используется. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| server_count | нет | Количество серверов. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0. | ||
| server_name | нет | Полное доменное имя (FQDN), которое будет использоваться в расширении TLS sni в соединениях с сервером, если sni включён. Если значение не указано, Avi будет использовать заголовок хоста из входящего запроса. | ||
| server_reselect | нет | Настройка перевыбора серверов для HTTP-запросов. | ||
| servers | нет | Пул направляет сбалансированный по нагрузке трафик на этот список целевых серверов. Серверы могут быть настроены по IP-адресу, имени, сети или через группу IP-адресов. | ||
| sni_enabled | нет | Включить 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. | ||
| 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. |
Примеры
- name: Create a Pool with two servers and HTTP monitor
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 | описание | возвращаемое | тип | пример |
|---|---|---|---|---|
| obj | Объект пула (api/pool) | успех, изменено | dict |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Для помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь с Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/avi_pool_module.html
