Spec-Zone.ru › Ansible 2.6

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

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

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
  • Техническое обслуживание
    • Автор

Обзор

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

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

  • boto
  • boto3
  • botocore
  • 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
ec2_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
bool

(добавлен в 1.5)
    Варианты:
  • нет
  • да ←
При значении "нет" сертификаты 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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 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
ami_launch_index
int
 всегда
Индекс запуска AMI, который можно использовать для поиска этого экземпляра в группе запуска.
architecture
строка
 всегда
Архитектура образа

Пример:
x86_64
block_device_mappings
сложный
 всегда
Любые записи отображения блочных устройств для экземпляра.
device_name
строка
 всегда
Имя устройства, доступное экземпляру (например, /dev/sdh или xvdh).

Пример:
/dev/sdh
ebs
сложный
 всегда
Параметры, используемые для автоматической настройки томов EBS при запуске экземпляра.
attach_time
строка
 всегда
Отметка времени, когда началось подключение.

Пример:
2017-03-23T22:51:24+00:00
delete_on_termination
булево
 всегда
Указывает, будет ли том удален при завершении работы экземпляра.

Пример:
True
status
строка
 всегда
Состояние подключения.

Пример:
подключено
volume_id
строка
 всегда
Идентификатор тома EBS

Пример:
vol-12345678
client_token
строка
 всегда
Маркер идемпотентности, предоставленный вами при запуске экземпляра, если применимо.

Пример:
mytoken
ebs_optimized
булево
 всегда
Указывает, оптимизирован ли экземпляр для ввода-вывода EBS.
hypervisor
строка
 всегда
Тип гипервизора экземпляра.

Пример:
xen
iam_instance_profile
сложный
 всегда
Профиль экземпляра IAM, связанный с экземпляром, если применимо.
arn
строка
 всегда
Amazon Resource Name (ARN) профиля экземпляра.

Пример:
arn:aws:iam::000012345678:instance-profile/myprofile
id
строка
 всегда
Идентификатор профиля экземпляра

Пример:
JFJ397FDG400FG9FD1N
image_id
строка
 всегда
Идентификатор AMI, используемого для запуска экземпляра.

Пример:
ami-0011223344
instance_id
строка
 всегда
Идентификатор экземпляра.

Пример:
i-012345678
instance_type
строка
 всегда
Размер типа экземпляра работающего экземпляра.

Пример:
t2.micro
key_name
строка
 всегда
Имя пары ключей, если этот экземпляр был запущен с связанной парой ключей.

Пример:
my-key
launch_time
строка
 всегда
Время запуска экземпляра.

Пример:
2017-03-23T22:51:24+00:00
monitoring
сложный
 всегда
Мониторинг экземпляра.
state
строка
 всегда
Указывает, включен ли подробный мониторинг. В противном случае включен базовый мониторинг.

Пример:
отключен
network_interfaces
сложный
 всегда
Один или несколько сетевых интерфейсов для экземпляра.
association
сложный
 всегда
Информация о привязке Elastic IPv4, связанного с сетевым интерфейсом.
ip_owner_id
строка
 всегда
Идентификатор владельца адреса Elastic IP.

Пример:
amazon
public_dns_name
строка
 всегда
Общедоступное имя DNS.
public_ip
строка
 всегда
Общедоступный IP-адрес или адрес Elastic IP, привязанный к сетевому интерфейсу.

Пример:
1.2.3.4
attachment
сложный
 всегда
Подключение сетевого интерфейса.
attach_time
строка
 всегда
Отметка времени, когда началось подключение.

Пример:
2017-03-23T22:51:24+00:00
attachment_id
строка
 всегда
Идентификатор подключения сетевого интерфейса.

Пример:
eni-attach-3aff3f
delete_on_termination
bool
 always
Указывает, удаляется ли сетевой интерфейс при завершении работы экземпляра.

Пример:
True
device_index
int
 always
Индекс устройства на экземпляре для подключения сетевого интерфейса.
status
string
 always
Состояние подключения.

Пример:
attached
description
string
 always
Описание.

Пример:
Мой интерфейс
groups
complex
 always
Один или несколько сетевых экранов.
group_id
string
 always
Идентификатор сетевого экрана.

Пример:
sg-abcdef12
group_name
string
 always
Название сетевого экрана.

Пример:
mygroup
ipv6_addresses
complex
 always
