Spec-Zone.ru › Ansible

Модуль community.aws.elb_target_group_info — сбор информации о целевых группах ELB в AWS

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.aws.elb_target_group_info.

Добавлено в community.aws 1.0.0

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

Краткое описание

  • Сбор информации о целевых группах ELB в AWS

Требования

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

  • python >= 3.6
  • boto3 >= 1.34.0
  • botocore >= 1.34.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 botocore SDK.

aws_ca_bundle

путь

Путь к пакету сертификатов центра сертификации, используемому для проверки SSL-сертификатов.

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

aws_config

словарь

Словарь для изменения конфигурации botocore.

Описание параметров доступно в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

collect_targets_health

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

Если задано значение True, вывод содержит описание состояния целевых объектов.

Варианты:

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

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.

load_balancer_arn

строка

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

names

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

Имена целевых групп.

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 botocore SDK.

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 несовместимы.

target_group_arns

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

Amazon Resource Names (ARN) целевых групп.

validate_certs

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

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

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

Варианты:

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

Примечания

Примечание

  • Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста «host» Ansible, а не из контекста «controller». Поэтому может потребоваться явно скопировать файлы на «host». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «controller» Ansible, а не из контекста «host».
  • Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «host» 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 target groups
  community.aws.elb_target_group_info:

- name: Gather information about the target group attached to a particular ELB
  community.aws.elb_target_group_info:
    load_balancer_arn: "arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:loadbalancer/app/my-elb/aabbccddeeff"

- name: Gather information about a target groups named 'tg1' and 'tg2'
  community.aws.elb_target_group_info:
    names:
      - tg1
      - tg2

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

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

Ключ

Описание

target_groups

complex

список целевых групп

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

deregistration_delay_timeout_seconds

integer

Время ожидания Elastic Load Balancing перед изменением состояния отменяемой регистрации целевого объекта с «выводится из эксплуатации» на «не используется».

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

Пример: 300

health_check_interval_seconds

integer

Приблизительный интервал в секундах между проверками состояния отдельного целевого объекта.

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

Пример: 30

health_check_path

string

Путь назначения для запроса проверки состояния.

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

Пример: "/index.html"

health_check_port

string

Порт для подключения к целевому объекту.

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

Пример: "traffic-port"

health_check_protocol

string

Протокол для подключения к целевому объекту.

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

Пример: "HTTP"

health_check_timeout_seconds

integer

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

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

Пример: 5

healthy_threshold_count

integer

Количество успешных проверок состояния подряд, необходимое для того, чтобы считать нездоровый целевой объект здоровым.

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

Пример: 5

load_balancer_arns

list / elements=string

Amazon Resource Names (ARN) балансировщиков нагрузки, направляющих трафик в эту целевую группу.

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

Пример: []

matcher

dictionary

Коды HTTP, используемые для проверки успешного ответа целевого объекта.

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

Пример: {"http_code": "200"}

port

integer

Порт, на котором ожидают подключения целевые объекты.

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

Пример: 80

protocol

string

Протокол, используемый для маршрутизации трафика к целевым объектам.

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

Пример: "HTTP"

stickiness_enabled

boolean

Указывает, включены ли закреплённые сеансы.

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

Пример: true

stickiness_lb_cookie_duration_seconds

integer

Указывает, включены ли закреплённые сеансы.

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

Пример: 86400

stickiness_type

string

Тип закреплённых сеансов.

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

Пример: "lb_cookie"

tags

dictionary

Теги, присвоенные целевой группе.

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

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

target_group_arn

string

Amazon Resource Name (ARN) целевой группы.

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

Пример: "arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:targetgroup/mytargetgroup/aabbccddee0044332211"

target_group_name

string

Имя целевой группы.

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

Пример: "mytargetgroup"

targets_health_description

complex

Описание состояния целевых объектов.

Возвращается: если включён параметр collect_targets_health

health_check_port

string

Порт для проверки состояния целевого объекта.

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

Пример: "80"

target

complex

Метаданные целевого объекта.

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

id

string

Идентификатор целевого объекта.

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

Пример: "i-0123456789"

port

integer

Порт для подключения к целевому объекту.

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

Пример: 80

target_health

complex

Состояние целевого объекта.

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

state

string

Состояние целевого объекта.

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

Пример: "healthy"

unhealthy_threshold_count

integer

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

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

Пример: 2

vpc_id

string

Идентификатор VPC целевых объектов.

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

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

Авторы

  • 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/community/aws/elb_target_group_info_module.html

Spec-Zone.ru

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