Spec-Zone.ru › Ansible 2.9

ec2_instance_info – Сбор информации о экземплярах ec2 в AWS

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

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

Описание

  • Сбор информации об экземплярах ec2 в AWS
  • Этот модуль назывался ec2_instance_facts до Ansible 2.9. Использование не изменилось.

Псевдонимы: ec2_instance_facts

Требования

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

  • 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
debug_botocore_endpoint_logs
логический
добавлен в 2.8
    Варианты:
  • нет ←
  • да
Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «resource:action», выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, выполненного во время выполнения плейбука. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url
строка
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть.
filters
-
По умолчанию:
{}
Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html для возможных фильтров. Названия и значения фильтров чувствительны к регистру.
instance_ids
-
добавлен в 2.4
Если вы укажете один или несколько идентификаторов экземпляров, будут возвращены только экземпляры с указанными идентификаторами.
profile
строка
Использует профиль 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
строка
Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

Псевдонимы: access_token
validate_certs
логический
    Варианты:
  • нет
  • да ←
При значении «нет» сертификаты 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), если учетные данные не предоставлены. См. 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.

# Gather information about all instances
- ec2_instance_info:

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

# Gather information about a particular instance using ID
- ec2_instance_info:
    instance_ids:
      - i-12345678

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

# Gather information about any instance in states "shutting-down", "stopping", "stopped"
- ec2_instance_info:
    filters:
      instance-state-name: [ "shutting-down", "stopping", "stopped" ]

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

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

Ключ Возвращаемое значение Описание
экземпляры
сложный
всегда
список ec2-экземпляров
ami_launch_index
целое число
всегда
Индекс запуска AMI, который можно использовать для поиска этого экземпляра в группе запуска.
архитектура
строка
всегда
Архитектура образа

Пример:
x86_64
block_device_mappings
сложный
всегда
Любые записи сопоставления блочных устройств для экземпляра.
имя_устройства
строка
всегда
Имя устройства, экспонируемое экземпляру (например, /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
cpu_options
сложный
всегда, если версия botocore >= 1.10.16
Настройки процессора для экземпляра.
core_count
целое число
всегда
Количество ядер процессора для экземпляра.

Пример:
1
threads_per_core
целое число
всегда
Количество потоков на ядро процессора. В поддерживаемых экземплярах значение 1 означает, что технология Intel Hyper-Threading отключена.

Пример:
1
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
string
always
Общедоступное имя DNS.
public_ip
string
always
Общедоступный IP-адрес или привязанный к сетевому интерфейсу Elastic IP-адрес.

Пример:
1.2.3.4
attachment
complex
always
Прикрепление сетевого интерфейса.
attach_time
string
always
Отметка времени начала прикрепления.

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

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

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

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

Пример:
Мой интерфейс
groups
list of 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
list of 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
boolean
always
Указывает, является ли этот IPv4-адрес основным частным IP-адресом сетевого интерфейса.

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

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

Пример:
True
статус
строка
всегда
Состояние сетевого интерфейса.

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

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

Пример:
vpc-0123456
размещение
сложный
всегда
Местоположение, где запущен экземпляр, если применимо.
availability_zone
строка
всегда
Доступная зона экземпляра.

Пример:
ap-southeast-2a
group_name
строка
всегда
Имя группы размещения, в которой находится экземпляр (для кластерных вычислительных экземпляров).
tenancy
строка
всегда
Наименование экземпляра (если экземпляр работает в 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
строка
всегда
Тип кода продукта.

Пример:
рынок
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
group_name
строка
всегда
Название группы безопасности.

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

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

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

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

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

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

Пример:
vpc-0011223344


Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • 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.9/modules/ec2_instance_info_module.html

Spec-Zone.ru

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