Spec-Zone.ru › Ansible 2.8

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

Новое в версии 2.3.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Обзор

  • Этот модуль используется для настройки объекта Pool
  • больше примеров на https://github.com/avinetworks/devops

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • avisdk

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
a_pool
-
Имя контейнерного облачного приложения, которое составляет пул в конфигурации a-b пулов, если оно отличается от vs app.
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
-
Синхронизировать члены 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
    Варианты:
  • 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 Credentials, который можно использовать вместо перечисления данных входа в систему контроллера Avi.
capacity_estimation
логическое
    Варианты:
  • 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
логическое
    Варианты:
  • no
  • yes
Унаследованная конфигурация от virtualservice.
enabled
логическое
    Варианты:
  • 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
логическое
добавлен в 2.5
    Варианты:
  • no
  • yes
Указывает, является ли пул пулом с размещением по сайтам.
Поле введено в 17.2.1.
health_monitor_refs
-
Проверьте состояние сервера, применив один или несколько мониторов состояния.
Активные мониторы генерируют синтетический трафик с каждого движка службы и отмечают сервер как активный или неактивный на основе ответа.
Пассивный монитор слушает только общение клиент-сервер.
Он увеличивает или уменьшает соотношение трафика, направленного на сервер, на основе успешных ответов.
Это ссылка на объект типа healthmonitor.
host_check_enabled
логическое
    Варианты:
  • no
  • yes
Включить проверку общего имени для сертификата сервера.
Если включено и явно не указано имя домена, avi будет использовать заголовок входящего хоста для соответствия.
Значение по умолчанию, когда оно не указано в API или модуле, интерпретируется контроллером Avi как False.
inline_health_monitor
boolean
    Выбори:
  • нет
  • да
Пассивный монитор будет отслеживать подключения и запросы клиента к серверу, а также корректировать нагрузку на серверы на основе успешных ответов.
Это может изменить ожидаемое поведение метода lb, например, 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, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS.
lookup_server_by_name
boolean
добавлено в 2.5
    Выбори:
  • нет
  • да
Разрешить поиск сервера по имени.
Поле введено в 17.1.11, 17.2.4.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
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
boolean
    Выбори:
  • нет
  • да
Включить очередь запросов, когда пул заполнен.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
rewrite_host_header_to_server_name
boolean
    Выбори:
  • нет
  • да
Перезаписать заголовок host входящего запроса на имя сервера, к которому запрос проксируется.
Включение этой функции перезаписывает заголовок host для запросов ко всем серверам в пуле.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
rewrite_host_header_to_sni
boolean
    Выбори:
  • нет
  • да
Если указано имя сервера sni, переписать заголовок host входящего запроса на имя сервера sni.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
server_auto_scale
boolean
    Выбори:
  • нет
  • да
Автомасштабирование серверов.
Больше не используется.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
server_count
-
Количество server_count.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.
server_name
-
Полное доменное имя хоста (FQDN), которое будет использоваться в расширении tls sni в подключениях к серверам, если включен sni.
Если значение не указано, avi будет использовать входящий заголовок host.
server_reselect
-
Конфигурация повторного выбора сервера для http-запросов.
servers
-
Пул направляет сбалансированный трафик на этот список целевых серверов.
Серверы могут быть настроены по IP-адресу, имени, сети или через группу IP-адресов.
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
строка
По умолчанию:
"admin"
Имя тенанта, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref
-
Это ссылка на объект типа tenant.
tenant_uuid
string
Значение по умолчанию:
""
UUID арендатора, используемого для всех вызовов API Avi и контекста объекта.
url
-
URL контроллера Avi для объекта.
use_service_port
boolean
    Варианты:
  • no
  • yes
Не переводить порт назначения клиента при отправке подключения на сервер.
Порт сервиса, указанный в пуле или серверах, по-прежнему будет использоваться для мониторинга работоспособности.
Значение по умолчанию, если не указано в 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. [сообщество]

Авторы

  • 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.8/modules/avi_pool_module.html

Spec-Zone.ru

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