Spec-Zone.ru › Ansible

Модуль community.aws.elb_network_lb — управление сетевым балансировщиком нагрузки

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install community.aws. Для использования этого модуля нужны дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.aws.elb_network_lb.

Добавлено в community.aws 1.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Управление сетевым эластичным балансировщиком нагрузки AWS. Подробности см. на странице https://aws.amazon.com/blogs/aws/new-network-load-balancer-effortless-scaling-to-millions-of-requests-per-second/.

Требования

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

  • python >= 3.6
  • boto3 >= 1.34.0
  • botocore >= 1.34.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key

string

Идентификатор ключа доступа AWS.

Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile нельзя использовать одновременно.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.

aws_ca_bundle

path

Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов.

Также можно использовать переменную среды AWS_CA_BUNDLE.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Описание параметров приведено в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

cross_zone_load_balancing

boolean

Указывает, включена ли межзональная балансировка нагрузки.

По умолчанию — false.

Варианты:

  • false
  • true

debug_botocore_endpoint_logs

boolean

Использовать регистратор botocore.endpoint для анализа уникальных (а не общих) вызовов API "resource:action", выполненных во время задачи, и выводить их набор в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести полный список вызовов, выполненных в плейбуке.

Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

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

deletion_protection

boolean

Указывает, включена ли защита ELB от удаления.

По умолчанию — false.

Варианты:

  • false
  • true

endpoint_url

псевдонимы: aws_endpoint_url

string

URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную среды AWS_URL.

ip_address_type

string

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

Варианты:

  • "ipv4"
  • "dualstack"

listeners

list / элементы=dictionary

Список словарей с прослушивателями, подключаемыми к ELB. Подробнее о требуемом формате словаря см. в примерах. Обратите внимание, что ключи прослушивателей записываются в CamelCase.

AlpnPolicy

string

добавлено в community.aws 7.1.0

Название политики согласования протокола прикладного уровня (ALPN).

Варианты:

  • "HTTP1Only"
  • "HTTP2Only"
  • "HTTP2Optional"
  • "HTTP2Preferred"
  • "None"

Certificates

list / элементы=dictionary

SSL-сертификат сервера.

CertificateArn

string

Имя ресурса Amazon (ARN) сертификата.

DefaultActions

list / элементы=dictionary / обязательный

Действия по умолчанию для прослушивателя.

TargetGroupArn

string

Имя ресурса Amazon (ARN) целевой группы.

Несовместим с TargetGroupName.

TargetGroupName

string

Название целевой группы.

Несовместим с TargetGroupArn.

Type

string

Тип действия.

Port

integer / обязательный

Порт, на котором прослушивает балансировщик нагрузки.

Protocol

string / обязательный

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

SslPolicy

string

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

name

string / обязательный

Имя балансировщика нагрузки. Это имя должно быть уникальным в вашей учетной записи AWS, содержать не более 32 символов, включать только буквенно-цифровые символы или дефисы и не начинаться и не заканчиваться дефисом.

profile

псевдонимы: aws_profile

string

Именованный профиль AWS для аутентификации.

Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную среды AWS_PROFILE.

Параметр profile несовместим с параметрами aws_access_key, aws_secret_key и session_token.

purge_listeners

boolean

Если purge_listeners=true, существующие прослушиватели будут удалены из ELB, чтобы их набор в точности соответствовал параметру listeners.

Если параметр listeners не задан, прослушиватели не изменяются.

Варианты:

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

purge_tags

boolean

Если задано purge_tags=true и tags, существующие теги будут удалены из ресурса, чтобы их набор в точности соответствовал параметру tags.

Если параметр tags не задан, теги не изменяются, даже если purge_tags=True.

Ключи тегов, начинающиеся с aws:, зарезервированы Amazon и не могут быть изменены. Поэтому они игнорируются при обработке параметра purge_tags. Дополнительные сведения см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

Варианты:

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

region

псевдонимы: aws_region

string

Регион AWS для использования.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную среды AWS_REGION.

Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

scheme

string

Интернет-ориентированный или внутренний балансировщик нагрузки. Схему ELB нельзя изменить после создания.

