elb_target_group_info – Сбор информации о целевых группах ELB в AWS
Новая версия с 2.4.
Обзор
- Сбор информации о целевых группах ELB в AWS
- Этот модуль назывался
elb_target_group_factsперед Ansible 2.9. Способ использования не изменился.
Псевдонимы: elb_target_group_facts
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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 security token. Если не задан, используется значение переменной окружения 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 information about all target groups
- elb_target_group_info:
# Gather information about the target group attached to a particular ELB
- elb_target_group_info:
load_balancer_arn: "arn:aws:elasticloadbalancing:ap-southeast-2:001122334455:loadbalancer/app/my-elb/aabbccddeeff"
# Gather information about a target groups named 'tg1' and 'tg2'
- 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 | всегда | 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 | всегда | Теги, прикрепленные к целевой группе. Пример: { 'Тег': 'Пример' } | |||
| target_group_arn string | всегда | Amazon Resource Name (ARN) целевой группы. Пример: arn:aws:elasticloadbalancing:ap-southeast-2:01234567890: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 | всегда | Состояние работоспособности целевого сервера. Пример: исправен | |||
| unhealthy_threshold_count integer | всегда | Количество последовательных сбоев проверки состояния, необходимое для перевода целевого сервера в состояние «неисправен». Пример: 2 | |||
| vpc_id string | всегда | Идентификатор 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.9/modules/elb_target_group_info_module.html