Spec-Zone.ru › Ansible 2.6

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.
capacity_estimation
bool
    Варианты:
  • 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
bool
    Варианты:
  • no
  • yes
Наследуемая конфигурация из virtualservice.
enabled
bool
    Варианты:
  • 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
bool

(добавлено в 2.5)
    Варианты:
  • no
  • yes
Указывает, является ли пул пулом сохранения сайта.
Поле введено в 17.2.1.
health_monitor_refs
Проверьте состояние сервера, применив один или несколько мониторов состояния.
Активные мониторы генерируют синтетический трафик с каждого движка сервиса и помечают сервер как активный или неактивный на основе ответа.
Пассивный монитор следит только за общением клиент-сервер.
Он увеличивает или уменьшает соотношение трафика, направленного на сервер, на основе успешных ответов.
Это ссылка на объект типа healthmonitor.
host_check_enabled
bool
    Варианты:
  • no
  • yes
Включить проверку общего имени для сертификата сервера.
Если включено и явно не указано имя домена, avi будет использовать заголовок host входящего запроса для сопоставления.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
inline_health_monitor
bool
    Варианты:
  • no
  • yes
Пассивный монитор будет следить за подключениями и запросами клиент-сервер и корректировать нагрузку на серверы на основе успешных ответов.
Это может изменить ожидаемое поведение метода 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
bool

(added in 2.5)
    Choices:
  • no
  • yes
Разрешить поиск сервера по имени.
Поле введено в 17.1.11, 17.2.4.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 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
bool
    Choices:
  • no
  • yes
Включить очередь запросов, когда пул заполнен.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
rewrite_host_header_to_server_name
bool
    Choices:
  • no
  • yes
Переписать входящий заголовок хоста на имя сервера, к которому запрос проксируется.
Включение этой функции переписывает заголовок хоста для запросов ко всем серверам в пуле.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
rewrite_host_header_to_sni
bool
    Choices:
  • no
  • yes
Если указано имя сервера sni, переписать входящий заголовок хоста на имя сервера sni.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
server_auto_scale
bool
    Choices:
  • no
  • yes
Автомасштабирование серверов.
Больше не используется.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
server_count
Количество server_count.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.
server_name
Полное доменное имя dns, которое будет использоваться в расширении tls sni в соединениях серверов, если sni включен.
Если значение не указано, avi будет использовать входящий заголовок хоста вместо него.
server_reselect
Конфигурация перевыбора сервера для запросов http.
servers
Пул направляет сбалансированный по нагрузке трафик на этот список целевых серверов.
Серверы могут быть сконфигурированы по IP-адресу, имени, сети или по группе IP-адресов.
sni_enabled
bool
    Choices:
  • no
  • yes
Включить tls sni для подключений серверов.
Если отключено, avi не будет отправлять расширение sni в рамках рукопожатия.
Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True.
ssl_key_and_certificate_ref
Серверные узлы представят сертификат ssl клиента серверу.
Это ссылка на объект типа sslkeyandcertificate.
ssl_profile_ref
При включении avi заново шифрует трафик для серверов бэкэнда.
Конкретный профиль ssl определяет, какие шифры и версии ssl будут поддерживаться.
Это ссылка на объект типа sslprofile.
state
    Choices:
  • absent
  • present ←
Состояние, которое должно быть применено к сущности.
tenant Значение по умолчанию:
"admin"
Имя арендатора, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref
Это ссылка на объект типа tenant.
tenant_uuid Значение по умолчанию:
""
UUID арендатора, используемого для всех вызовов API Avi и контекста объекта.
url
URL контроллера Avi объекта.
use_service_port
bool
    Choices:
  • 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)


Статус

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

Техническое обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, которые также поддерживаются сообществом 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.6/modules/avi_pool_module.html

Spec-Zone.ru

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