Spec-Zone.ru › Ansible

Модуль 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_ID или AWS_ACCESS_KEY в порядке убывания приоритета.

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

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

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.

debug_botocore_endpoint_logs

логическое значение

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

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

Варианты:

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

endpoint_url

псевдоним: aws_endpoint_url

строка

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

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

include_attributes

логическое значение

добавлено в amazon.aws 7.0.0

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

Варианты:

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

include_listener_rules

логическое значение

добавлено в amazon.aws 7.0.0

Указывает, нужно ли включать в ответ правила прослушивателей балансировщика нагрузки.

Подразумевает include_listeners=true

Варианты:

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

include_listeners

логическое значение

добавлено в amazon.aws 7.0.0

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

Варианты:

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

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.

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

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

region

псевдоним: aws_region

строка

Регион AWS, который следует использовать.

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

Также можно использовать переменную среды AWS_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.

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

Параметры 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.

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

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

validate_certs

логическое значение

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

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

Варианты:

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста 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 для журналов доступа.

Возвращается: когда include_attributes=true

Пример: "mys3bucket"

access_logs_s3_enabled

string

Указывает, включено ли хранение журналов доступа в Amazon S3.

Возвращается: когда include_attributes=true

Пример: "true"

access_logs_s3_prefix

string

Префикс пути в бакете S3.

Возвращается: когда include_attributes=true

Пример: "my/logs"

availability_zones

list / elements=dictionary

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

Возвращается: успешно

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

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, связанной с балансировщиком нагрузки.

Возвращается: успешно

Пример: "ABCDEF12345678"

client_keep_alive_seconds

string

Значение времени поддержания соединения с клиентом, в секундах.

Возвращается: когда include_attributes=true

Пример: "3600"

connection_logs_s3_bucket

string

Имя бакета S3 для журналов соединений.

Возвращается: когда include_attributes=true

Пример: ""

connection_logs_s3_enabled

string

Указывает, включено ли ведение журналов соединений.

Возвращается: когда include_attributes=true

Пример: "false"

connection_logs_s3_prefix

string

Префикс пути в бакете S3 для журналов соединений.

Возвращается: когда include_attributes=true

Пример: ""

created_time

string

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

Возвращается: успешно

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

deletion_protection_enabled

string

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

Возвращается: когда include_attributes=true

Пример: "true"

dns_name

string

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

Возвращается: успешно

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

idle_timeout_timeout_seconds

string

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

Возвращается: когда include_attributes=true

Пример: "60"

ip_address_type

string

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

Возвращается: успешно

Пример: "ipv4"

ipv6_deny_all_igw_traffic

string

Блокирует доступ к балансировщику нагрузки через интернет-шлюз (IGW).

Возвращается: когда include_attributes=true

Пример: "false"

listeners

complex

Сведения о прослушивателях.

Возвращается: когда include_listeners=true или include_listener_rules=true

certificates

list / elements=dictionary

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

Возвращается: успешно

certificate_arn

string

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

Возвращается: успешно

Пример: "arn:aws:acm:us-east-1:123456789012:certificate/28d2f3d9-cb2f-4033-a9aa-e75e704125a2"

default_actions

string

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

Возвращается: успешно

Пример: "[{'forward_config': {'target_group_stickiness_config': {'enabled': False}, 'target_groups': [{'target_group_arn': 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/alb-test/bf43c68602c51c02', 'weight': 1}]}, 'target_group_arn': 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/alb-test/bf43c68602c51c02', 'type': 'forward'}]"

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

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

Возвращается: успешно

Пример: 80

protocol

string

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

Возвращается: успешно

Пример: "HTTPS"

rules

list / elements=dictionary

Список правил прослушивателя.

Возвращается: когда include_listener_rules=true

actions

list / elements=dictionary

Действия.

Возвращается: успешно

Пример: [{"forward_config": {"target_group_stickiness_config": {"enabled": false}, "target_groups": [{"target_group_arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/alb-test/09ba111f8079fb83", "weight": 1}]}, "target_group_arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/alb-test/09ba111f8079fb83", "type": "forward"}]

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

Пример: false

priority

string

Приоритет.

Возвращается: success

Пример: "default"

rule_arn

string

Amazon Resource Name (ARN) правила.

Возвращается: success

Пример: ""

ssl_policy

string

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

Возвращается: success

Пример: "ELBSecurityPolicy-2016-08"

load_balancer_arn

string

Amazon Resource Name (ARN) балансировщика нагрузки.

Возвращается: success

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

load_balancer_name

string

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

Возвращается: success

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

load_balancing_cross_zone_enabled

string

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

Возвращается: когда include_attributes=true

Пример: "true"

routing_http2_enabled

string

Указывает, включен ли HTTP/2.

Возвращается: когда include_attributes=true

Пример: "true"

routing_http_desync_mitigation_mode

string

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

Возвращается: когда include_attributes=true

Пример: "defensive"

routing_http_drop_invalid_header_fields_enabled

string

Указывает, удаляет ли балансировщик нагрузки HTTP-заголовки с недопустимыми полями заголовков (true) или передает их целевым объектам (false).

Возвращается: когда include_attributes=true

Пример: "false"

routing_http_preserve_host_header_enabled

string

Указывает, следует ли Application Load Balancer сохранять заголовок Host в HTTP-запросе и передавать его целевому объекту без изменений.

Возвращается: когда include_attributes=true

Пример: "false"

routing_http_x_amzn_tls_version_and_cipher_suite_enabled

string

Указывает, добавляются ли два заголовка в запрос клиента перед его отправкой целевому объекту.

Возвращается: когда include_attributes=true

Пример: "false"

routing_http_xff_client_port_enabled

string

Указывает, должен ли заголовок X-Forwarded-For сохранять исходный порт, который клиент использовал для подключения к балансировщику нагрузки.

Возвращается: когда include_attributes=true

Пример: "false"

routing_http_xff_header_processing_mode

string

Позволяет изменить, сохранить или удалить заголовок X-Forwarded-For в HTTP-запросе до того, как Application Load Balancer отправит запрос целевому объекту.

Возвращается: когда include_attributes=true

Пример: "append"

scheme

string

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

Возвращается: success

Пример: "internal"

security_groups

list / elements=string

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

Возвращается: success

Пример: ["sg-0011223344"]

state

dictionary

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

Возвращается: success

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

code

string

Код состояния.

Возвращается: success

reason

string

Описание состояния.

Возвращается: при наличии

tags

dictionary

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

Возвращается: success

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

type

string

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

Возвращается: success

Пример: "application"

vpc_id

string

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

Возвращается: success

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

waf_fail_open_enabled

string

Указывает, разрешено ли балансировщику нагрузки с включенным AWS WAF направлять запросы целевым объектам, если он не может переслать запрос в AWS WAF.

Возвращается: когда include_attributes=true

Пример: "false"

Авторы

  • 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/amazon/aws/elb_application_lb_info_module.html

Spec-Zone.ru

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