community.aws.elb_application_lb_info – Сбор информации об Application ELB в AWS
Примечание
Этот плагин входит в состав коллекции community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Для использования в playbook, укажите: community.aws.elb_application_lb_info.
Новое в версии 1.0.0: из community.aws
Описание
- Сбор информации об Application ELB в AWS
- Этот модуль назывался
elb_application_lb_factsдо Ansible 2.9. Способ использования не изменился.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_access_key и profile одновременно устарела и будет сделана взаимно исключающей после 2022-06-01. псевдонимы: ec2_access_key, access_key | |
| aws_ca_bundle путь | Расположение файла с корневыми сертификатами (CA Bundle), используемого для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: CA Bundle читается со стороны модуля и, возможно, необходимо явно скопировать его с контроллера, если модуль не выполняется локально. | |
| aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Более подробную информацию о конфигурации boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto. | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_secret_key и profile одновременно устарела и будет сделана взаимно исключающей после 2022-06-01. псевдонимы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs логический тип |
| Использовать логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов "resource:action", сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время выполнения playbook. Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована. |
| ec2_url строка | URL для подключения к EC2 или вашей облачной платформе Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url | |
| load_balancer_arns список / элементы=строка | Amazon Resource Names (ARN) нагрузочных балансировщиков. Вы можете указать до 20 нагрузочных балансировщиков в одном вызове. | |
| names список / элементы=строка | Имена нагрузочных балансировщиков. | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределит aws_access_key, aws_secret_key и security_token, и поддержка их передачи одновременно с profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимно исключающими с profile после 2022-06-01. псевдонимы: aws_profile | |
| region строка | AWS-регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| security_token строка | AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела и будет сделана взаимно исключающей после 2022-06-01. псевдонимы: aws_security_token, access_token | |
| validate_certs логический тип |
| Если установлено значение "нет", SSL-сертификаты не будут проверяться для версий boto >= 2.6.0. |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_PROFILEилиAWS_DEFAULT_PROFILE,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION,AWS_CA_BUNDLE - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания AWS-региона, когда это необходимо, но это также можно настроить в конфигурационном файле boto
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Gather information about all target groups
community.aws.elb_application_lb_info:
- name: Gather information about the target group attached to a particular ELB
community.aws.elb_application_lb_info:
load_balancer_arns:
- "arn:aws:elasticloadbalancing:ap-southeast-2:001122334455:loadbalancer/app/my-elb/aabbccddeeff"
- name: Gather information about a target groups named 'tg1' and 'tg2'
community.aws.elb_application_lb_info:
names:
- elb1
- elb2
- name: Gather information about specific ALB
community.aws.elb_application_lb_info:
names: "alb-name"
region: "aws-region"
register: alb_info
- ansible.builtin.debug:
var: alb_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| load_balancers сложный тип | всегда | список балансировщиков нагрузки | |
| access_logs_s3_bucket строка | при наличии статуса | Имя ведра S3 для журналов доступа. Пример: mys3bucket | |
| access_logs_s3_enabled строка | при наличии статуса | Указывает, включены ли журналы доступа, хранящиеся в Amazon S3. Пример: True | |
| access_logs_s3_prefix строка | при наличии статуса | Префикс для расположения в ведре S3. Пример: /my/logs | |
| availability_zones список / элементы=строка | при наличии статуса | Зоны доступности для балансировщика нагрузки. Пример: [{'subnet_id': 'subnet-aabbccddff', 'zone_name': 'ap-southeast-2a'}] | |
| canonical_hosted_zone_id строка | при наличии статуса | Идентификатор зоны Amazon Route 53, связанной с балансировщиком нагрузки. Пример: ABCDEF12345678 | |
| created_time строка | при наличии статуса | Дата и время создания балансировщика нагрузки. Пример: 2015-02-12T02:14:02+00:00 | |
| deletion_protection_enabled строка | при наличии статуса | Указывает, включена ли защита от удаления. Пример: True | |
| dns_name строка | при наличии статуса | Общедоступное имя DNS балансировщика нагрузки. Пример: internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com | |
| idle_timeout_timeout_seconds строка | при наличии статуса | Значение таймаута бездействия в секундах. Пример: 60 | |
| ip_address_type строка | при наличии статуса | Тип IP-адресов, используемых подсетями для балансировщика нагрузки. Пример: ipv4 | |
| load_balancer_arn строка | при наличии статуса | Amazon Resource Name (ARN) балансировщика нагрузки. Пример: arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-elb/001122334455 | |
| load_balancer_name строка | при наличии статуса | Имя балансировщика нагрузки. Пример: my-elb | |
| scheme строка | при наличии статуса | Интернет-ориентированный или внутренний балансировщик нагрузки. Пример: internal | |
| security_groups список / элементы=строка | при наличии статуса | Идентификаторы групп безопасности для балансировщика нагрузки. Пример: ['sg-0011223344'] | |
| state словарь | при наличии статуса | Состояние балансировщика нагрузки. Пример: {'code': 'active'} | |
| tags словарь | при наличии статуса | Теги, прикрепленные к балансировщику нагрузки. Пример: { 'Tag': 'Пример' } | |
| type строка | при наличии статуса | Тип балансировщика нагрузки. Пример: application | |
| vpc_id строка | при наличии статуса | Идентификатор VPC для балансировщика нагрузки. Пример: vpc-0011223344 | |
Авторы
- Роб Уайт (@wimnat)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/elb_application_lb_info_module.html