Варианты:

  • "internet-facing" ← (по умолчанию)
  • "internal"

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

string

Секретный ключ доступа AWS.

Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile нельзя использовать одновременно.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.

session_token

псевдонимы: aws_session_token

string

Токен сеанса AWS STS для использования с временными учетными данными.

Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменную среды AWS_SESSION_TOKEN.

Параметры session_token и profile нельзя использовать одновременно.

state

string

Создать или удалить балансировщик нагрузки.

В выпуске 4.0.0 значение по умолчанию изменено с 'absent' на 'present'.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

subnet_mappings

list / элементы=dictionary

Список словарей с идентификаторами подсетей, подключаемых к балансировщику нагрузки. Также можно указать идентификатор выделения Elastic IP для подключения к балансировщику нагрузки или внутренний IP-адрес для внутреннего балансировщика. Для каждой подсети можно указать один адрес Elastic IP или внутренний адрес.

Этот параметр несовместим с subnets.

subnets

list / элементы=string

Список идентификаторов подсетей, подключаемых к балансировщику нагрузки. Для каждой зоны доступности можно указать только одну подсеть. Необходимо указать подсети как минимум из двух зон доступности.

Обязателен, если state=present.

Этот параметр несовместим с subnet_mappings.

tags

псевдонимы: resource_tags

dictionary

Словарь тегов, применяемых к ресурсу.

Если параметр tags не задан, теги не изменяются.

validate_certs

boolean

Если задано значение false, SSL-сертификаты при взаимодействии с API AWS проверяться не будут.

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle.

Варианты:

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

wait

boolean

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

Варианты:

  • false
  • true

wait_timeout

integer

Время ожидания в секундах; используется вместе с параметром wait.

Примечания

Примечание

  • Прослушиватели сопоставляются по порту. Если порт прослушивателя изменится, будет создан новый прослушиватель.
  • Правила прослушивателя сопоставляются по приоритету. Если приоритет правила изменится, будет создано новое правило.
  • Предупреждение: Для модулей переменные среды и файлы конфигурации считываются из контекста «хоста» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «хост». Для плагинов поиска и подключений переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «хоста».
  • Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «хоста» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Create an ELB and attach a listener
  community.aws.elb_network_lb:
    name: myelb
    subnets:
      - subnet-012345678
      - subnet-abcdef000
    listeners:
      - Protocol: TCP # Required. The protocol for connections from clients to the load balancer (TCP, TLS, UDP or TCP_UDP) (case-sensitive).
        Port: 80 # Required. The port on which the load balancer is listening.
        DefaultActions:
          - Type: forward # Required. Only 'forward' is accepted at this time
            TargetGroupName: mytargetgroup # Required. The name of the target group
    state: present

- name: Create an ELB with an attached Elastic IP address
  community.aws.elb_network_lb:
    name: myelb
    subnet_mappings:
      - SubnetId: subnet-012345678
        AllocationId: eipalloc-aabbccdd
    listeners:
      - Protocol: TCP # Required. The protocol for connections from clients to the load balancer (TCP, TLS, UDP or TCP_UDP) (case-sensitive).
        Port: 80 # Required. The port on which the load balancer is listening.
        DefaultActions:
          - Type: forward # Required. Only 'forward' is accepted at this time
            TargetGroupName: mytargetgroup # Required. The name of the target group
    state: present

- name: Create an internal ELB with a specified IP address
  community.aws.elb_network_lb:
    name: myelb
    scheme: internal
    subnet_mappings:
      - SubnetId: subnet-012345678
        PrivateIPv4Address: 192.168.0.1 # Must be an address from within the CIDR of the subnet.
    listeners:
      - Protocol: TCP # Required. The protocol for connections from clients to the load balancer (TCP, TLS, UDP or TCP_UDP) (case-sensitive).
        Port: 80 # Required. The port on which the load balancer is listening.
        DefaultActions:
          - Type: forward # Required. Only 'forward' is accepted at this time
            TargetGroupName: mytargetgroup # Required. The name of the target group
    state: present

- name: Remove an ELB
  community.aws.elb_network_lb:
    name: myelb
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

load_balancer

dictionary

добавлено в community.aws 5.0.0

