Spec-Zone.ru › Ansible 2.5

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

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

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

Обзор

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

Требования

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

  • boto
  • boto3
  • botocore
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key Значение по умолчанию:
None
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.

Псевдонимы: ec2_access_key, access_key
aws_secret_key Значение по умолчанию:
None
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.

Псевдонимы: ec2_secret_key, secret_key
ec2_url Значение по умолчанию:
None
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)
 Значение по умолчанию:
None
Использует профиль 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)
 Значение по умолчанию:
None
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

Псевдонимы: access_token
validate_certs
(добавлен в 1.5)
    Варианты:
  • no
  • yes ←
Если установлено "no", сертификаты 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

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

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

Ключ Возвращаемое значение Описание
экземпляры
сложный
 всегда
список экземпляров ec2
сетевые_интерфейсы
сложный
 всегда
Один или несколько сетевых интерфейсов для экземпляра.
состояние
строка
 всегда
Состояние сетевого интерфейса.

Пример:
в_использовании
описание
строка
 всегда
Описание.

Пример:
Мой интерфейс
id_подсети
строка
 всегда
Идентификатор подсети для сетевого интерфейса.

Пример:
subnet-0123456
ipv6_адреса
сложный
 всегда
Один или несколько адресов IPv6, связанных с сетевым интерфейсом.
ipv6_адрес
строка
 всегда
Адрес IPv6.

Пример:
2001:0db8:85a3:0000:0000:8a2e:0370:7334
id_сетевого_интерфейса
строка
 всегда
Идентификатор сетевого интерфейса.

Пример:
eni-01234567
подключение
сложный
 всегда
Подключение сетевого интерфейса.
состояние
строка
 всегда
Состояние подключения.

Пример:
подключено
индекс_устройства
целое
 всегда
Индекс устройства на экземпляре для подключения сетевого интерфейса.
id_подключения
строка
 всегда
Идентификатор подключения сетевого интерфейса.

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

Пример:
True
время_подключения
строка
 всегда
Отметка времени, когда началось подключение.

Пример:
2017-03-23T22:51:24+00:00
private_ip_адреса
сложный
 всегда
Приватные адреса IPv4, связанные с сетевым интерфейсом.
private_ip_адрес
строка
 всегда
Приватный IPv4-адрес сетевого интерфейса.

Пример:
10.0.0.1
первичный
булево
 всегда
Указывает, является ли этот IPv4-адрес первичным приватным IP-адресом сетевого интерфейса.

Пример:
True
ассоциация
сложный
 всегда
Информация об ассоциации с адресом Elastic IP (IPv4), связанным с сетевым интерфейсом.
публичное_имя_dns
строка
 всегда
Публичное имя DNS.
публичный_ip
строка
 всегда
Публичный IP-адрес или Elastic IP-адрес, привязанный к сетевому интерфейсу.

Пример:
1.2.3.4
id_владельца_ip
строка
 всегда
Идентификатор владельца Elastic IP-адреса.

Пример:
amazon
mac_адрес
строка
 всегда
MAC-адрес.

Пример:
00:11:22:33:44:55
private_ip_address
строка
 всегда
IPv4-адрес сетевого интерфейса внутри подсети.

Пример:
10.0.0.1
id_vpc
строка
 всегда
Идентификатор VPC для сетевого интерфейса.

Пример:
vpc-0123456
группы
сложный
 всегда
Одна или несколько групп безопасности.
id_группы
строка
 всегда
Идентификатор группы безопасности.

Пример:
sg-abcdef12
имя_группы
строка
 всегда
Название группы безопасности.

Пример:
mygroup
ассоциация
сложный
 всегда
Информация об ассоциации с Elastic IPv4, связанным с сетевым интерфейсом.
публичное_имя_dns
строка
 всегда
Публичное имя DNS.
public_ip
string
 always
Общедоступный IP-адрес или Elastic IP-адрес, привязанный к сетевому интерфейсу.

Пример:
1.2.3.4
ip_owner_id
string
 always
Идентификатор владельца Elastic IP-адреса.

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

Пример:
True
owner_id
string
 always
ID учетной записи AWS владельца сетевого интерфейса.

Пример:
01234567890
root_device_type
string
 always
Тип корневого устройства, используемого AMI.

