Модуль amazon.aws.elb_application_lb_info — сбор информации о балансировщиках нагрузки приложений в AWS
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для работы с этим модулем могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: amazon.aws.elb_application_lb_info.
Добавлено в amazon.aws 5.0.0
Краткое описание
- Сбор информации о балансировщиках нагрузки приложений в AWS.
- Этот модуль был впервые добавлен в
community.awsв выпуске 1.0.0.
Требования
Перечисленные ниже компоненты должны быть установлены на хосте, где выполняется модуль.
- python >= 3.6
- boto3 >= 1.35.0
- botocore >= 1.35.0
Параметры
Параметр | Описание |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_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 и profile нельзя использовать одновременно. Псевдоним aws_access_key_id был добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore. |
aws_ca_bundle путь | Путь к набору сертификатов CA, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды |
aws_config словарь | Словарь для изменения конфигурации botocore. Описание параметров приведено в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs логическое значение | Использовать регистратор Также можно использовать переменную среды Варианты:
|
endpoint_url псевдоним: aws_endpoint_url строка | URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws проверяются только с AWS. Также можно использовать переменную среды |
include_attributes логическое значение добавлено в amazon.aws 7.0.0 | Указывает, нужно ли включать в ответ атрибуты балансировщика нагрузки. Варианты:
|
include_listener_rules логическое значение добавлено в amazon.aws 7.0.0 | Указывает, нужно ли включать в ответ правила прослушивателей балансировщика нагрузки. Подразумевает Варианты:
|
include_listeners логическое значение добавлено в amazon.aws 7.0.0 | Указывает, нужно ли включать в ответ прослушиватели балансировщика нагрузки. Варианты:
|
load_balancer_arns список / элементы типа string | Имена ресурсов Amazon (ARN) балансировщиков нагрузки. За один вызов можно указать не более 20 балансировщиков нагрузки. |
names список / элементы типа string | Имена балансировщиков нагрузки. |
profile псевдоним: aws_profile строка | Именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile нельзя использовать одновременно с параметрами aws_access_key, aws_secret_key и session_token. |
region псевдоним: aws_region строка | Регион AWS, который следует использовать. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка | Секретный ключ доступа AWS. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры secret_key и profile нельзя использовать одновременно. Псевдоним aws_secret_access_key был добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore. |
session_token псевдоним: aws_session_token строка | Токен сеанса AWS STS для временных учетных данных. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды Параметры session_token и profile нельзя использовать одновременно. |
validate_certs логическое значение | Если установлено значение Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста 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: Gather information about all ALBs
amazon.aws.elb_application_lb_info:
# Equivalent to aws elbv2 describe-load-balancers
- name: Gather minimal information about all ALBs
amazon.aws.elb_application_lb_info:
include_attributes: false
include_listeners: false
include_listener_rules: false
- name: Gather information about a particular ALB given its ARN
amazon.aws.elb_application_lb_info:
load_balancer_arns:
- "arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:loadbalancer/app/my-alb/aabbccddeeff"
- name: Gather information about ALBs named 'alb1' and 'alb2'
amazon.aws.elb_application_lb_info:
names:
- alb1
- alb2
- name: Gather information about specific ALB
amazon.aws.elb_application_lb_info:
names: "alb-name"
region: "aws-region"
register: alb_info
- ansible.builtin.debug:
var: alb_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
load_balancers complex | Список балансировщиков нагрузки. Возвращается: всегда |
|
access_logs_s3_bucket string |
Имя бакета S3 для журналов доступа. Возвращается: когда Пример: |
|
access_logs_s3_enabled string |
Указывает, включено ли хранение журналов доступа в Amazon S3. Возвращается: когда Пример: |
|
access_logs_s3_prefix string | |
|
availability_zones list / elements=dictionary |
Зоны доступности для балансировщика нагрузки. Возвращается: успешно Пример: |
|
load_balancer_addresses list / elements=dictionary |
Сведения о статических IP-адресах балансировщика нагрузки. Возвращается: успешно |
|
allocation_id string |
Идентификатор выделения эластичного IP-адреса для внутреннего балансировщика нагрузки. Возвращается: успешно |
|
ip_address string |
Статический IP-адрес. Возвращается: успешно |
|
ipv6_address string |
IPv6-адрес. Возвращается: успешно |
|
private_ipv4_address string |
Частный IPv4-адрес внутреннего балансировщика нагрузки. Возвращается: успешно |
|
subnet_id string |
Идентификатор подсети. Возвращается: успешно |
|
zone_name string |
Название зоны доступности. Возвращается: успешно |
|
canonical_hosted_zone_id string |
Идентификатор размещённой зоны Amazon Route 53, связанной с балансировщиком нагрузки. Возвращается: успешно Пример: |
|
client_keep_alive_seconds string |
Значение времени поддержания соединения с клиентом, в секундах. Возвращается: когда Пример: |
|
connection_logs_s3_bucket string | |
|
connection_logs_s3_enabled string |
Указывает, включено ли ведение журналов соединений. Возвращается: когда Пример: |
|
connection_logs_s3_prefix string |
Префикс пути в бакете S3 для журналов соединений. Возвращается: когда Пример: |
|
created_time string |
Дата и время создания балансировщика нагрузки. Возвращается: успешно Пример: |
|
deletion_protection_enabled string |
Указывает, включена ли защита от удаления. Возвращается: когда Пример: |
|
dns_name string |
Общедоступное DNS-имя балансировщика нагрузки. Возвращается: успешно Пример: |
|
idle_timeout_timeout_seconds string | |
|
ip_address_type string |
Тип IP-адресов, используемых подсетями балансировщика нагрузки. Возвращается: успешно Пример: |
|
ipv6_deny_all_igw_traffic string |
Блокирует доступ к балансировщику нагрузки через интернет-шлюз (IGW). Возвращается: когда Пример: |
|
listeners complex |
Сведения о прослушивателях. Возвращается: когда |
|
certificates list / elements=dictionary |
Сертификат SSL-сервера. Возвращается: успешно |
|
certificate_arn string |
Имя ресурса Amazon (ARN) сертификата. Возвращается: успешно Пример: |
|
default_actions string |
Действия по умолчанию для прослушивателя. Возвращается: успешно Пример: |
|
forward_config dictionary |
Сведения для создания действия, распределяющего запросы между одной или несколькими целевыми группами. Возвращается: успешно |
|
target_group_stickiness_config dictionary |
Настройки привязки к целевой группе для правила. Возвращается: успешно |
|
enabled boolean |
Указывает, включена ли привязка к целевой группе. Возвращается: успешно |
|
target_groups dictionary |
Целевые группы. Возвращается: успешно |
|
target_groups string |
Имя ресурса Amazon (ARN) целевой группы. Возвращается: успешно |
|
weight integer |
Вес. Возвращается: успешно |
|
target_group_arn string |
Имя ресурса Amazon (ARN) целевой группы. Возвращается: успешно |
|
type string |
Тип действия. Возвращается: успешно |
|
listener_arn string |
Имя ресурса Amazon (ARN) прослушивателя. Возвращается: успешно Пример: |
|
load_balancer_arn string |
Имя ресурса Amazon (ARN) балансировщика нагрузки. Возвращается: успешно Пример: |
|
port integer |
Порт, на котором прослушиватель балансировщика нагрузки ожидает соединения. Возвращается: успешно Пример: |
|
protocol string |
Протокол соединений между клиентами и балансировщиком нагрузки. Возвращается: успешно Пример: |
|
rules list / elements=dictionary |
Список правил прослушивателя. Возвращается: когда |
|
actions list / elements=dictionary |
Действия. Возвращается: успешно Пример: |
|
forward_config dictionary |
Сведения для создания действия, распределяющего запросы между одной или несколькими целевыми группами. Возвращается: успешно |
|
target_group_stickiness_config dictionary |
Настройки привязки к целевой группе для правила. Возвращается: успешно |
|
enabled boolean |
Указывает, включена ли привязка к целевой группе. Возвращается: успешно |
|
target_groups dictionary |
Целевые группы. Возвращается: успешно |
|
target_group_arn string |
Имя ресурса Amazon (ARN) целевой группы. Возвращается: успешно |
|
weight integer |
Вес. Возвращается: успешно |
|
target_group_arn string |
Имя ресурса Amazon (ARN) целевой группы. Возвращается: успешно |
|
type string |
Тип действия. Возвращается: успешно |
|
conditions list / elements=string |
Условия. Возвращается: success Пример: |
|
is_default boolean |
Указывает, является ли это правило правилом по умолчанию. Возвращается: success Пример: |
|
priority string |
Приоритет. Возвращается: success Пример: |
|
rule_arn string |
Amazon Resource Name (ARN) правила. Возвращается: success Пример: |
|
ssl_policy string |
Политика безопасности, определяющая поддерживаемые шифры и протоколы. Возвращается: success Пример: |
|
load_balancer_arn string |
Amazon Resource Name (ARN) балансировщика нагрузки. Возвращается: success Пример: |
|
load_balancer_name string |
Имя балансировщика нагрузки. Возвращается: success Пример: |
|
load_balancing_cross_zone_enabled string |
Указывает, включена ли межзональная балансировка нагрузки. Возвращается: когда Пример: |
|
routing_http2_enabled string | |
|
routing_http_desync_mitigation_mode string |
Определяет, как балансировщик нагрузки обрабатывает запросы, которые могут представлять угрозу безопасности приложения. Возвращается: когда Пример: |
|
routing_http_drop_invalid_header_fields_enabled string |
Указывает, удаляет ли балансировщик нагрузки HTTP-заголовки с недопустимыми полями заголовков (true) или передает их целевым объектам (false). Возвращается: когда Пример: |
|
routing_http_preserve_host_header_enabled string |
Указывает, следует ли Application Load Balancer сохранять заголовок Host в HTTP-запросе и передавать его целевому объекту без изменений. Возвращается: когда Пример: |
|
routing_http_x_amzn_tls_version_and_cipher_suite_enabled string |
Указывает, добавляются ли два заголовка в запрос клиента перед его отправкой целевому объекту. Возвращается: когда Пример: |
|
routing_http_xff_client_port_enabled string |
Указывает, должен ли заголовок X-Forwarded-For сохранять исходный порт, который клиент использовал для подключения к балансировщику нагрузки. Возвращается: когда Пример: |
|
routing_http_xff_header_processing_mode string |
Позволяет изменить, сохранить или удалить заголовок X-Forwarded-For в HTTP-запросе до того, как Application Load Balancer отправит запрос целевому объекту. Возвращается: когда Пример: |
|
scheme string |
Балансировщик нагрузки, доступный из Интернета, или внутренний балансировщик нагрузки. Возвращается: success Пример: |
|
security_groups list / elements=string |
Идентификаторы групп безопасности балансировщика нагрузки. Возвращается: success Пример: |
|
state dictionary |
Состояние балансировщика нагрузки. Возвращается: success Пример: |
|
code string |
Код состояния. Возвращается: success |
|
reason string |
Описание состояния. Возвращается: при наличии |
|
tags dictionary |
Теги, назначенные балансировщику нагрузки. Возвращается: success Пример: |
|
type string |
Тип балансировщика нагрузки. Возвращается: success Пример: |
|
vpc_id string |
Идентификатор VPC балансировщика нагрузки. Возвращается: success Пример: |
|
waf_fail_open_enabled string |
Указывает, разрешено ли балансировщику нагрузки с включенным AWS WAF направлять запросы целевым объектам, если он не может переслать запрос в AWS WAF. Возвращается: когда Пример: |
Ссылки на коллекцию
© 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/amazon/aws/elb_application_lb_info_module.html