Spec-Zone.ru › Ansible 2.10

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

Примечание

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

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

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

Новое в версии 1.0.0: of 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 считывается со стороны «модуля» и, возможно, должен быть явно скопирован с контроллера, если он не запущен локально.
aws_config
словарь
Словарь для изменения конфигурации botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Только ключ 'user_agent' используется для boto-модулей. Дополнительную информацию о конфигурации boto можно найти по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#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_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время выполнения playbook. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url
строка
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 security token. Если не задан, используется значение переменной среды 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 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


Авторы

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

Spec-Zone.ru

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