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

Примечание

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

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

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

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

Новый в community.aws 1.0.0

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

Описание

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

Требования

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

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	Идентификатор ключа доступа 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` или `EC2_ACCESS_KEY` в порядке убывания предпочтения. Опции aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK botocore AWS. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle путь	Расположение пакета CA для проверки SSL-сертификатов. Также может использоваться переменная среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
cross_zone_load_balancing логическое значение	Указывает, включено ли межзонное распределение нагрузки. По умолчанию `false`. Варианты: `false` `true`
debug_botocore_endpoint_logs логическое значение	Используйте `botocore.endpoint` логгер для анализа уникальных (а не общих) `"resource:action"` API-вызовов, сделанных во время задачи, выводя список в ключ resource_actions результатов задачи. Используйте `aws_resource_action` обратный вызов, чтобы вывести общий список, сделанный во время выполнения книги сценариев. Также может использоваться переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
deletion_protection логическое значение	Указывает, включена ли защита от удаления для ELB. По умолчанию `false`. Варианты: `false` `true`
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только с AWS. Также могут использоваться переменные среды `AWS_URL` или `EC2_URL` в порядке убывания предпочтения. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
ip_address_type строка	Устанавливает тип IP-адресов, используемых подсетями указанного балансировщика приложений. Варианты: `"ipv4"` `"dualstack"`
listeners список / элементы=словарь	Список словарей, содержащих слушателей для подключения к ELB. Подробности словаря см. в примерах. Обратите внимание, что ключи слушателей используют регистрозависимый стиль.
AlpnPolicy строка добавлено в community.aws 7.1.0	Имя политики Application-Layer Protocol Negotiation (ALPN). Варианты: `"HTTP1Only"` `"HTTP2Only"` `"HTTP2Optional"` `"HTTP2Preferred"` `"None"`
Certificates список / элементы=словарь	Сертификат SSL-сервера.
CertificateArn строка	Amazon Resource Name (ARN) сертификата.
DefaultActions список / элементы=словарь / обязательный	Действия по умолчанию для слушателя.
TargetGroupArn строка	Amazon Resource Name (ARN) целевой группы. Взаимоисключительно с TargetGroupName.
TargetGroupName строка	Имя целевой группы. Взаимоисключительно с TargetGroupArn.
Type строка	Тип действия.
Port целое число / обязательный	Порт, на котором балансировщик нагрузки прослушивает подключения.

Протокол строка / обязательно	Протокол для подключений от клиентов к балансировщику нагрузки.
SslPolicy строка	Политика безопасности, определяющая поддерживаемые шифры и протоколы.
имя строка / обязательно	Имя балансировщика нагрузки. Это имя должно быть уникальным в рамках вашей учетной записи AWS, может содержать не более 32 символов, должно содержать только буквенно-цифровые символы или дефисы, и не должно начинаться или заканчиваться дефисом.
профиль алиасы: aws_profile строка	Используемый именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также может использоваться переменная среды `AWS_PROFILE`. Параметр профиль является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token.
purge_listeners логический	Если purge_listeners=true, существующие слушатели будут удалены из ELB, чтобы точно соответствовать параметру listeners. Если параметр listeners не задан, слушатели не будут изменены. Варианты: `false` `true` ← (по умолчанию)
purge_tags логический	Если 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` ← (по умолчанию)
регион алиасы: aws_region, ec2_region строка	Используемый регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр регион игнорируется. Также могут использоваться переменные среды `AWS_REGION` или `EC2_REGION`. Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Алиас `ec2_region` устарел и будет удален в релизе после 2024-12-01 Поддержка переменной среды `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
схема строка	Интернет-ориентированный или внутренний балансировщик нагрузки. Схему ELB нельзя изменить после создания. Варианты: `"internet-facing"` ← (по умолчанию) `"internal"`
секретный_ключ алиасы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка	Секретный ключ доступа 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`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Параметры секретный_ключ и профиль взаимоисключающие. Алиас aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия с AWS botocore SDK. Алиас ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
токен_сессии алиасы: aws_session_token, security_token, aws_security_token, access_token строка	Токен сессии 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`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` в порядке убывания приоритета. Параметры токен_сессии и профиль взаимоисключающие. Алиасы aws_session_token и токен_сессии были добавлены в релизе 3.2.0, а параметр был переименован из security_token в токен_сессии в релизе 6.0.0. Алиасы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
состояние строка	Создать или удалить балансировщик нагрузки. Значение по умолчанию изменилось с `'absent'` на `'present'` в релизе 4.0.0. Варианты: `"present"` ← (по умолчанию) `"absent"`
subnet_mappings список / элементы=словарь	Список словарей, содержащих идентификаторы подсетей, которые необходимо подключить к балансировщику нагрузки. Также можно указать идентификатор выделения Elastic IP для подключения к балансировщику или внутренний IP-адрес для внутреннего балансировщика. На подсеть можно указать один адрес Elastic IP или внутренний адрес. Этот параметр взаимоисключающий с subnets.

END_OF_DOCUMENT_MARKER

