Spec-Zone.ru › Ansible 2.4

ec2_asg_facts - Сбор фактов о группах автомасштабирования ec2 (ASG) в AWS

Новая версия 2.2.

  • Обзор
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус

Обзор

  • Сбор фактов о группах автомасштабирования ec2 (ASG) в AWS

Требования (к хосту, на котором выполняется модуль)

  • python >= 2.6
  • boto

Параметры

параметр обязательно по умолчанию значения комментарии
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
ec2_url
нет
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая есть.
name
нет
Префикс или имя группы автомасштабирования, которую вы ищете.
Примечание: это соответствие по регулярному выражению с неявным '^' (начало строки). Добавьте '$' для точного совпадения имени.
profile
(добавлен в 1.6)
нет
Использует профиль 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
(добавлен в 1.6)
нет
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
псевдонимы: access_token
tags
нет
Словарь тегов в формате { tag1_name: 'tag1_value', tag2_name: 'tag2_value' }, для сопоставления с группами автомасштабирования, которые вы ищете.
validate_certs
(добавлен в 1.5)
нет да
  • да
  • нет
При значении "нет" сертификаты SSL для boto версий >= 2.6.0 не будут проверяться.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Find all groups
- ec2_asg_facts:
  register: asgs

# Find a group with matching name/prefix
- ec2_asg_facts:
    name: public-webserver-asg
  register: asgs

# Find a group with matching tags
- ec2_asg_facts:
    tags:
      project: webapp
      env: production
  register: asgs

# Find a group with matching name/prefix and tags
- ec2_asg_facts:
    name: myproject
    tags:
      env: production
  register: asgs

# Fail if no groups are found
- ec2_asg_facts:
    name: public-webserver-asg
  register: asgs
  failed_when: "{{ asgs.results | length == 0 }}"

# Fail if more than 1 group is found
- ec2_asg_facts:
    name: public-webserver-asg
  register: asgs
  failed_when: "{{ asgs.results | length > 1 }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:

имя описание возвращается тип пример
auto_scaling_group_arn
Amazon Resource Name (ARN) ASG
успех строка arn:aws:autoscaling:us-west-2:1234567890:autoScalingGroup:10787c52-0bcb-427d-82ba-c8e4b008ed2e:autoScalingGroupName/public-webapp-production-1
auto_scaling_group_name
Имя группы автомасштабирования
успех строка public-webapp-production-1
availability_zones
Список доступных зон, включенных для этой ASG.
успех список ['us-west-2a', 'us-west-2b', 'us-west-2a']
created_time
Дата и время создания ASG в формате ISO 8601.
успех строка 2015-11-25T00:05:36.309Z
default_cooldown
Время охлаждения по умолчанию в секундах.
успех целое 300
desired_capacity
Количество EC2-инстансов, которое должно работать в этой группе.
успех целое 3
health_check_period
Продолжительность в секундах, после которой новый EC2-инстанс начинает проверку работоспособности.
успех целое 30
health_check_type
Сервис, из которого нужно получить статус работоспособности, "EC2" или "ELB".
успех строка ELB
instances
Список EC2-инстансов и их статуса по отношению к ASG.
успех список [{'instance_id': 'i-es22ad25', 'lifecycle_state': 'В работе', 'health_status': 'Здоровый', 'protected_from_scale_in': 'false', 'availability_zone': 'us-west-2a', 'launch_configuration_name': 'public-webapp-production-1'}]
launch_config_name
Имя конфигурации запуска, связанной с ASG. То же, что и launch_configuration_name, предоставлено для совместимости с модулем ec2_asg.
успех строка public-webapp-production-1
launch_configuration_name
Имя конфигурации запуска, связанной с ASG.
успех строка public-webapp-production-1
load_balancer_names
Список имен балансировщиков нагрузки, подключенных к ASG.
успех список ['elb-webapp-prod']
max_size
Максимальный размер группы
успех целое 3
min_size
Минимальный размер группы
успех целое 1
new_instances_protected_from_scale_in
Защищены ли новые инстансы от автоматического масштабирования?
успех булево false
placement_group
Группа размещения, в которую запускаются инстансы, если таковая есть.
успех строка None
status
Текущее состояние группы при выполнении DeleteAutoScalingGroup.
успех строка None
tags
Список тегов для ASG и то, распространяются ли они на инстансы при запуске.
успех список [{'propagate_at_launch': 'true', 'key': 'Имя', 'value': 'public-webapp-production-1', 'resource_type': 'auto-scaling-group', 'resource_id': 'public-webapp-production-1'}, {'propagate_at_launch': 'true', 'key': 'env', 'value': 'production', 'resource_type': 'auto-scaling-group', 'resource_id': 'public-webapp-production-1'}]
target_group_arns
Список ARN целевых групп, которые заполняет ASG
успех список ['arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:targetgroup/target-group-host-hello/1a2b3c4d5e6f1a2b', 'arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:targetgroup/target-group-path-world/abcd1234abcd1234']
target_group_names
Список имён целевых групп, которые заполняет ASG
успех список ['target-group-host-hello', 'target-group-path-world']
termination_policies
Список политик завершения для группы.
успех строка ['По умолчанию']

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Для получения помощи в разработке модулей, если у вас есть такие намерения, пожалуйста, ознакомьтесь с Справочной информацией сообщества и разработкой, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ec2_asg_facts_module.html

Spec-Zone.ru

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