Модуль community.network.avi_pool – Модуль для настройки объекта Pool Avi RESTful

a_pool

string

Имя контейнерного облачного приложения, которое составляет пул в конфигурации пула a-b, если оно отличается от приложения vs.

Поле устарело в версии 18.1.2.

ab_pool

string

Конфигурация пула A/B.

Поле устарело в версии 18.1.2.

ab_priority

string

Приоритет этого пула в паре пулов A-B.

Используется внутренне.

Поле устарело в версии 18.1.2.

analytics_policy

string

Определяет параметры аналитики для пула.

Поле добавлено в версиях 18.1.5, 18.2.1.

analytics_profile_ref

string

Указывает параметры, связанные с аналитикой.

Это ссылка на объект типа analyticsprofile.

Поле добавлено в версиях 18.1.4, 18.2.1.

api_context

dictionary

Контекст API Avi, который включает текущий идентификатор сессии и токен CSRF.

Это позволяет пользователю выполнить однократный вход и повторно использовать сессию.

api_version

string

Версия API Avi, которая будет использоваться для API Avi и объектов.

Значение по умолчанию: "16.4.4"

apic_epg_name

string

Синхронизация участников Cisco APIC EPG с серверами пула.

application_persistence_profile_ref

string

Сохранение настроек гарантирует, что один и тот же пользователь будет привязан к одному и тому же серверу в течение желаемого периода времени.

Это ссылка на объект типа applicationpersistenceprofile.

autoscale_launch_config_ref

string

Если настроено, Avi запустит оркестровку создания и удаления серверов пула.

Поддерживается только для облачных контейнеров, таких как Mesos, OpenShift, Kubernetes, Docker и т. д.

Это ссылка на объект типа autoscalelaunchconfig.

autoscale_networks

string

Идентификаторы сетей для конфигурации запуска.

autoscale_policy_ref

string

Ссылка на политику автомасштабирования сервера.

Это ссылка на объект типа serverautoscalepolicy.

avi_api_patch_op

string

Операция исправления, используемая при использовании avi_api_update_method как patch.

Варианты:

• "add"
• "replace"
• "delete"

avi_api_update_method

string

Метод обновления объекта по умолчанию - HTTP PUT.

Установка значения patch переопределит это поведение, используя HTTP PATCH.

Варианты:

• "put" ← (default)
• "patch"

avi_credentials

dictionary

Словарь учетных данных Avi, который может использоваться вместо перечисления сведений для входа в контроллер Avi.

api_version

string

Версия контроллера Avi

Значение по умолчанию: "16.4.4"

controller

string

IP-адрес или SQDN контроллера Avi

csrftoken

string

Токен csrftoken API контроллера Avi для повторного использования существующей сессии с идентификатором сессии

Значение по умолчанию: ""

password

string

Пароль контроллера Avi

port

string

Порт контроллера Avi

session_id

string

Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken

Значение по умолчанию: ""

tenant

string

Клиент контроллера Avi

Значение по умолчанию: "admin"

tenant_uuid

string

UUID клиента контроллера Avi

Значение по умолчанию: ""

timeout

string

Таймаут запроса к контроллеру Avi

По умолчанию: 300

token

string

Токен API контроллера Avi

По умолчанию: ""

username

string

Имя пользователя контроллера Avi

avi_disable_session_cache_as_fact

boolean

Отключает кэширование информации о сессии avi в качестве факта.

Варианты:

• false ← (по умолчанию)
• true

capacity_estimation

boolean

Встроенная оценка емкости серверов.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

• false
• true

capacity_estimation_ttfb_thresh

string

Максимальное время до первого байта (TTFB) сервера.

Допустимые значения от 1 до 5000.

Особые значения: 0 — «автоматически».

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.

cloud_config_cksum

string

Контрольная сумма конфигурации облака для пула.

Внутренне устанавливается облачным соединителем.

cloud_ref

string

Ссылка на объект типа облако.

conn_pool_properties

string

Свойства пула соединений.

Поле введено в версии 18.2.1.

connection_ramp_duration

string

Длительность постепенного увеличения новых подключений к недавно подключенному серверу.

Полезно для алгоритмов балансировки нагрузки, которые основаны на минимальном количестве подключений.

Допустимые значения от 1 до 300.

Особые значения: 0 — «немедленно».

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 10.

controller

string

IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения AVI_CONTROLLER.

created_by

string

Имя создателя.

default_server_port

string

Этот порт будет использоваться для трафика на серверы, если не указан другой порт для конкретного сервера.

Флажок ssl позволяет Avi использовать шифрование сервера.

Допустимые значения от 1 до 65535.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 80.

delete_server_on_dns_refresh

boolean

Указывает, будут ли существующие IP-адреса отключаться (false) или удаляться (true) при обновлении DNS-имени хоста. При обновлении DNS некоторые IP-адреса, установленные в пуле, могут больше не возвращаться резолвером.

Эти IP-адреса удаляются из пула, если этот флаг установлен в значение true.

Они отключаются, если флаг установлен в значение false.