subnets список / элементы=строка	Список идентификаторов подсетей, которые необходимо подключить к балансировщику нагрузки. Вы можете указать только одну подсеть на зону доступности. Необходимо указать подсети как минимум из двух зон доступности. Требуется при state=present. Этот параметр несовместим с параметром subnet_mappings.
метки псевдонимы: resource_tags словарь	Словарь, представляющий метки, которые необходимо применить к ресурсу. Если параметр метки не задан, метки не будут изменены.
validate_certs логическое значение	Если установлено значение `false`, сертификаты SSL не будут проверены для связи с API AWS. Настройка validate_certs=false категорически не рекомендуется. В качестве альтернативы можно настроить aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
wait логическое значение	Ожидать или нет, пока балансировщик сети достигнет желаемого состояния. Варианты: `false` `true`
wait_timeout целое число	Время ожидания в секундах, используется совместно с параметром wait.

Примечания

Примечание

Слушатели сопоставляются по порту. Если порт слушателя изменён, будет создан новый слушатель.
Правила слушателя сопоставляются по приоритету. Если приоритет правила изменён, будет создано новое правило.
Внимание: Для модулей переменные окружения и конфигурационные файлы считываются из контекста Ansible ‘хост’, а не ‘контроллер’. Следовательно, файлы может потребоваться скопировать на ‘хост’. Для плагинов поиска и подключения переменные окружения и конфигурационные файлы считываются из контекста Ansible ‘контроллер’, а не ‘хост’.
AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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 added in community.aws 5.0.0	Представление сетевого балансировщика нагрузки Возвращается: когда состояние равно present
availability_zones list / elements=string	Зоны доступности для балансировщика нагрузки. Возвращается: когда состояние равно present Пример: `["[{'subnet_id': 'subnet-aabbccddff'", " 'zone_name': 'ap-southeast-2a'", " 'load_balancer_addresses': []}]"]`
canonical_hosted_zone_id string	ID хостинговой зоны Amazon Route 53, связанной с балансировщиком нагрузки. Возвращается: когда состояние равно present Пример: `"ABCDEF12345678"`
created_time string	Дата и время создания балансировщика нагрузки. Возвращается: когда состояние равно present Пример: `"2015-02-12T02:14:02+00:00"`
deletion_protection_enabled string	Указывает, включена ли защита от удаления. Возвращается: когда состояние равно present Пример: `"True"`
dns_name string	Публичное DNS-имя балансировщика нагрузки. Возвращается: когда состояние равно present Пример: `"internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com"`
idle_timeout_timeout_seconds string	Значение тайм-аута бездействия в секундах. Возвращается: когда состояние равно present Пример: `"60"`
ip_address_type string	Тип IP-адресов, используемых подсетями для балансировщика нагрузки. Возвращается: когда состояние равно present Пример: `"ipv4"`
listeners complex	Информация о прослушивателях. Возвращается: когда состояние равно present
alpn_policy list / elements=string added in community.aws 7.1.0	Имя политики согласования протокола прикладного уровня (ALPN). Возвращается: когда состояние равно present Пример: `["HTTP1Only", "HTTP2Only"]`
certificates complex	Сертификат сервера SSL. Возвращается: когда состояние равно present
certificate_arn string	Универсальное имя ресурса (ARN) сертификата. Возвращается: когда состояние равно present Пример: `""`
default_actions string	Действия по умолчанию для прослушивателя. Возвращается: когда состояние равно present
target_group_arn string	Универсальное имя ресурса (ARN) целевой группы. Возвращается: когда состояние равно present Пример: `""`
type string	Тип действия. Возвращается: когда состояние равно present Пример: `""`
listener_arn string	Универсальное имя ресурса (ARN) прослушивателя. Возвращается: когда состояние равно present Пример: `""`
load_balancer_arn string	Универсальное имя ресурса (ARN) балансировщика нагрузки. Возвращается: когда состояние равно present Пример: `""`

порт целое число	Порт, на котором балансировщик нагрузки прослушивает соединения. Возвращаемое значение: при состоянии present Пример: `80`
протокол строка	Протокол для соединений клиентов с балансировщиком нагрузки. Возвращаемое значение: при состоянии present Пример: `"HTTPS"`
ssl_policy строка	Политика безопасности, определяющая поддерживаемые шифры и протоколы. Возвращаемое значение: при состоянии present Пример: `""`
load_balancer_arn строка	Идентификатор Amazon Resource Name (ARN) балансировщика нагрузки. Возвращаемое значение: при состоянии present Пример: `"arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:loadbalancer/app/my-elb/001122334455"`
load_balancer_name строка	Имя балансировщика нагрузки. Возвращаемое значение: при состоянии present Пример: `"my-elb"`
load_balancing_cross_zone_enabled строка	Указание, включена ли межзонная балансировка нагрузки. Возвращаемое значение: при состоянии present Пример: `"True"`
схема строка	Балансировщик нагрузки, обращённый к интернету или внутренний. Возвращаемое значение: при состоянии present Пример: `"internal"`
состояние словарь	Состояние балансировщика нагрузки. Возвращаемое значение: при состоянии present Пример: `{"code": "active"}`
метки словарь	Метки, прикреплённые к балансировщику нагрузки. Возвращаемое значение: при состоянии present Пример: `{"Tag": "Example"}`
тип строка	Тип балансировщика нагрузки. Возвращаемое значение: при состоянии present Пример: `"network"`
vpc_id строка	Идентификатор VPC для балансировщика нагрузки. Возвращаемое значение: при состоянии present Пример: `"vpc-0011223344"`

Авторы

Rob White (@wimnat)

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

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