community.aws.elb_classic_lb_info модуль — Сбор информации об EC2 Elastic Load Balancers в AWS

Примечание

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

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

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

Для использования в книге задач укажите: community.aws.elb_classic_lb_info.

Новая в community.aws 1.0.0

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

Описание

Сбор информации об EC2 Elastic Load Balancers в AWS

Требования

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

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

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	ID ключа доступа 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 AWS botocore. Псевдоним 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.
debug_botocore_endpoint_logs логический	Использовать `botocore.endpoint` логгер для анализа уникальных (а не всех) `"resource:action"` API-вызовов, выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте `aws_resource_action` обратный вызов для вывода в список всех вызовов, сделанных во время выполнения книги задач. Также может быть использована переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `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.
names список / элементы=строка	Список имен ELB, для которых необходимо собрать информацию. Используйте этот параметр, чтобы собрать информацию о наборе ELB, иначе возвращаются все ELB. По умолчанию: `[]`
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 и security_token.
region псевдонимы: aws_region, ec2_region строка	Регион AWS для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Также могут быть использованы переменные среды `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.
secret_key псевдонимы: 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` в порядке убывания приоритета. Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
session_token псевдонимы: 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` в порядке убывания приоритета. Параметры 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. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.

END_OF_DOCUMENT_MARKER

validate_certs

boolean

При установке в значение false, сертификаты SSL не будут проверяться при общении с API AWS.

Установка validate_certs=false настоятельно не рекомендуется. В качестве альтернативы, рассмотрите установку aws_ca_bundle.

Варианты:

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

Примечания

Примечание

Внимание: Для модулей переменные окружения и конфигурационные файлы читаются из контекста 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.
# Output format tries to match amazon.aws.ec2_elb_lb module input parameters

# Gather information about all ELBs
- community.aws.elb_classic_lb_info:
  register: elb_info

- ansible.builtin.debug:
    msg: "{{ item.dns_name }}"
  loop: "{{ elb_info.elbs }}"

# Gather information about a particular ELB
- community.aws.elb_classic_lb_info:
    names: frontend-prod-elb
  register: elb_info

- ansible.builtin.debug:
    msg: "{{ elb_info.elbs.0.dns_name }}"

# Gather information about a set of ELBs
- community.aws.elb_classic_lb_info:
    names:
      - frontend-prod-elb
      - backend-prod-elb
  register: elb_info

- ansible.builtin.debug:
    msg: "{{ item.dns_name }}"
  loop: "{{ elb_info.elbs }}"

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

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

Ключ	Описание
elbs список / элементы=строка	список балансировщиков нагрузки Возвращается: всегда Пример: {"elbs": [{"attributes": {"access_log": {"enabled": false}, "connection_draining": {"enabled": true, "timeout": 300}, "connection_settings": {"idle_timeout": 60}, "cross_zone_load_balancing": {"enabled": true}}, "availability_zones": ["us-east-1a", "us-east-1b", "us-east-1c", "us-east-1d", "us-east-1e"], "backend_server_description": [], "canonical_hosted_zone_name": "test-lb-XXXXXXXXXXXX.us-east-1.elb.amazonaws.com", "canonical_hosted_zone_name_id": "XXXXXXXXXXXXXX", "created_time": "2017-08-23T18:25:03.280000+00:00", "dns_name": "test-lb-XXXXXXXXXXXX.us-east-1.elb.amazonaws.com", "health_check": {"healthy_threshold": 10, "interval": 30, "target": "HTTP:80/index.html", "timeout": 5, "unhealthy_threshold": 2}, "instances": [], "instances_inservice": [], "instances_inservice_count": 0, "instances_outofservice": [], "instances_outofservice_count": 0, "instances_unknownservice": [], "instances_unknownservice_count": 0, "listener_descriptions": [{"listener": {"instance_port": 80, "instance_protocol": "HTTP", "load_balancer_port": 80, "protocol": "HTTP"}, "policy_names": []}], "load_balancer_name": "test-lb", "policies": {"app_cookie_stickiness_policies": [], "lb_cookie_stickiness_policies": [], "other_policies": []}, "scheme": "internet-facing", "security_groups": ["sg-29d13055"], "source_security_group": {"group_name": "default", "owner_alias": "XXXXXXXXXXXX"}, "subnets": ["subnet-XXXXXXXX", "subnet-XXXXXXXX"], "tags": {}, "vpc_id": "vpc-c248fda4"}]}

Ключ

Описание

elbs

список / элементы=строка

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

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

Пример: {"elbs": [{"attributes": {"access_log": {"enabled": false}, "connection_draining": {"enabled": true, "timeout": 300}, "connection_settings": {"idle_timeout": 60}, "cross_zone_load_balancing": {"enabled": true}}, "availability_zones": ["us-east-1a", "us-east-1b", "us-east-1c", "us-east-1d", "us-east-1e"], "backend_server_description": [], "canonical_hosted_zone_name": "test-lb-XXXXXXXXXXXX.us-east-1.elb.amazonaws.com", "canonical_hosted_zone_name_id": "XXXXXXXXXXXXXX", "created_time": "2017-08-23T18:25:03.280000+00:00", "dns_name": "test-lb-XXXXXXXXXXXX.us-east-1.elb.amazonaws.com", "health_check": {"healthy_threshold": 10, "interval": 30, "target": "HTTP:80/index.html", "timeout": 5, "unhealthy_threshold": 2}, "instances": [], "instances_inservice": [], "instances_inservice_count": 0, "instances_outofservice": [], "instances_outofservice_count": 0, "instances_unknownservice": [], "instances_unknownservice_count": 0, "listener_descriptions": [{"listener": {"instance_port": 80, "instance_protocol": "HTTP", "load_balancer_port": 80, "protocol": "HTTP"}, "policy_names": []}], "load_balancer_name": "test-lb", "policies": {"app_cookie_stickiness_policies": [], "lb_cookie_stickiness_policies": [], "other_policies": []}, "scheme": "internet-facing", "security_groups": ["sg-29d13055"], "source_security_group": {"group_name": "default", "owner_alias": "XXXXXXXXXXXX"}, "subnets": ["subnet-XXXXXXXX", "subnet-XXXXXXXX"], "tags": {}, "vpc_id": "vpc-c248fda4"}]}

Авторы

Michael Schultz (@mjschultz)
Fernando Jose Pando (@nand0p)

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

© 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_classic_lb_info_module.html