Поле введено в версии 18.2.3.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.

Варианты:

• false
• true

description

string

Описание пула.

domain_name

string

Список доменных имен, разделенных запятыми, которые будут использоваться для проверки общих имен или альтернативных имен субъектов, представленных сертификатами сервера.

Это выполняется только при включенном провереке общего имени (host_check_enabled).

east_west

boolean

Наследуемая конфигурация из virtualservice.

Варианты:

• false
• true

enabled

boolean

Включить или отключить пул.

Отключение приведет к завершению всех открытых соединений и приостановке мониторинга работоспособности.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.

Варианты:

• false
• true

external_autoscale_groups

string

Имена внешних групп автоматического масштабирования для серверов пула.

В настоящее время доступно только для aws и azure.

Поле введено в версии 17.1.2.

fail_action

string

Включить действие — закрыть соединение, перенаправить HTTP или отправить локальный HTTP ответ — при возникновении сбоя в пуле.

По умолчанию при возникновении сбоя в пуле соединение закрывается.

fewest_tasks_feedback_delay

string

Периодичность обратной связи для алгоритма выбора сервера с наименьшим количеством задач.

Допустимые значения: 1-300.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 10.

graceful_disable_timeout

string

Используется для плавного отключения сервера.

Виртуальная служба ожидает указанное время, прежде чем завершить существующие соединения с серверами, которые отключены.

Допустимые значения: 1-7200.

Специальные значения: 0 - «немедленно», -1 - «бесконечно».

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1.

gslb_sp_enabled

boolean

Указывает, является ли пул пулом сохранения состояния сайта.

Поле добавлено в версии 17.2.1.

Варианты:

• false
• true

health_monitor_refs

string

Проверка работоспособности сервера путем применения одного или нескольких мониторов работоспособности.

Активные мониторы генерируют синтетический трафик от каждого модуля обслуживания и помечают сервер как активный или неактивный в зависимости от ответа.

Пассивный монитор прослушивает только клиентское соединение с сервером.

Он повышает или понижает соотношение трафика, предназначенного для сервера, на основе успешных ответов.

Это ссылка на объект типа healthmonitor.

host_check_enabled

boolean

Включить проверку общего имени для сертификата сервера.

Если включено и не указано явное доменное имя, Avi будет использовать входящий заголовок host для сопоставления.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

• false
• true

inline_health_monitor

boolean

Пассивный монитор будет отслеживать соединения и запросы клиента с сервером и регулировать нагрузку трафика на серверы на основе успешных ответов.

Это может изменить ожидаемое поведение метода балансировки нагрузки, например, круговой выбор.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.

Варианты:

• false
• 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.

Варианты:

• false
• true

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.

Варианты:

• false
• true

rewrite_host_header_to_server_name

boolean

Перезаписать входящий заголовок host на имя сервера, на который проксируется запрос.

Включение этой функции перезаписывает заголовок host для запросов ко всем серверам в пуле.

Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

• false
• true

rewrite_host_header_to_sni

boolean

Если указано имя сервера SNI, перезаписать входящий заголовок host на имя сервера SNI.

Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

• false
• true

server_auto_scale

boolean

Автомасштабирование сервера.

Больше не используется.

Поле устарело в версии 18.1.2.

Варианты:

• false
• true

server_count

string

Поле устарело в версии 18.2.1.

server_name

string

Полностью квалифицированное доменное имя, которое будет использоваться в расширении TLS SNI в соединениях сервера, если SNI включено.

Если значение не указано, Avi будет использовать вместо него входящий заголовок host.

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.

Варианты:

• false
• true

ssl_key_and_certificate_ref

string

Сервисные модули будут представлять клиентский SSL-сертификат серверу.

Это ссылка на объект типа sslkeyandcertificate.

ssl_profile_ref

string

При включении Avi повторно шифрует трафик на бэкэнд-серверы.

Конкретный профиль SSL определяет, какие шифры и версии SSL будут поддерживаться.

Это ссылка на объект типа sslprofile.

state

string

Состояние, которое должно быть применено к объекту.

Варианты:

• "absent"
• "present" ← (default)

tenant

string

Название арендатора, используемого для всех вызовов API Avi и контекста объекта.

По умолчанию: "admin"

tenant_ref

string

Ссылка на объект типа арендатор.

tenant_uuid

string

UUID арендатора, используемого для всех вызовов API Avi и контекста объекта.

По умолчанию: ""

url

string

URL контроллера Avi для объекта.

use_service_port

boolean

Не переводить целевой порт клиента при отправке подключения на сервер.

Порт службы, указанный в пуле или серверах, по-прежнему будет использоваться для мониторинга работоспособности.

Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

Варианты:

• false
• true

username

string

Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME.

uuid

string

Uuid пула.

vrf_ref

string

Контекст виртуальной маршрутизации, к которому привязан пул.

Используется для обеспечения изоляции набора сетей, к которым подключен пул.

Пул наследует контекст виртуальной маршрутизации виртуальной службы, и это поле используется только внутри и устанавливается pb-transform.

Это ссылка на объект типа vrfcontext.