Представление сетевого балансировщика нагрузки

Возвращается: когда state имеет значение present

availability_zones

list / elements=string

Зоны доступности балансировщика нагрузки.

Возвращается: когда state имеет значение present

Пример: ["[{'subnet_id': 'subnet-aabbccddff'", " 'zone_name': 'ap-southeast-2a'", " 'load_balancer_addresses': []}]"]

canonical_hosted_zone_id

string

Идентификатор размещённой зоны Amazon Route 53, связанной с балансировщиком нагрузки.

Возвращается: когда state имеет значение present

Пример: "ABCDEF12345678"

created_time

string

Дата и время создания балансировщика нагрузки.

Возвращается: когда state имеет значение present

Пример: "2015-02-12T02:14:02+00:00"

deletion_protection_enabled

string

Указывает, включена ли защита от удаления.

Возвращается: когда state имеет значение present

Пример: "True"

dns_name

string

Общедоступное DNS-имя балансировщика нагрузки.

Возвращается: когда state имеет значение present

Пример: "internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com"

idle_timeout_timeout_seconds

string

Значение тайм-аута ожидания в секундах.

Возвращается: когда state имеет значение present

Пример: "60"

ip_address_type

string

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

Возвращается: когда state имеет значение present

Пример: "ipv4"

listeners

complex

Информация о прослушивателях.

Возвращается: когда state имеет значение present

alpn_policy

list / elements=string

добавлено в community.aws 7.1.0

Название политики согласования протоколов прикладного уровня (ALPN).

Возвращается: когда state имеет значение present

Пример: ["HTTP1Only", "HTTP2Only"]

certificates

complex

Сертификат SSL-сервера.

Возвращается: когда state имеет значение present

certificate_arn

string

Имя ресурса Amazon (ARN) сертификата.

Возвращается: когда state имеет значение present

Пример: ""

default_actions

string

Действия по умолчанию для прослушивателя.

Возвращается: когда state имеет значение present

target_group_arn

string

Имя ресурса Amazon (ARN) целевой группы.

Возвращается: когда state имеет значение present

Пример: ""

type

string

Тип действия.

Возвращается: когда state имеет значение present

Пример: ""

listener_arn

string

Имя ресурса Amazon (ARN) прослушивателя.

Возвращается: когда state имеет значение present

Пример: ""

load_balancer_arn

string

Имя ресурса Amazon (ARN) балансировщика нагрузки.

Возвращается: когда state имеет значение present

Пример: ""

port

integer

Порт, на котором прослушивает балансировщик нагрузки.

Возвращается: когда state имеет значение present

Пример: 80

protocol

string

Протокол для соединений между клиентами и балансировщиком нагрузки.

Возвращается: когда state имеет значение present

Пример: "HTTPS"

ssl_policy

string

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

Возвращается: когда state имеет значение present

Пример: ""

load_balancer_arn

string

Имя ресурса Amazon (ARN) балансировщика нагрузки.

Возвращается: когда state имеет значение present

Пример: "arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:loadbalancer/app/my-elb/001122334455"

load_balancer_name

string

Имя балансировщика нагрузки.

Возвращается: когда state имеет значение present

Пример: "my-elb"

load_balancing_cross_zone_enabled

string

Указывает, включена ли межзональная балансировка нагрузки.

Возвращается: когда state имеет значение present

Пример: "True"

scheme

string

Балансировщик нагрузки, доступный из Интернета, или внутренний балансировщик.

Возвращается: когда state имеет значение present

Пример: "internal"

state

dictionary

Состояние балансировщика нагрузки.

Возвращается: когда state имеет значение present

Пример: {"code": "active"}

tags

dictionary

Теги, присоединённые к балансировщику нагрузки.

Возвращается: когда state имеет значение present

Пример: {"Tag": "Example"}

type

string

Тип балансировщика нагрузки.

Возвращается: когда state имеет значение present

Пример: "network"

vpc_id

string

Идентификатор VPC балансировщика нагрузки.

Возвращается: когда state имеет значение present

Пример: "vpc-0011223344"

Авторы

  • Rob White (@wimnat)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/elb_network_lb_module.html

Spec-Zone.ru

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