avi_pool – Модуль для настройки объекта Pool Avi RESTful
Описание
- Этот модуль используется для настройки объекта Pool
- больше примеров по адресу https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| a_pool - | Имя контейнерного облачного приложения, которое составляет пул в конфигурации пула a-b, если отличается от vs app. Поле устарело в версии 18.1.2. | ||
| ab_pool - | Конфигурация пула A/B. Поле устарело в версии 18.1.2. | ||
| ab_priority - | Приоритет этого пула в паре пулов a-b. Внутреннее использование. Поле устарело в версии 18.1.2. | ||
| analytics_policy - добавлен в 2.9 | Определяет параметры аналитики для пула. Поле введено в версии 18.1.5, 18.2.1. | ||
| analytics_profile_ref - добавлен в 2.9 | Указывает настройки, связанные с аналитикой. Это ссылка на объект типа analyticsprofile. Поле введено в версиях 18.1.4, 18.2.1. | ||
| api_context словарь добавлен в 2.5 | Контекст API Avi, включающий текущий идентификатор сеанса и маркер 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 - добавлен в 2.5 |
| Операция обновления для использования при использовании avi_api_update_method как patch. | |
| avi_api_update_method - добавлен в 2.5 |
| Метод обновления объекта по умолчанию — HTTP PUT. Установив значение patch, можно изменить это поведение на использование HTTP PATCH. | |
| avi_credentials словарь добавлен в 2.5 | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version - | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или FQDN контроллера. | ||
| csrftoken - | Маркер CSRF API контроллера Avi для повторного использования существующего сеанса с идентификатором сеанса. | ||
| password - | Пароль контроллера Avi. | ||
| port - | Порт контроллера Avi. | ||
| session_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 логическое добавлен в 2.6 |
| Отключает кэширование информации о сеансе 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 - добавлен в 2.9 | Свойства пула подключений. Поле введено в версии 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. | ||
| удаление_сервера_при_обновлении_dns boolean добавлен в 2.9 |
| Указывает, будут ли существующие IP-адреса отключаться (false) или удаляться (true) при обновлении имени хоста DNS. При обновлении DNS некоторые IP-адреса, заданные в пуле, могут больше не возвращаться решателем. Эти IP-адреса удаляются из пула, когда этот ключ установлен в значение true. Они отключаются, если ключ установлен в значение false. Поле введено в 18.2.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| описание - | Описание пула. | ||
| имя_домена - | Список доменных имен, разделенных запятыми, которые будут использоваться для проверки общих имен или альтернативных имен, представленных сертификатами серверов. Это выполняется только при включенном режиме проверки имени хоста host_check_enabled. | ||
| восток_запад boolean |
| Наследуемая конфигурация с виртуальной службы. | |
| включен boolean |
| Включить или отключить пул. Отключение приведет к завершению всех открытых соединений и приостановке мониторинга работоспособности. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| внешние_группы_автомасштабирования - | Названия внешних групп автомасштабирования для серверов пула. В настоящее время доступно только для aws и azure. Поле введено в 17.1.2. | ||
| действие_при_ошибке - | Включить действие — закрыть соединение, перенаправление http или локальный http-ответ — при возникновении сбоя в пуле. По умолчанию соединение закрывается в случае сбоя в пуле. | ||
| задержка_обратной_связи_для_выбора_сервера_с_наименьшим_количеством_задач - | Периодичность обратной связи для алгоритма выбора сервера с наименьшим количеством задач. Допустимые значения — от 1 до 300. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 10. | ||
| тайм-аут_плавного_отключения - | Используется для плавного отключения сервера. Виртуальная служба ожидает указанное время перед завершением существующих соединений с серверами, которые отключаются. Допустимые значения — от 1 до 7200. Специальные значения: 0 — «немедленно», -1 — «бесконечно». Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1. | ||
| gslb_sp_включен boolean добавлен в 2.5 |
| Указывает, является ли пул пулом с сохранением состояния сайта. Поле введено в 17.2.1. | |
| ссылки_на_мониторы_состояния - | Проверка работоспособности сервера путем применения одного или нескольких мониторов работоспособности. Активные мониторы генерируют синтетический трафик с каждого сервисного узла и отмечают сервер как рабочий или нерабочий на основе ответа. Пассивный монитор отслеживает только взаимодействие клиент-сервер. Он увеличивает или уменьшает соотношение трафика, направленного на сервер, в зависимости от успешных ответов. Это ссылка на объект типа healthmonitor. | ||
| проверка_хоста_включена boolean |
| Включить проверку общего имени для сертификата сервера. Если включено и явно не указано доменное имя, avi будет использовать входящий заголовок хоста для сопоставления. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| мониторинг_в_строке boolean |
| Пассивный монитор будет отслеживать соединения и запросы клиент-сервер и корректировать нагрузку на серверы в зависимости от успешных ответов. Это может изменить ожидаемое поведение метода lb, такого как круговая очередь. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| ссылка_на_группу_ip_адресов - | Использовать список серверов из группы IP-адресов. Это ссылка на объект типа ipaddrgroup. | ||
| алгоритм_lb - | Алгоритм балансировки нагрузки выберет сервер из списка доступных серверов пула. Варианты перечисления — 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_последовательный_хеш_hdr - | Имя HTTP-заголовка, используемого для ключа хеширования. | ||
| алгоритм_lb_ядер_не_аффинити - добавлен в 2.4 | Степень отсутствия аффинити для выбора серверов на основе аффинити к ядру. Допустимые значения — от 1 до 65535. Поле введено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2. | ||
| алгоритм_lb_хеш - | Критерии, используемые в качестве ключа для определения хеша между клиентом и сервером. Варианты перечисления — 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. | ||
| поиск_сервера_по_имени boolean добавлен в 2.5 |
| Разрешить поиск сервера по имени. Поле введено в 17.1.11, 17.2.4. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| макс_одновременных_соединений_на_сервер - | Максимальное количество одновременных соединений, разрешенных для каждого сервера в пуле. Примечание: примененное значение не будет меньше количества сервисных узлов, на которых размещен пул. Если значение установлено в 0, ограничение не применяется. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0. | ||
| макс_скорость_соединений_на_сервер - | Ограничение скорости подключения к каждому серверу. | ||
| мин_активных_мониторов_состояния - добавлен в 2.9 | Минимальное количество мониторов состояния в активном состоянии для обозначения сервера как активного. Поле введено в 18.2.1, 17.2.12. | ||
| мин_активных_серверов - добавлен в 2.9 | Минимальное количество активных серверов для обозначения пула как активного. Поле введено в 18.2.1, 17.2.12. | ||
| название - / обязательно | Название пула. | ||
| сети - | (для внутреннего использования) сети, указанные как содержащие серверы для этого пула. Серверы могут быть дополнительно сужены с помощью фильтра. Это поле используется внутри avi и не редактируется пользователем. | ||
| nsx_группа_безопасности - | Список nsx-групп сервисов, где создаются серверы для пула. Поле введено в 17.1.1. | ||
| пароль строка | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | |
| ссылка_на_профиль_pki - | Avi проверит сертификат ssl, представленный сервером, по выбранному профилю pki. Это ссылка на объект типа pkiprofile. | ||
| placement_networks - | Вручную выберите сети и подсети, используемые для обеспечения доступности серверов пула. Укажите подсеть, используя следующий синтаксис 10-1-1-0/24. Используйте статические маршруты в конфигурации vrf, когда серверы пула не подключены напрямую, а доступны из движка сервиса. | ||
| prst_hdr_name - | Имя заголовка для сохранения пользовательского заголовка. Поле устарело в версии 18.1.2. | ||
| request_queue_depth - | Минимальное количество запросов, которые необходимо поместить в очередь, когда пул заполнен. Значение по умолчанию, если не указано в 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 - | Поле устарело в версии 18.2.1. | ||
| server_name - | Полное доменное имя DNS, которое будет использоваться в расширении tls sni в соединениях с сервером, если включен sni. Если значение не указано, avi будет использовать входящий заголовок хоста. | ||
| server_reselect - | Конфигурация перевыбора серверов для HTTP-запросов. | ||
| server_timeout - добавлено в 2.9 | Значение таймаута сервера определяет время, в течение которого должно быть установлено соединение с сервером и завершено обмен запросом-ответом между avi и сервером. Значение 0 приводит к использованию значения таймаута по умолчанию в 60 минут. Допустимые значения: 0-3600000. Поле введено в 18.1.5, 18.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0. | ||
| servers - | Пул направляет сбалансированный по нагрузке трафик на этот список целевых серверов. Серверы могут быть сконфигурированы по IP-адресу, имени, сети или с помощью группы IP-адресов. | ||
| service_metadata - добавлено в 2.9 | Метаданные, относящиеся к предоставляемому данным пулом сервису. В средах 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 string | По умолчанию: "admin" | Имя клиента, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref - | Это ссылка на объект типа tenant. | ||
| tenant_uuid string | По умолчанию: "" | UUID клиента, используемого для всех вызовов API Avi и контекста объекта. | |
| url - | URL контроллера Avi для объекта. | ||
| use_service_port boolean |
| Не переводить порт назначения клиента при отправке соединения на сервер. Порт сервиса, указанный в пуле или серверах, по-прежнему будет использоваться для мониторинга состояния. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| username string | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру 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
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
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) |
Состояние
- Этот модуль не гарантирует обратную совместимость интерфейса. [бета-версия]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/avi_pool_module.html
