Spec-Zone.ru › Ansible 2.7

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_context
-
добавлен в 2.5
Контекст API Avi, который включает текущий идентификатор сеанса и маркер CSRF.
Это позволяет пользователю выполнить единый вход и повторно использовать сеанс.
api_version
-
По умолчанию:
"16.4.4"
Версия 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.
avi_api_patch_op
-
добавлен в 2.5
    Варианты:
  • add
  • replace
  • delete
Операция исправления, используемая при использовании avi_api_update_method как patch.
avi_api_update_method
-
добавлен в 2.5
    Варианты:
  • put ←
  • patch
Метод по умолчанию для обновления объекта — HTTP PUT.
Указание patch переопределяет это поведение на использование HTTP PATCH.
avi_credentials
-
добавлен в 2.5
Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в систему контроллера Avi.
capacity_estimation
boolean
    Варианты:
  • no
  • yes
Встроенная оценка емкости серверов.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
capacity_estimation_ttfb_thresh
-
Максимальное время первого байта сервера.
Допустимые значения от 1 до 5000.
Специальные значения 0 — «автоматически».
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.
Единицы (миллисекунды).
cloud_config_cksum
-
Контрольная сумма конфигурации облака для пула.
Внутренне устанавливается соединителем облака.
cloud_ref
-
Это ссылка на объект типа cloud.
connection_ramp_duration
-
Продолжительность, в течение которой новые подключения будут постепенно наращиваться до сервера, недавно подключённого к сети.
Полезно для алгоритмов lb, которые не основаны на количестве подключений.
Допустимые значения от 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
boolean
    Варианты:
  • no
  • yes
Наследуемая конфигурация от virtualservice.
enabled
boolean
    Варианты:
  • no
  • yes
Включить или отключить пул.
Отключение приведёт к завершению всех открытых подключений и приостановке мониторов состояния.
Значение по умолчанию, если не указано в 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
-
Используется для плавного отключения сервера.
Виртуальная служба ожидает указанное время перед завершением существующих подключений к отключённым серверам.
Допустимые значения от 1 до 7200.
Специальные значения 0 — «немедленно», -1 — «бесконечно».
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1.
Единицы (мин).
gslb_sp_enabled
boolean
добавлен в 2.5
    Варианты:
  • no
  • yes
Указывает, является ли пул пулом с сохранением сайта.
Поле добавлено в 17.2.1.
health_monitor_refs
-
Проверка состояния сервера путём применения одного или нескольких мониторов состояния.
Активные мониторы генерируют синтетический трафик с каждого сервера обслуживания и отмечают сервер как активный или неактивный на основе ответа.
Пассивный монитор следит только за клиентско-серверным общением.
Он увеличивает или уменьшает соотношение трафика, направляемого на сервер, на основе успешных ответов.
Это ссылка на объект типа healthmonitor.
host_check_enabled
boolean
    Варианты:
  • no
  • yes
Включить проверку общего имени для сертификата сервера.
При включении и отсутствии явного имени домена avi будет использовать заголовок хоста входящего запроса для сопоставления.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
inline_health_monitor
boolean
    Варианты:
  • нет
  • да
Пассивный монитор будет контролировать подключения и запросы клиента к серверу, а также регулировать нагрузку на серверы на основе успешных ответов.
Это может изменить ожидаемое поведение метода lb, например, round robin.
Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как 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 Controller интерпретирует как LB_ALGORITHM_LEAST_CONNECTIONS.
lb_algorithm_consistent_hash_hdr
-
Имя HTTP-заголовка, которое будет использоваться в качестве ключа хэша.
lb_algorithm_core_nonaffinity
-
добавлено в 2.4
Степень неаффинити для выбора сервера на основе аффинити к ядру.
Допустимые значения - 1-65535.
Поле введено в 17.1.3.
Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как 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, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING.
Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS.
lookup_server_by_name
boolean
добавлено в 2.5
    Варианты:
  • нет
  • да
Разрешить поиск сервера по имени.
Поле введено в 17.1.11,17.2.4.
Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как False.
max_concurrent_connections_per_server
-
Максимальное количество одновременных подключений к каждому серверу в пуле.
Примечание. Применённое значение будет не меньше количества узлов службы, на которых размещен пул.
Если значение установлено в 0, ограничение не применяется.
Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как 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 Controller интерпретирует как 128.
request_queue_enabled
boolean
    Варианты:
  • нет
  • да
Включить очередь запросов, когда пул заполнен.
Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как False.
rewrite_host_header_to_server_name
boolean
    Варианты:
  • нет
  • да
Перезаписать входящий заголовок Host на имя сервера, на который перенаправляется запрос.
Включение этой функции перезаписывает заголовок Host для запросов ко всем серверам в пуле.
Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как False.
rewrite_host_header_to_sni
boolean
    Варианты:
  • нет
  • да
Если указано имя сервера sni, перепишите входящий заголовок Host на имя сервера sni.
Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как False.
server_auto_scale
boolean
    Варианты:
  • нет
  • да
Автомасштабирование серверов.
Больше не используется.
Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как False.
server_count
-
Количество server_count.
Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как 0.
server_name
-
Полное доменное имя DNS, которое будет использоваться в расширении TLS sni в подключениях к серверам, если sni включен.
Если значение не указано, Avi будет использовать входящий заголовок Host вместо него.
server_reselect
-
Настройка повторного выбора сервера для HTTP-запросов.
servers
-
Пул направляет сбалансированный по нагрузке трафик на этот список целевых серверов.
Серверы могут быть настроены по IP-адресу, имени, сети или с помощью группы IP-адресов.
sni_enabled
boolean
    Варианты:
  • нет
  • да
Включить tls sni для подключений к серверам.
Если отключено, Avi не будет отправлять расширение sni в рамках рукопожатия.
Значение по умолчанию, если не указано в API или модуле, Avi Controller интерпретирует как 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
boolean
    Варианты:
  • нет
  • да
Не переводить целевой порт клиента при отправке соединения на сервер.
Порт службы пула или серверов, указанный в конфигурации, по-прежнему будет использоваться для мониторинга состояния.
Значение по умолчанию, если оно не указано в 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
  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. [сообщество]

Авторы

  • Gaurav Rastogi (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.7/modules/avi_pool_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API