Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции community.aws (версия 8.0.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.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

Идентификатор ключа доступа 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 для обеспечения согласованности с AWS botocore SDK.

Псевдоним ec2_access_key устарел и будет удален в версии после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в версии после 2024-12-01.

aws_ca_bundle

path

Расположение пакета CA, используемого при проверке SSL-сертификатов.

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

aws_config

dictionary

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

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

collect_targets_health

boolean

При установке в значение True, вывод содержит описание работоспособности целей

Варианты:

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

debug_botocore_endpoint_logs

boolean

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

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

Варианты:

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

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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

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

Псевдонимы ec2_url и s3_url устарели и будут удалены в версии после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в версии после 2024-12-01.

load_balancer_arn

string

Универсальное имя ресурса (ARN) балансировщика нагрузки.

names

list / elements=string

Названия целевых групп.

profile

aliases: aws_profile

string

Именованный профиль 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

aliases: aws_region, ec2_region

string

Используемый регион 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

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

Секретный ключ доступа 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 для обеспечения согласованности с AWS botocore SDK.

Псевдоним ec2_secret_key устарел и будет удален в версии после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в версии после 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

Токен сеанса AWS STS для использования с временными учетными данными.

Дополнительную информацию об access токенах см. в документации 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.

target_group_arns

list / elements=string

Имена ресурсов Amazon (ARN) целевых групп.

validate_certs

boolean

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

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

Варианты:

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

Примечания

Примечание

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

Универсальные имена ресурсов (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 (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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/elb_target_group_info_module.html

Spec-Zone.ru

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