Один или несколько IPv6-адресов, связанных с сетевым интерфейсом.
ipv6_address
string
 always
IPv6-адрес.

Пример:
2001:0db8:85a3:0000:0000:8a2e:0370:7334
mac_address
string
 always
MAC-адрес.

Пример:
00:11:22:33:44:55
network_interface_id
string
 always
Идентификатор сетевого интерфейса.

Пример:
eni-01234567
owner_id
string
 always
AWS-идентификатор владельца сетевого интерфейса.

Пример:
01234567890
private_ip_address
string
 always
IPv4-адрес сетевого интерфейса в подсети.

Пример:
10.0.0.1
private_ip_addresses
complex
 always
Частные IPv4-адреса, связанные с сетевым интерфейсом.
association
complex
 always
Информация об ассоциации для адреса Elastic IP (IPv4), связанного с сетевым интерфейсом.
ip_owner_id
string
 always
Идентификатор владельца адреса Elastic IP.

Пример:
amazon
public_dns_name
string
 always
Публичное имя DNS.
public_ip
string
 always
Публичный IP-адрес или адрес Elastic IP, привязанный к сетевому интерфейсу.

Пример:
1.2.3.4
primary
bool
 always
Указывает, является ли этот IPv4-адрес основным частным IP-адресом сетевого интерфейса.

Пример:
True
private_ip_address
string
 always
Частный IPv4-адрес сетевого интерфейса.

Пример:
10.0.0.1
source_dest_check
bool
 always
Указывает, включена ли проверка источника/назначения.

Пример:
True
status
string
 always
Состояние сетевого интерфейса.

Пример:
в использовании
subnet_id
string
 always
Идентификатор подсети для сетевого интерфейса.

Пример:
subnet-0123456
vpc_id
string
 always
Идентификатор VPC для сетевого интерфейса.

Пример:
vpc-0123456
placement
complex
 always
Местоположение запуска экземпляра, если применимо.
availability_zone
string
 always
Доступная зона экземпляра.

Пример:
ap-southeast-2a
group_name
string
 always
Название группы размещения, в которой находится экземпляр (для кластерных вычислительных экземпляров).
tenancy
string
 always
Тип принадлежности экземпляра (если экземпляр работает в VPC).

Пример:
по умолчанию
private_dns_name
строка
 всегда
Название частного DNS.

Пример:
ip-10-0-0-1.ap-southeast-2.compute.internal
private_ip_address
строка
 всегда
IPv4-адрес сетевого интерфейса в подсети.

Пример:
10.0.0.1
product_codes
сложное
 всегда
Один или несколько кодов продукта.
product_code_id
строка
 всегда
Код продукта.

Пример:
aw0evgkw8ef3n2498gndfgasdfsd5cce
product_code_type
строка
 всегда
Тип кода продукта.

Пример:
marketplace
public_dns_name
строка
 всегда
Общедоступное имя DNS, назначенное экземпляру.
public_ip_address
строка
 всегда
Общедоступный IPv4-адрес, назначенный экземпляру.

Пример:
52.0.0.1
root_device_name
строка
 всегда
Имя устройства корневого устройства

Пример:
/dev/sda1
root_device_type
строка
 всегда
Тип корневого устройства, используемого AMI.

Пример:
ebs
security_groups
сложное
 всегда
Один или несколько наборов правил безопасности для экземпляра.
group_id
строка
 всегда
Идентификатор набора правил безопасности.

Пример:
sg-0123456
source_dest_check
логическое
 всегда
Указывает, включена ли проверка источника/назначения.

Пример:
True
state
сложное
 всегда
Текущее состояние экземпляра.
code
целое число
 всегда
Низкий байт представляет состояние.

Пример:
16
name
строка
 всегда
Имя состояния.

Пример:
running
state_transition_reason
строка
 всегда
Причина последнего перехода состояния.
subnet_id
строка
 всегда
Идентификатор подсети, в которой запущен экземпляр.

Пример:
subnet-00abcdef
tags
словарь
 всегда
Любые теги, назначенные экземпляру.
virtualization_type
строка
 всегда
Тип виртуализации AMI.

Пример:
hvm
vpc_id
словарь
 всегда
Идентификатор VPC, в котором находится экземпляр.

Пример:
vpc-0011223344


Состояние

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

Техническое обслуживание

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

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

  • Michael Schuett, @michaeljs1990
  • 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.6/modules/ec2_instance_facts_module.html

Spec-Zone.ru

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