Spec-Zone.ru › Ansible 2.11

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

Примечание

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

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

Для использования в плейбуке укажите: community.aws.elb_target_group_info

Новое в версии 1.0.0: из community.aws

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

Описание

  • Сбор информации о целевых группах ELB в AWS
  • Этот модуль назывался elb_target_group_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'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации 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
collect_targets_health
булево
    Варианты:
  • нет ←
  • да
Если установлено "да", вывод содержит описание состояния целевых групп.
debug_botocore_endpoint_logs
булево
    Варианты:
  • нет ←
  • да
Использует логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «resource:action», сделанных во время задачи, выводя их в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action, чтобы вывести полный список, сделанный во время плейбука. Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url
строка
Адрес для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует адреса EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковая есть.

псевдонимы: aws_endpoint_url, endpoint_url
load_balancer_arn
строка
Amazon Resource Name (ARN) балансировщика нагрузки.
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
target_group_arns
список / элементы=строка
Amazon Resource Names (ARN) целевых групп.
validate_certs
булево
    Варианты:
  • нет
  • да ←
Если установлено "нет", SSL-сертификаты не будут проверяться для версий boto >= 2.6.0.

Примечания

Примечание

  • Если параметры не заданы в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета 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_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:001122334455: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 (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 (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
всегда
Состояние проверки состояния целевого объекта.

Пример:
healthy
unhealthy_threshold_count
integer
всегда
Количество последовательных сбоев проверок состояния, необходимых для перевода целевого объекта в состояние «неисправный».

Пример:
2
vpc_id
string
всегда
Идентификатор VPC для целевых объектов.

Пример:
vpc-0123456


Авторы

  • Rob White (@wimnat)

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

Spec-Zone.ru

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