Spec-Zone.ru › Ansible 2.10

community.aws.ec2_instance_facts – Сбор информации о виртуальных машинах ec2 в AWS

Примечание

Этот плагин входит в состав коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач укажите: community.aws.ec2_instance_facts.

Новый в версии 1.0.0: коллекции community.aws

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

Обзор

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

Требования

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

  • boto
  • boto3
  • botocore
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key
строка
Ключ доступа к AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Если задан параметр profile, этот параметр игнорируется.
Одновременное указание параметров aws_access_key и profile устарело и станет взаимоисключающим после 2022-06-01.

псевдонимы: ec2_access_key, access_key
aws_ca_bundle
путь
Расположение файла с сертификатом CA для проверки SSL-сертификатов.
Используется только для модулей на основе boto3.
Примечание: Файл CA Bundle читается на стороне модуля и может потребоваться явно скопировать его с контроллера, если модуль не запускается локально.
aws_config
словарь
Словарь для модификации настроек botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для модулей boto используется только ключ 'user_agent'. Дополнительные настройки boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto.
aws_secret_key
строка
Секретный ключ доступа к AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Если задан параметр profile, этот параметр игнорируется.
Одновременное указание параметров aws_secret_key и profile устарело и станет взаимоисключающим после 2022-06-01.

псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
логический тип
    Варианты:
  • нет ←
  • да
Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполняемых во время задачи, выводимых в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, выполненного во время книги задач. Также может использоваться переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url
строка
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL.

псевдонимы: aws_endpoint_url, endpoint_url
filters
словарь
Значение по умолчанию:
{}
Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html для возможных фильтров. Названия и значения фильтров чувствительны к регистру.
instance_ids
список / элементы=строка
Если указан один или несколько идентификаторов экземпляров, возвращаются только экземпляры с указанными идентификаторами.
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
Использование profile переопределяет aws_access_key, aws_secret_key и security_token, и поддержка одновременного указания с profile устарела.
aws_access_key, aws_secret_key и security_token станут взаимоисключающими с profile после 2022-06-01.

псевдонимы: aws_profile
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.
Если задан параметр profile, этот параметр игнорируется.
Одновременное указание параметров security_token и profile устарело и станет взаимоисключающим после 2022-06-01.

псевдонимы: aws_security_token, access_token
validate_certs
логический тип
    Варианты:
  • нет
  • да ←
Если установлено в «нет», SSL-сертификаты не будут проверены для версий boto >= 2.6.0.

Примечания

Примечание

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

- name: Gather information about all instances
  community.aws.ec2_instance_info:

- name: Gather information about all instances in AZ ap-southeast-2a
  community.aws.ec2_instance_info:
    filters:
      availability-zone: ap-southeast-2a

- name: Gather information about a particular instance using ID
  community.aws.ec2_instance_info:
    instance_ids:
      - i-12345678

- name: Gather information about any instance with a tag key Name and value Example
  community.aws.ec2_instance_info:
    filters:
      "tag:Name": Example

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

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

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

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

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

Пример:
/dev/sdh
ebs
complex
всегда
Параметры, используемые для автоматической настройки томов 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
complex
всегда, если версия botocore >= 1.10.16
Параметры процессора для экземпляра.
core_count
целое число
всегда
Количество ядер процессора для экземпляра.

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

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

Пример:
xen
iam_instance_profile
complex
всегда
Профиль 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
complex
всегда
Мониторинг экземпляра.
state
строка
всегда
Указывает, включен ли подробный мониторинг. В противном случае включен базовый мониторинг.

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

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

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

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

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

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

Пример:
подключено
description
строка
всегда
Описание.

Пример:
Мой интерфейс
groups
список / элементы=словарь
всегда
Одна или несколько групп безопасности.
group_id
строка
всегда
Идентификатор группы безопасности.

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

Пример:
mygroup
ipv6_addresses
список / элементы=словарь
всегда
Один или несколько адресов IPv6, связанных с сетевым интерфейсом.
ipv6_address
строка
всегда
Адрес IPv6.

Пример:
2001:0db8:85a3:0000:0000:8a2e:0370:7334
mac_address
строка
всегда
MAC-адрес.

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

Пример:
eni-01234567
owner_id
строка
всегда
AWS-идентификатор учётной записи владельца сетевого интерфейса.

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

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

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

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

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

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

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

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

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

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

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

Пример:
default
private_dns_name
строка
всегда
Частное доменное имя.

Пример:
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
строка
всегда
Публичное доменное имя, назначенное экземпляру.
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


Авторы

  • 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.10/collections/community/aws/ec2_instance_facts_module.html

Spec-Zone.ru

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