Пример:
ebs
private_dns_name
string
 always
Приватное имя DNS.

Пример:
ip-10-0-0-1.ap-southeast-2.compute.internal
tags
dict
 always
Все теги, назначенные экземпляру.
key_name
string
 always
Имя пары ключей, если этот экземпляр был запущен с ассоциированной парой ключей.

Пример:
my-key
image_id
string
 always
Идентификатор AMI, используемого для запуска экземпляра.

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

Пример:
/dev/sdh
ebs
complex
 always
Параметры, используемые для автоматической настройки томов EBS при запуске экземпляра.
status
string
 always
Состояние подключения.

Пример:
attached
delete_on_termination
bool
 always
Указывает, будет ли том удален при завершении работы экземпляра.

Пример:
True
attach_time
string
 always
Отметка времени начала подключения.

Пример:
2017-03-23T22:51:24+00:00
volume_id
string
 always
Идентификатор тома EBS

Пример:
vol-12345678
public_dns_name
string
 always
Общедоступное имя DNS, назначенное экземпляру.
placement
complex
 always
Местоположение запуска экземпляра, если применимо.
availability_zone
string
 always
Зона доступности экземпляра.

Пример:
ap-southeast-2a
tenancy
string
 always
Вид аренды экземпляра (если экземпляр работает в VPC).

Пример:
default
group_name
string
 always
Имя группы размещения, в которой находится экземпляр (для кластерных вычислительных экземпляров).
architecture
string
 always
Архитектура образа

Пример:
x86_64
security_groups
complex
 always
Один или несколько групп безопасности для экземпляра.
group_id
string
 always
Идентификатор группы безопасности.

Пример:
sg-0123456
public_ip_address
string
 always
Общедоступный IPv4-адрес, назначенный экземпляру

Пример:
52.0.0.1
product_codes
complex
 always
Один или несколько кодов продукта.
product_code_type
string
 always
Тип кода продукта.

Пример:
marketplace
product_code_id
string
 always
Код продукта.

Пример:
aw0evgkw8ef3n2498gndfgasdfsd5cce
monitoring
complex
 always
Мониторинг экземпляра.
state
string
 always
Указывает, включен ли подробный мониторинг. В противном случае включен базовый мониторинг.

Пример:
disabled
ami_launch_index
int
 always
Индекс запуска AMI, который может использоваться для поиска этого экземпляра в группе запуска.
subnet_id
string
 always
ID подсети, в которой запущен экземпляр.

Пример:
subnet-00abcdef
hypervisor
string
 always
Тип гипервизора экземпляра.

Пример:
xen
ebs_optimized
bool
 always
Указывает, оптимизирован ли экземпляр для ввода-вывода EBS.
launch_time
string
 always
Время запуска экземпляра.

Пример:
2017-03-23T22:51:24+00:00
iam_instance_profile
complex
 always
Профиль экземпляра IAM, если применимо.
id
string
 always
ID профиля экземпляра

Пример:
JFJ397FDG400FG9FD1N
arn
string
 always
Amazon Resource Name (ARN) профиля экземпляра.

Пример:
arn:aws:iam::000012345678:instance-profile/myprofile
instance_id
string
 always
ID экземпляра.

Пример:
i-012345678
instance_type
string
 always
Размер типа экземпляра запущенного экземпляра.

Пример:
t2.micro
state
complex
 always
Текущее состояние экземпляра.
code
int
 always
Низкий байт представляет состояние.

Пример:
16
name
string
 always
Имя состояния.

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

Пример:
True
state_transition_reason
string
 always
Причина последнего перехода состояния.
private_ip_address
string
 always
IPv4-адрес сетевого интерфейса в подсети.

Пример:
10.0.0.1
vpc_id
dict
 always
ID VPC, в котором находится экземпляр.

Пример:
vpc-0011223344
client_token
string
 always
Токен идемпотенции, предоставленный при запуске экземпляра, если применимо.

Пример:
mytoken
virtualization_type
string
 always
Тип виртуализации AMI.

Пример:
hvm
root_device_name
string
 always
Имя устройства корневого устройства

Пример:
/dev/sda1


Статус

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

Автор

  • 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.5/modules/ec2_instance_facts_module.html

Spec-Zone.ru

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