elb_target_group_facts – Сбор фактов о целевых группах ELB в AWS
Новая версия 2.4.
Обзор
- Сбор фактов о целевых группах ELB в AWS
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | |
| collect_targets_health логическое значение добавлен в 2.8 |
| При значении "да" вывод содержит описание состояния целевых узлов. |
| debug_botocore_endpoint_logs логическое значение добавлен в 2.8 |
| Использовать логирования botocore.endpoint для анализа уникальных (а не общих) вызовов API «ресурс:действие» во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action, чтобы вывести полный список, сделанный во время выполнения плейбука. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть. | |
| load_balancer_arn - | Amazon Resource Name (ARN) балансировщика нагрузки. | |
| names - | Имена целевых групп. | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| 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. псевдонимы: access_token | |
| target_group_arns - | Amazon Resource Names (ARN) целевых групп. | |
| validate_certs логическое значение |
| При значении "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
Примечания
Примечание
- Если параметры не заданы в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,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 - 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.
# Gather facts about all target groups
- elb_target_group_facts:
# Gather facts about the target group attached to a particular ELB
- elb_target_group_facts:
load_balancer_arn: "arn:aws:elasticloadbalancing:ap-southeast-2:001122334455:loadbalancer/app/my-elb/aabbccddeeff"
# Gather facts about a target groups named 'tg1' and 'tg2'
- elb_target_group_facts:
names:
- tg1
- tg2
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| target_groups complex | всегда | список целевых групп | |||
| deregistration_delay_timeout_seconds целое число | всегда | Время, в секундах, которое Elastic Load Balancing ожидает, прежде чем изменить состояние удаляемого целевого сервера с состояния «ожидание» на «не используется». Пример: 300 | |||
| health_check_interval_seconds целое число | всегда | Приблизительное время, в секундах, между проверками работоспособности отдельного целевого сервера. Пример: 30 | |||
| health_check_path строка | всегда | Место назначения запроса проверки работоспособности. Пример: /index.html | |||
| health_check_port строка | всегда | Порт для подключения к целевому серверу. Пример: traffic-port | |||
| health_check_protocol строка | всегда | Протокол для подключения к целевому серверу. Пример: HTTP | |||
| health_check_timeout_seconds целое число | всегда | Время, в секундах, в течение которого отсутствие ответа означает неудачную проверку работоспособности. Пример: 5 | |||
| healthy_threshold_count целое число | всегда | Количество последовательных успешных проверок работоспособности, необходимых для того, чтобы считать неработоспособный целевой сервер работоспособным. Пример: 5 | |||
| load_balancer_arns список | всегда | Имена Amazon Resource Names (ARN) балансировщиков нагрузки, которые направляют трафик в эту целевую группу. | |||
| matcher словарь | всегда | HTTP-коды, используемые при проверке успешного ответа от целевого сервера. Пример: {'http_code': '200'} | |||
| port целое число | всегда | Порт, на котором слушают целевые серверы. Пример: 80 | |||
| protocol строка | всегда | Протокол, используемый для маршрутизации трафика к целевым серверам. Пример: HTTP | |||
| stickiness_enabled булево | всегда | Указывает, включены ли липкие сеансы. Пример: True | |||
| stickiness_lb_cookie_duration_seconds целое число | всегда | Указывает, включены ли липкие сеансы. Пример: 86400 | |||
| stickiness_type строка | всегда | Тип липких сеансов. Пример: lb_cookie | |||
| tags словарь | всегда | Теги, прикрепленные к целевой группе. Пример: { 'Тэг': 'Пример' } | |||
| target_group_arn строка | всегда | Amazon Resource Name (ARN) целевой группы. Пример: arn:aws:elasticloadbalancing:ap-southeast-2:01234567890:targetgroup/mytargetgroup/aabbccddee0044332211 | |||
| target_group_name строка | всегда | Название целевой группы. Пример: mytargetgroup | |||
| targets_health_description complex | при включенном collect_targets_health | Описание состояния здоровья целевых серверов. | |||
| health_check_port строка | всегда | Порт для проверки состояния здоровья целевого сервера. Пример: 80 | |||
| target complex | всегда | Метаданные целевого сервера. | |||
| id строка | всегда | Идентификатор целевого сервера. Пример: i-0123456789 | |||
| port целое число | всегда | Порт для подключения к целевому серверу. Пример: 80 | |||
| target_health complex | всегда | Статус работоспособности целевого сервера. | |||
| state строка | всегда | Состояние работоспособности целевого сервера. Пример: работоспособный | |||
| unhealthy_threshold_count целое число | всегда | Количество последовательных сбоев проверок работоспособности, необходимых для того, чтобы считать целевой сервер неработоспособным. Пример: 2 | |||
| vpc_id строка | всегда | Идентификатор VPC для целевых серверов. Пример: vpc-0123456 | |||
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/elb_target_group_facts_module.html