community.network.avi_pool – Модуль для настройки объекта Pool Avi RESTful
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: 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, который включает текущий идентификатор сеанса и маркер 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 Credentials, который может быть использован вместо перечисления данных входа в Avi Controller. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или SQDN контроллера Avi | ||
| 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 булево |
| Отключает кеширование информации о сеансе avi в качестве факта. | |
| capacity_estimation булево |
| Встроенная оценка емкости серверов. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как Ложь. | |
| 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 булево |
| Указывает, отключаются (false) или удаляются (true) существующие IP-адреса при обновлении DNS-имени хоста — при обновлении DNS некоторые IP-адреса, заданные в пуле, могут больше не возвращаться разрешителем. Эти IP-адреса удаляются из пула, когда этот переключатель установлен в значение "истина". Они отключаются, если переключатель установлен в значение "ложь". Поле добавлено в версии 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 | Полное доменное имя (FQDN), которое будет использоваться в расширении 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 хранится информация о метаданных приложения. Любой пользовательский ввод в это поле будет перезаписан vantage Avi. Поле добавлено в версиях 17.2.14, 18.1.5, 18.2.1. | ||
| sni_enabled boolean |
| Включить tls sni для подключений к серверам. Если отключено, Avi не будет отправлять расширение sni в рамках процесса установления соединения. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | |
| ssl_key_and_certificate_ref string | Сервисные движки представят серверу клиентский сертификат SSL. Это ссылка на объект типа sslkeyandcertificate. | ||
| ssl_profile_ref string | При включении Avi повторно шифрует трафик для серверов бэкенда. Конкретный профиль SSL определяет, какие шифры и версии SSL будут поддерживаться. Это ссылка на объект типа sslprofile. | ||
| state string |
| Состояние, которое должно быть применено к сущности. | |
| tenant string | По умолчанию: "admin" | Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. | |
| tenant_ref string | Это ссылка на объект типа tenant. | ||
| tenant_uuid string | По умолчанию: "" | UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. | |
| url string | URL контроллера Avi для объекта. | ||
| use_service_port boolean |
| Не переводить порт назначения клиента при отправке соединения на сервер. Порт сервиса, указанный в пуле или на серверах, по-прежнему будет использоваться для мониторинга состояния. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| username string | По умолчанию: "" | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME. | |
| uuid string | Uuid пула. | ||
| vrf_ref string | Виртуальная маршрутизация контекста, к которому привязан пул. Это используется для обеспечения изоляции набора сетей, к которым подключен пул. Пул наследует виртуальный контекст маршрутизации виртуальной службы, и этот параметр используется только внутренне, и устанавливается 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 dictionary | success, changed | Объект пула (api/pool) |
Авторы
- Гaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_pool_module.html
