Модуль amazon.aws.ec2_instance_info — сбор информации об экземплярах EC2 в AWS
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: amazon.aws.ec2_instance_info.
Добавлено в amazon.aws 1.0.0
Краткое описание
- Сбор информации об экземплярах EC2 в AWS.
Требования
Следующие компоненты должны быть установлены на узле, на котором выполняется этот модуль.
- python >= 3.6
- boto3 >= 1.35.0
- botocore >= 1.35.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key строка | Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore. |
aws_ca_bundle путь | Путь к пакету сертификатов CA, используемому для проверки сертификатов SSL. Также можно использовать переменную среды |
aws_config словарь | Словарь для изменения конфигурации botocore. Описание параметров доступно в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs логическое значение | Использовать регистратор Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url строка | URL для подключения вместо конечных точек AWS по умолчанию. Этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды |
filters словарь | Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и его значения. Возможные фильтры см. на странице https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html. Имена и значения фильтров чувствительны к регистру. По умолчанию: |
include_attributes псевдонимы: attributes список / элементы=строка добавлено в amazon.aws 6.3.0 | Описывает указанные атрибуты возвращаемых экземпляров. Варианты:
|
instance_ids список / элементы=строка | Если указать один или несколько идентификаторов экземпляров, будут возвращены только экземпляры с указанными идентификаторами. По умолчанию: |
minimum_uptime псевдонимы: uptime целое число | Минимальное время работы экземпляров в минутах. Например, если |
profile псевдонимы: aws_profile строка | Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token. |
region псевдонимы: aws_region строка | Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка | Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore. |
session_token псевдонимы: aws_session_token строка | Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды Параметры session_token и profile взаимоисключающие. |
validate_certs логическое значение | Если установлено значение Настройка validate_certs=false настоятельно не рекомендуется; в качестве альтернативы рассмотрите возможность указать aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и файлы конфигурации считываются в контексте «узла» Ansible, а не в контексте «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются в контексте «контроллера» Ansible, а не в контексте «узла».
- Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно
~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Gather information about all instances
amazon.aws.ec2_instance_info:
- name: Gather information about all instances in AZ ap-southeast-2a
amazon.aws.ec2_instance_info:
filters:
availability-zone: ap-southeast-2a
- name: Gather information about a particular instance using ID
amazon.aws.ec2_instance_info:
instance_ids:
- i-12345678
- name: Gather information about any instance with a tag key Name and value Example
amazon.aws.ec2_instance_info:
filters:
"tag:Name": Example
- name: Gather information about any instance in states "shutting-down", "stopping", "stopped"
amazon.aws.ec2_instance_info:
filters:
instance-state-name: ["shutting-down", "stopping", "stopped"]
- name: Gather information about any instance with Name beginning with RHEL and an uptime of at least 60 minutes
amazon.aws.ec2_instance_info:
region: "{{ ec2_region }}"
uptime: 60
filters:
"tag:Name": "RHEL-*"
instance-state-name: ["running"]
register: ec2_node_info
- name: Gather information about a particular instance using ID and include kernel attribute
amazon.aws.ec2_instance_info:
instance_ids:
- i-12345678
include_attributes:
- kernel
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
instances complex | Список экземпляров EC2. Возвращается: всегда |
|
ami_launch_index integer |
Индекс запуска AMI, который можно использовать для поиска этого экземпляра в группе запуска. Возвращается: всегда Пример: |
|
architecture string |
Архитектура образа. Возвращается: всегда Пример: |
|
attributes dictionary добавлено в amazon.aws 6.3.0 |
Сведения об атрибуте экземпляра, заданном во входных данных. Возвращается: если указан Пример: |
|
block_device_mappings complex |
Записи сопоставления блочных устройств для экземпляра. Возвращается: всегда |
|
device_name string |
Имя устройства, предоставляемого экземпляру (например, /dev/sdh или xvdh). Возвращается: всегда Пример: |
|
ebs complex |
Параметры, используемые для автоматической настройки томов EBS при запуске экземпляра. Возвращается: всегда |
|
attach_time string |
Временная метка начала подключения. Возвращается: всегда Пример: |
|
delete_on_termination boolean |
Указывает, удаляется ли том при завершении работы экземпляра. Возвращается: всегда Пример: |
|
status string |
Состояние подключения. Возвращается: всегда Пример: |
|
volume_id string |
Идентификатор тома EBS. Возвращается: всегда Пример: |
|
capacity_reservation_specification complex |
Информация о параметре выбора Capacity Reservation. Возвращается: при успешном выполнении |
|
capacity_reservation_preference string |
Описывает параметры Capacity Reservation. Возвращается: при успешном выполнении Пример: |
|
client_token string |
Токен идемпотентности, указанный при запуске экземпляра, если применимо. Возвращается: всегда Пример: |
|
cpu_options complex |
Параметры CPU, заданные для экземпляра. Возвращается: всегда |
|
core_count integer |
Количество ядер CPU экземпляра. Возвращается: всегда Пример: |
|
threads_per_core integer |
Количество потоков на ядро CPU. Для поддерживаемых типов экземпляров значение 1 означает, что технология Intel Hyper-Threading отключена. Возвращается: всегда Пример: |
|
current_instance_boot_mode string |
Режим загрузки, используемый при запуске или старте экземпляра. Возвращается: при успешном выполнении Пример: |
|
ebs_optimized boolean |
Указывает, оптимизирован ли экземпляр для операций ввода-вывода EBS. Возвращается: всегда Пример: |
|
ena_support boolean |
Указывает, включена ли расширенная сеть с ENA. Возвращается: всегда Пример: |
|
enclave_options dictionary |
Указывает, включена ли поддержка Amazon Web Services Nitro Enclaves для экземпляра. Возвращается: при успешном выполнении |
|
enabled boolean |
Если для этого параметра задано значение true, для экземпляра включена поддержка Amazon Web Services Nitro Enclaves. Возвращается: всегда Пример: |
|
hibernation_options dictionary |
Указывает, включена ли для экземпляра поддержка гибернации. Возвращается: при успешном выполнении |
|
configured boolean |
Если значение равно true, для экземпляра включена поддержка гибернации; в противном случае она отключена. Возвращается: всегда Пример: |
|
hypervisor string |
Тип гипервизора экземпляра. Возвращается: всегда Пример: |
|
iam_instance_profile complex |
Профиль экземпляра IAM, связанный с экземпляром, если применимо. Возвращается: при успешном выполнении |
|
arn string |
Имя ресурса Amazon (ARN) профиля экземпляра. Возвращается: всегда Пример: |
|
id string |
Идентификатор профиля экземпляра. Возвращается: всегда Пример: |
|
image_id string |
Идентификатор AMI, использованного для запуска экземпляра. Возвращается: всегда Пример: |
|
instance_id string |
Идентификатор экземпляра. Возвращается: всегда Пример: |
|
instance_type string |
Размер типа работающего экземпляра. Возвращается: всегда Пример: |
|
key_name string |
Имя пары ключей, если экземпляр был запущен с привязанной парой ключей. Возвращается: всегда Пример: |
|
launch_time string |
Время запуска экземпляра. Возвращается: всегда Пример: |
|
maintenance_options dictionary |
Предоставляет информацию о параметрах восстановления и обслуживания экземпляра. Возвращается: всегда |
|
auto_recovery string |
Предоставляет информацию о текущем поведении автоматического восстановления экземпляра. Возвращается: при успешном выполнении Пример: |
|
metadata_options complex |
Параметры метаданных экземпляра. Возвращается: всегда |
|
http_endpoint string |
Указывает, включена или отключена конечная точка HTTP для метаданных экземпляров. Возвращается: при успешном выполнении Пример: |
|
http_protocol_ipv6 string |
Указывает, включена или отключена конечная точка IPv6 для службы метаданных экземпляра. Возвращается: при успешном выполнении Пример: |
|
http_put_response_hop_limit integer |
Максимальное количество переходов, которое может пройти токен метаданных. Возвращается: при успешном выполнении Пример: |
|
http_tokens string |
Указывает, требуется ли IMDSv2. Возвращается: при успешном выполнении Пример: |
|
instance_metadata_tags string |
Указывает, включен или отключен доступ к тегам экземпляра из его метаданных. Возвращается: при успешном выполнении Пример: |
|
state string |
Состояние изменения параметров метаданных. Возвращается: при успешном выполнении Пример: |
|
monitoring complex |
Параметры мониторинга экземпляра. Возвращается: всегда |
|
state string |
Указывает, включен ли подробный мониторинг. В противном случае включен базовый мониторинг. Возвращается: всегда Пример: |
|
network_interfaces complex |
Один или несколько сетевых интерфейсов экземпляра. Возвращается: всегда |
|
association complex |
Информация о связи эластичного адреса IPv4 с сетевым интерфейсом. Возвращается: всегда |
|
ip_owner_id string |
Идентификатор владельца эластичного IP-адреса. Возвращается: всегда Пример: |
|
public_dns_name string |
Общедоступное имя DNS. Возвращается: всегда Пример: |
|
public_ip string |
Публичный IP-адрес или эластичный IP-адрес, назначенный сетевому интерфейсу. Возвращается: всегда Пример: |
|
attachment complex |
Подключение сетевого интерфейса. Возвращается: всегда |
|
attach_time string |
Метка времени начала подключения. Возвращается: всегда Пример: |
|
attachment_id string |
Идентификатор подключения сетевого интерфейса. Возвращается: всегда Пример: |
|
delete_on_termination boolean |
Указывает, удаляется ли сетевой интерфейс при завершении работы экземпляра. Возвращается: всегда Пример: |
|
device_index integer |
Индекс устройства в экземпляре для подключения сетевого интерфейса. Возвращается: всегда Пример: |
|
network_card_index integer |
Индекс сетевой карты. Возвращается: всегда Пример: |
|
status string |
Состояние подключения. Возвращается: всегда Пример: |
|
description string |
Описание. Возвращается: всегда Пример: |
|
groups list / elements=dictionary |
Одна или несколько групп безопасности. Возвращается: всегда |
|
group_id string |
Идентификатор группы безопасности. Возвращается: всегда Пример: |
|
group_name string |
Имя группы безопасности. Возвращается: всегда Пример: |
|
interface_type string |
Тип сетевого интерфейса. Возвращается: всегда Пример: |
|
ipv6_addresses list / elements=dictionary |
Один или несколько IPv6-адресов, связанных с сетевым интерфейсом. Возвращается: всегда |
|
ipv6_address string |
IPv6-адрес. Возвращается: всегда Пример: |
|
mac_address string |
MAC-адрес. Возвращается: всегда Пример: |
|
network_interface_id string |
Идентификатор сетевого интерфейса. Возвращается: всегда Пример: |
|
owner_id string |
Идентификатор учетной записи AWS владельца сетевого интерфейса. Возвращается: всегда Пример: |
|
private_dns_name string |
Частное DNS-имя узла, назначенное экземпляру. Возвращается: всегда Пример: |
|
private_ip_address string |
IPv4-адрес сетевого интерфейса в подсети. Возвращается: всегда Пример: |
|
private_ip_addresses list / elements=dictionary |
Частные IPv4-адреса, связанные с сетевым интерфейсом. Возвращается: всегда |
|
association complex |
Сведения о назначении эластичного IP-адреса (IPv4), связанного с сетевым интерфейсом. Возвращается: при успешном выполнении |
|
ip_owner_id string |
Идентификатор владельца эластичного IP-адреса. Возвращается: всегда Пример: |
|
public_dns_name string |
Публичное DNS-имя. Возвращается: всегда Пример: |
|
public_ip string |
Публичный IP-адрес или эластичный IP-адрес, назначенный сетевому интерфейсу. Возвращается: всегда Пример: |
|
primary boolean |
Указывает, является ли этот IPv4-адрес основным частным IP-адресом сетевого интерфейса. Возвращается: всегда Пример: |
|
private_dns_name string |
Частное DNS-имя узла, назначенное экземпляру. Возвращается: всегда Пример: |
|
private_ip_address string |
Частный IPv4-адрес сетевого интерфейса. Возвращается: всегда Пример: |
|
source_dest_check boolean |
Указывает, включена ли проверка источника/назначения. Возвращается: всегда Пример: |
|
status string |
Состояние сетевого интерфейса. Возвращается: всегда Пример: |
|
subnet_id string |
Идентификатор подсети для сетевого интерфейса. Возвращается: всегда Пример: |
|
vpc_id string |
Идентификатор VPC для сетевого интерфейса. Возвращается: всегда Пример: |
|
placement complex |
Место запуска экземпляра, если применимо. Возвращается: всегда |
|
availability_zone string |
Зона доступности экземпляра. Возвращается: всегда Пример: |
|
group_name string |
Имя группы размещения, к которой относится экземпляр (для вычислительных экземпляров кластера). Возвращается: всегда Пример: |
|
tenancy string |
Тип размещения экземпляра (если экземпляр запущен в VPC). Возвращается: всегда Пример: |
|
platform_details string |
Значение сведений о платформе экземпляра. Возвращается: всегда Пример: |
|
private_dns_name string |
Частное DNS-имя. Возвращается: всегда Пример: |
|
private_dns_name_options dictionary |
Параметры имени узла экземпляра. Возвращается: при успешном выполнении |
|
enable_resource_name_dns_a_record boolean |
Указывает, следует ли отвечать на DNS-запросы для имен узлов экземпляров с помощью DNS-записей A. Возвращается: при успешном выполнении Пример: |
|
enable_resource_name_dns_aaaa_record boolean |
Указывает, следует ли отвечать на DNS-запросы для имен узлов экземпляров с помощью DNS-записей AAAA. Возвращается: при успешном выполнении Пример: |
|
hostname_type string |
Тип имени узла, назначаемого экземпляру. Возвращается: при успешном выполнении Пример: |
|
private_ip_address string |
IPv4-адрес сетевого интерфейса в подсети. Возвращается: всегда Пример: |
|
product_codes list / elements=dictionary |
Один или несколько кодов продукта. Возвращается: всегда |
|
product_code_id string |
Код продукта. Возвращается: всегда Пример: |
|
product_code_type string |
Тип кода продукта. Возвращается: всегда Пример: |
|
public_dns_name string |
Публичное DNS-имя, назначенное экземпляру. Возвращается: всегда |
|
public_ip_address string |
Публичный IPv4-адрес, назначенный экземпляру. Возвращается: всегда Пример: |
|
root_device_name string |
Имя устройства корневого устройства. Возвращается: всегда Пример: |
|
root_device_type string |
Тип корневого устройства, используемого AMI. Возвращается: всегда Пример: |
|
security_groups list / elements=dictionary |
Одна или несколько групп безопасности экземпляра. Возвращается: всегда |
|
group_id string |
Идентификатор группы безопасности. Возвращается: всегда Пример: |
|
group_name string |
Имя группы безопасности. Возвращается: всегда Пример: |
|
source_dest_check boolean |
Указывает, включена ли проверка источника и назначения. Возвращается: всегда Пример: |
|
state complex |
Текущее состояние экземпляра. Возвращается: всегда |
|
code integer |
Младший байт представляет состояние. Возвращается: всегда Пример: |
|
name string |
Название состояния. Возвращается: всегда Пример: |
|
state_transition_reason string |
Причина последнего перехода состояния. Возвращается: всегда |
|
subnet_id string |
Идентификатор подсети, в которой работает экземпляр. Возвращается: всегда Пример: |
|
tags dictionary |
Все теги, назначенные экземпляру. Возвращается: всегда |
|
virtualization_type string |
Тип виртуализации AMI. Возвращается: всегда Пример: |
|
vpc_id dictionary |
Идентификатор VPC, в которой находится экземпляр. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/ec2_instance_info_module.html