Spec-Zone.ru › Ansible 2.4

ec2_instance_facts - Сбор фактов о экземплярах ec2 в AWS

Новое в версии 2.4.

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

Описание

  • Сбор фактов об экземплярах ec2 в 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, если таковое есть.
filters
нет
Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html для возможных фильтров. Имена и значения фильтров чувствительны к регистру.
instance_ids
(добавлен в 2.4)
нет
Если вы укажете один или несколько идентификаторов экземпляров, будут возвращены только экземпляры с указанными идентификаторами.
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
validate_certs
(добавлен в 1.5)
нет да
  • да
  • нет
Если установлено значение "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0.

Примеры

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

# Gather facts about all instances
- ec2_instance_facts:

# Gather facts about all instances in AZ ap-southeast-2a
- ec2_instance_facts:
    filters:
      availability-zone: ap-southeast-2a

# Gather facts about a particular instance using ID
- ec2_instance_facts:
    instance_ids:
      - i-12345678

# Gather facts about any instance with a tag key Name and value Example
- ec2_instance_facts:
    filters:
      "tag:Name": Example

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

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

имя описание возвращается тип пример
instances
список экземпляров ec2
всегда сложный
содержит:
имя описание возвращается тип пример
network_interfaces
Один или несколько сетевых интерфейсов для экземпляра.
всегда сложный
root_device_type
Тип корневого устройства, используемого AMI.
всегда строка ebs
private_dns_name
Приватное имя DNS.
всегда строка ip-10-0-0-1.ap-southeast-2.compute.internal
tags
Любые теги, назначенные экземпляру.
всегда словарь None
key_name
Имя пары ключей, если этот экземпляр был запущен с связанной парой ключей.
всегда строка my-key
image_id
Идентификатор AMI, используемый для запуска экземпляра.
всегда строка ami-0011223344
block_device_mappings
Любые записи сопоставления блочных устройств для экземпляра.
всегда сложный
public_dns_name
Публичное имя DNS, назначенное экземпляру.
всегда строка None
placement
Местоположение, где запущен экземпляр, если применимо.
всегда сложный
architecture
Архитектура образа
всегда строка x86_64
security_groups
Один или несколько групп безопасности для экземпляра.
всегда сложный
public_ip_address
Публичный IPv4 адрес, назначенный экземпляру
всегда строка 52.0.0.1
product_codes
Один или несколько кодов продукта.
всегда сложный
monitoring
Мониторинг экземпляра.
всегда сложный
ami_launch_index
Индекс запуска AMI, который может быть использован для поиска этого экземпляра в группе запусков.
всегда целое 0
subnet_id
Идентификатор подсети, в которой работает экземпляр.
всегда строка subnet-00abcdef
hypervisor
Тип гипервизора экземпляра.
всегда строка xen
ebs_optimized
Указывает, оптимизирован ли экземпляр для ввода-вывода EBS.
всегда булево False
launch_time
Время запуска экземпляра.
всегда строка 2017-03-23T22:51:24+00:00
iam_instance_profile
Профиль профиля экземпляра IAM, если применимо.
всегда сложный
instance_id
Идентификатор экземпляра.
всегда строка i-012345678
instance_type
Размер типа экземпляра работающего экземпляра.
всегда строка t2.micro
state
Текущее состояние экземпляра.
всегда сложный
source_dest_check
Указывает, включена ли проверка источника/назначения.
всегда булево True
state_transition_reason
Причина последнего перехода состояния.
всегда строка None
private_ip_address
IPv4 адрес сетевого интерфейса в подсети.
всегда строка 10.0.0.1
vpc_id
Идентификатор VPC, в котором находится экземпляр.
всегда словарь vpc-0011223344
client_token
Токен idempotency, который вы предоставили при запуске экземпляра, если применимо.
всегда строка mytoken
virtualization_type
Тип виртуализации AMI.
всегда строка hvm
root_device_name
Имя устройства корневого устройства
всегда строка /dev/sda1

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета 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_instance_facts_module.html

Spec-Zone.ru

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