Spec-Zone.ru › Ansible 2.5

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
Синхронизировать членов cisco apic epg с серверами пула.
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 Credentials, который можно использовать вместо перечисления данных входа в Avi Controller.
capacity_estimation
    Варианты:
  • no
  • yes
Встроенная оценка емкости серверов.
Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как False.
capacity_estimation_ttfb_thresh
Максимальное время до первого байта сервера.
Допустимые значения от 1 до 5000.
Особые значения 0 — 'автоматически'.
Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 0.
Единицы (миллисекунды).
cloud_config_cksum
Контрольная сумма конфигурации облака для пула.
Внутренне устанавливается соединителем облака.
cloud_ref
Это ссылка на объект типа cloud.
connection_ramp_duration
Время, в течение которого новые соединения будут постепенно наращиваться до сервера, недавно подключенного онлайн.
Полезно для алгоритмов lb, которые не основаны на количестве соединений.
Допустимые значения от 1 до 300.
Особые значения 0 — 'немедленно'.
Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 10.
Единицы (мин).
controller По умолчанию:
IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER.
created_by
Имя создателя.
default_server_port
Трафик, отправленный на серверы, будет использовать этот порт назначения сервера, если не переопределен специальным атрибутом порта сервера.
Флажок ssl позволяет avi использовать шифрование сервера.
Допустимые значения от 1 до 65535.
Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 80.
description
Описание пула.
domain_name
Список доменных имен, разделенных запятыми, которые будут использоваться для проверки общих имен или альтернативных имен, представленных сертификатами сервера.
Это выполняется только при включенном проверке имени хоста host_check_enabled.
east_west
    Варианты:
  • no
  • yes
Наследуемая конфигурация из virtualservice.
enabled
    Варианты:
  • no
  • yes
Включить или отключить пул.
Отключение приведет к завершению всех открытых соединений и приостановке мониторов состояния.
Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как True.
external_autoscale_groups
Имена внешних групп автоматического масштабирования для серверов пула.
В настоящее время доступно только для aws и azure.
Поле добавлено в 17.1.2.
fail_action
Включить действие — закрыть соединение, перенаправление http или локальный http ответ — при возникновении сбоя пула.
По умолчанию соединение будет закрыто, если пул испытывает ошибку.
fewest_tasks_feedback_delay
Периодичность обратной связи для алгоритма выбора сервера с наименьшим количеством задач.
Допустимые значения от 1 до 300.
Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 10.
Единицы (сек).
graceful_disable_timeout
Используется для плавного отключения сервера.
Виртуальная служба ожидает указанное время перед завершением существующих соединений с отключенными серверами.
Допустимые значения от 1 до 7200.
Особые значения 0 — 'немедленно', -1 — 'бесконечно'.
Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как 1.
Единицы (мин).
gslb_sp_enabled
(добавлено в 2.5)
    Варианты:
  • no
  • yes
Указывает, является ли пул пулом site-persistence.
Поле добавлено в 17.2.1.
health_monitor_refs
Проверить состояние сервера, применив один или несколько мониторов состояния.
Активные мониторы генерируют синтетический трафик с каждого сервисного движка и помечают сервер как рабочий или нерабочий на основе ответа.
Пассивный монитор прослушивает только общение клиент-сервер.
Он увеличивает или уменьшает соотношение трафика, предназначенного для сервера, на основе успешных ответов.
Это ссылка на объект типа healthmonitor.
host_check_enabled
    Варианты:
  • no
  • yes
Включить проверку общего имени для сертификата сервера.
Если включено и не указано явное доменное имя, avi будет использовать входящий заголовок host для сопоставления.
Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как False.
inline_health_monitor
    Варианты:
  • no
  • yes
Пассивный монитор будет отслеживать соединения и запросы клиент-сервер и корректировать нагрузку трафика на серверы на основе успешных ответов.
Это может изменить ожидаемое поведение метода lb, например, круговую очередь.
Значение по умолчанию, если не указано в 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
(добавлено в 2.5)
    Варианты:
  • no
  • yes
Разрешить поиск сервера по имени.
Поле добавлено в 17.1.11, 17.2.4.
Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi Controller как False.
max_concurrent_connections_per_server
Максимальное количество одновременных подключений, разрешенных для каждого сервера в пуле.
Примечание: применённое значение не будет меньше числа серверных движков, на которых размещён пул.
Если установлено в 0, ограничение не применяется.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.
max_conn_rate_per_server
Ограничение скорости подключения к каждому серверу.
name
required
Имя пула.
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
    Варианты:
  • no
  • yes
Включить очередь запросов, когда пул заполнен.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
rewrite_host_header_to_server_name
    Варианты:
  • no
  • yes
Перезаписать входящий заголовок host на имя сервера, к которому запрос проксируется.
Включение этой функции перезаписывает заголовок host для запросов на все серверы в пуле.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
rewrite_host_header_to_sni
    Варианты:
  • no
  • yes
Если указано имя сервера sni, переписать входящий заголовок host на имя сервера sni.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
server_auto_scale
    Варианты:
  • no
  • yes
Автомасштабирование сервера.
Больше не используется.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
server_count
Количество server_count.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.
server_name
Полное доменное имя DNS, которое будет использоваться в расширении tls sni в подключениях сервера, если sni включен.
Если значение не указано, Avi будет использовать входящий заголовок host.
server_reselect
Конфигурация выбора сервера заново для запросов http.
servers
Пул направляет сбалансированный по нагрузке трафик на этот список целевых серверов.
Серверы можно настроить по IP-адресу, имени, сети или по группе IP-адресов.
sni_enabled
    Варианты:
  • no
  • yes
Включить tls sni для подключений сервера.
Если отключено, Avi не будет отправлять расширение sni в рамках рукопожатия.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.
ssl_key_and_certificate_ref
Серверные движки предоставят клиенту сертификат ssl для сервера.
Это ссылка на объект типа sslkeyandcertificate.
ssl_profile_ref
При включении Avi повторно шифрует трафик для серверов бэкэнда.
Конкретный профиль ssl определяет, какие шифры и версии ssl будут поддерживаться.
Это ссылка на объект типа sslprofile.
state
    Варианты:
  • absent
  • present ←
Состояние, которое должно быть применено к сущности.
tenant По умолчанию:
admin
Имя используемого для всех вызовов API Avi и контекста объекта арендатора.
tenant_ref
Это ссылка на объект типа tenant.
tenant_uuid По умолчанию:
UUID арендатора, используемого для всех вызовов API Avi и контекста объекта.
url
URL контроллера Avi для объекта.
use_service_port
    Варианты:
  • no
  • yes
Не переводить порт назначения клиента при отправке подключения на сервер.
Для мониторинга состояния здоровья по-прежнему будет использоваться указанный в пуле или на серверах порт службы.
Значение по умолчанию, если не указано в 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
dict
 success, changed
Объект пула (api/pool)


Статус

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

Автор

  • Гaurav 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.5/modules/avi_pool_module.html

Spec-Zone.ru

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