amazon.aws.elb_application_lb_info модуль — Сбор информации об Application Load Balancers в AWS
Примечание
Этот модуль является частью коллекции amazon.aws (версия 8.2.1).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля потребуются дополнительные требования, см. Требования для получения подробностей.
Для использования в плейбуке укажите: amazon.aws.elb_application_lb_info.
Добавлена в amazon.aws 5.0.0
Описание
- Сбор информации об Application Load Balancers в AWS.
- Этот модуль был первоначально добавлен в
community.awsв релизе 1.0.0.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key aliases: aws_access_key_id, aws_access_key, ec2_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 и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в версии 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в выпуске после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle path | Расположение пакета CA, используемого при проверке сертификатов SSL. Переменная среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs boolean | Использовать Переменная среды Варианты:
|
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string | URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в выпуске после 2024-12-01. Поддержка переменной среды |
include_attributes boolean добавлено в amazon.aws 7.0.0 | Включать ли атрибуты балансировщика нагрузки в ответ. Варианты:
|
include_listener_rules boolean добавлено в amazon.aws 7.0.0 | Включать ли правила прослушивателей балансировщика нагрузки в ответ. Подразумевает Варианты:
|
include_listeners boolean добавлено в amazon.aws 7.0.0 | Включать ли прослушиватели балансировщика нагрузки в ответ. Варианты:
|
load_balancer_arns list / elements=string | Универсальные имена ресурсов (ARN) балансировщиков нагрузки. Вы можете указать до 20 балансировщиков нагрузки в одном вызове. |
names list / elements=string | Имена балансировщиков нагрузки. |
profile aliases: aws_profile string | Именованный профиль AWS для использования для аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Переменная среды Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token. |
region aliases: aws_region, ec2_region string | Регион AWS для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Переменные среды См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string | Секретный ключ доступа 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 для согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string | Токен сессии AWS STS для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации о маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды |
validate_certs boolean | При установке в Установка validate_certs=false категорически не рекомендуется. В качестве альтернативы, рассмотрите настройку aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста хоста 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: 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 | |
|
access_logs_s3_enabled string |
Указывает, включены ли логи доступа, хранящиеся в Amazon S3. Возвращается: когда Пример: |
|
access_logs_s3_prefix string |
Префикс для местоположения в корзине S3. Возвращается: когда Пример: |
|
availability_zones list / elements=dictionary |
Зоны доступности для балансировщика нагрузки. Возвращается: успех Пример: |
|
load_balancer_addresses list / elements=dictionary |
Информация о статических IP-адресах для балансировщика нагрузки. Возвращается: успех |
|
allocation_id string |
ID выделения Elastic IP-адреса для внутреннего балансировщика нагрузки. Возвращается: успех |
|
ip_address string |
Статический IP-адрес. Возвращается: успех |
|
ipv6_address string |
IPv6-адрес. Возвращается: успех |
|
private_ipv4_address string |
Приватный IPv4-адрес для внутреннего балансировщика нагрузки. Возвращается: успех |
|
subnet_id string |
ID подсети. Возвращается: успех |
|
zone_name string |
Имя зоны доступности. Возвращается: успех |
|
canonical_hosted_zone_id string |
ID хостинговой зоны Amazon Route 53, связанной с балансировщиком нагрузки. Возвращается: успех Пример: |
|
created_time string |
Дата и время создания балансировщика нагрузки. Возвращается: успех Пример: |
|
deletion_protection_enabled boolean | |
|
dns_name string |
Публичное DNS-имя балансировщика нагрузки. Возвращается: успех Пример: |
|
idle_timeout_timeout_seconds integer |
|
ip_address_type string |
Тип IP-адресов, используемых подсетями для балансировщика нагрузки. Возвращается: success Пример: |
|
listeners complex |
Информация о прослушивателях. Возвращается: when |
|
certificates list / elements=dictionary |
Сертификат сервера SSL. Возвращается: success |
|
certificate_arn string |
Универсальное имя ресурса (ARN) сертификата. Возвращается: success Пример: |
|
default_actions string |
Действия по умолчанию для прослушивателя. Возвращается: success Пример: |
|
forward_config dictionary |
Информация для создания действия, распределяющего запросы между одной или несколькими целевыми группами. Возвращается: success |
|
target_group_stickiness_config dictionary |
Прилипание целевой группы для правила. Возвращается: success |
|
enabled boolean |
Указывает, включено ли прилипание целевой группы. Возвращается: success |
|
target_groups dictionary |
Целевые группы. Возвращается: success |
|
target_groups string |
Универсальное имя ресурса (ARN) целевой группы. Возвращается: success |
|
weight integer |
Вес. Возвращается: success |
|
target_group_arn string |
Универсальное имя ресурса (ARN) целевой группы. Возвращается: success |
|
type string |
Тип действия. Возвращается: success |
|
listener_arn string |
Универсальное имя ресурса (ARN) прослушивателя. Возвращается: success Пример: |
|
load_balancer_arn string |
Универсальное имя ресурса (ARN) балансировщика нагрузки. Возвращается: success Пример: |
|
port integer |
Порт, на котором прослушивает балансировщик нагрузки. Возвращается: success Пример: |
|
protocol string |
Протокол для соединений от клиентов к балансировщику нагрузки. Возвращается: success Пример: |
|
rules list / elements=dictionary |
Список правил прослушивателя. Возвращается: when |
|
actions список / элементы=словарь |
Действия. Возвращается при: успехе Пример: |
|
forward_config словарь |
Информация для создания действия, распределяющего запросы между одной или несколькими целевыми группами. Возвращается при: успехе |
|
target_group_stickiness_config словарь |
Привязка к целевой группе для правила. Возвращается при: успехе |
|
enabled булево |
Указывает, включена ли привязка к целевой группе. Возвращается при: успехе |
|
target_groups словарь |
Целевые группы. Возвращается при: успехе |
|
target_group_arn строка |
Amazon Resource Name (ARN) целевой группы. Возвращается при: успехе |
|
weight целое число |
Вес. Возвращается при: успехе |
|
target_group_arn строка |
Amazon Resource Name (ARN) целевой группы. Возвращается при: успехе |
|
type строка |
Тип действия. Возвращается при: успехе |
|
conditions список / элементы=строка |
Условия. Возвращается при: успехе Пример: |
|
is_default булево |
Указывает, является ли это правилом по умолчанию. Возвращается при: успехе Пример: |
|
priority строка |
Приоритет. Возвращается при: успехе Пример: |
|
rule_arn строка |
Amazon Resource Name (ARN) правила. Возвращается при: успехе Пример: |
|
ssl_policy строка |
Политика безопасности, определяющая поддерживаемые шифры и протоколы. Возвращается при: успехе Пример: |
|
load_balancer_arn строка |
Amazon Resource Name (ARN) балансировщика нагрузки. Возвращается при: успехе Пример: |
|
load_balancer_name строка |
Название балансировщика нагрузки. Возвращается при: успехе Пример: |
|
load_balancing_cross_zone_enabled строка |
Указывает, включено ли межзонное распределение нагрузки. Возвращается при: когда Пример: |
|
routing_http2_enabled строка |
|
routing_http_desync_mitigation_mode string |
Определяет, как балансировщик нагрузки обрабатывает запросы, которые могут представлять угрозу безопасности для приложения. Возвращается: when Пример: |
|
routing_http_drop_invalid_header_fields_enabled string |
Указывает, удаляются ли балансировщиком нагрузки HTTP-заголовки с недопустимыми полями заголовков (true) или маршрутизируются к целям (false). Возвращается: when Пример: |
|
routing_http_x_amzn_tls_version_and_cipher_suite_enabled string |
Указывает, добавляются ли два заголовка к запросу клиента перед отправкой его к цели. Возвращается: when Пример: |
|
routing_http_xff_client_port_enabled string |
Указывает, должен ли заголовок X-Forwarded-For сохранять исходный порт, который клиент использовал для подключения к балансировщику нагрузки. Возвращается: when Пример: |
|
scheme string |
Балансировщик нагрузки, ориентированный на Интернет или внутренний. Возвращается: success Пример: |
|
security_groups list / elements=string |
Идентификаторы групп безопасности для балансировщика нагрузки. Возвращается: success Пример: |
|
state dictionary |
Состояние балансировщика нагрузки. Возвращается: success Пример: |
|
code string |
Код состояния. Возвращается: success |
|
reason string |
Описание состояния. Возвращается: when available |
|
tags dictionary |
Теги, прикрепленные к балансировщику нагрузки. Возвращается: success Пример: |
|
type string |
Тип балансировщика нагрузки. Возвращается: success Пример: |
|
vpc_id string |
Идентификатор VPC для балансировщика нагрузки. Возвращается: success Пример: |
|
waf_fail_open_enabled string |
Указывает, разрешать ли балансировщику нагрузки с поддержкой AWS WAF маршрутизацию запросов к целям, если он не может переслать запрос в AWS WAF. Возвращается: when Пример: |
Ссылки на коллекцию
© 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/amazon/aws/elb_application_lb_info_module.html