Spec-Zone.ru › Ansible 2.10

community.aws.elb_application_lb_info – Сбор информации об Application ELB в AWS

Примечание

Этот плагин входит в состав коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач укажите: 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 для проверки 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_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода в полный список, созданный во время выполнения книги задач. Переменная окружения 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. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Если задан параметр profile, этот параметр игнорируется.
Передача параметров security_token и profile одновременно устарела и эти параметры будут взаимоисключающими после 2022-06-01.

псевдонимы: aws_security_token, access_token
validate_certs
булево
    Варианты:
  • нет
  • да ←
Если установлено в «нет», для версий boto >= 2.6.0 SSL-сертификаты не будут проверены.

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета 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


Авторы

  • Rob White (@wimnat)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/elb_application_lb_info_module.html

Spec-Zone.ru

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