Модуль amazon.aws.ec2_instance_info – Сбор информации о экземплярах EC2 в AWS
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 8.2.1).
Возможно, эта коллекция уже установлена, если вы используете пакет 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.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string | Идентификатор ключа доступа 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 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения |
aws_ca_bundle path | Расположение пакета CA, используемого при проверке SSL-сертификатов. Переменная окружения |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs boolean | Использовать Переменная окружения Варианты:
|
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string | URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные окружения Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной окружения |
filters dictionary | Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html для возможных фильтров. Имена и значения фильтров чувствительны к регистру. Значение по умолчанию: |
include_attributes aliases: attributes list / elements=string добавлено в amazon.aws 6.3.0 | Описывает указанные атрибуты возвращаемых экземпляров. Варианты:
|
instance_ids list / elements=string | Если вы укажете один или несколько идентификаторов экземпляров, будут возвращены только экземпляры с указанными идентификаторами. Значение по умолчанию: |
minimum_uptime aliases: uptime integer | Минимальное время работы в минутах для экземпляров. Например, если |
profile aliases: aws_profile string | Именованный профиль AWS для использования для аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Переменная окружения Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token. |
region aliases: aws_region, ec2_region string | Регион AWS для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется. Переменные окружения См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной окружения |
ключ_секрета псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка | Секретный ключ доступа к AWS. Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры ключ_секрета и профиль взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK botocore AWS. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
токен_сессии псевдонимы: aws_session_token, токен_безопасности, aws_security_token, access_token строка | Токен сессии AWS STS для использования с временными учетными данными. Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры токен_безопасности и профиль взаимоисключающие. Псевдонимы aws_session_token и токен_сессии были добавлены в релизе 3.2.0, а параметр был переименован из токен_безопасности в токен_сессии в релизе 6.0.0. Псевдонимы токен_безопасности, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды |
проверять_сертификаты булево | При значении Установка проверять_сертификаты=false категорически не рекомендуется, в качестве альтернативы рассмотрите установку aws_ca_bundle вместо этого. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Поэтому файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
- AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из конфигурационных файлов в контексте 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_preference string |
Описывает предпочтения резервирования емкости. Возвращается: успех Пример: |
|
client_token string |
Токен идемпотентности, предоставленный вами при запуске экземпляра, если применимо. Возвращается: всегда Пример: |
|
cpu_options complex |
Параметры ЦП, установленные для экземпляра. Возвращается: всегда |
|
core_count integer |
Количество ядер ЦП для экземпляра. Возвращается: всегда Пример: |
|
threads_per_core integer |
Количество потоков на ядро ЦП. На поддерживаемых экземплярах значение 1 означает, что технология Intel Hyper-Threading отключена. Возвращается: всегда Пример: |
|
current_instance_boot_mode string |
Режим загрузки, используемый для загрузки экземпляра при запуске или старте. Returned: success Sample: |
|
ebs_optimized boolean |
Указывает, оптимизирован ли экземпляр для ввода-вывода EBS. Returned: always Sample: |
|
ena_support boolean |
Указывает, включена ли расширенная работа в сети с ENA. Returned: always Sample: |
|
enclave_options dictionary |
Указывает, включен ли экземпляр для Amazon Web Services Nitro Enclaves. Returned: success |
|
enabled boolean |
Если этот параметр установлен в true, экземпляр включен для Amazon Web Services Nitro Enclaves. Returned: always Sample: |
|
hibernation_options dictionary |
Указывает, включен ли экземпляр для гибернации. Returned: success |
|
configured boolean |
Если true, ваш экземпляр включен для гибернации; в противном случае он не включен для гибернации. Returned: always Sample: |
|
hypervisor string |
Тип гипервизора экземпляра. Returned: always Sample: |
|
iam_instance_profile complex |
Профиль экземпляра IAM, связанный с экземпляром, если применимо. Returned: success |
|
arn string |
Универсальное имя ресурса (ARN) профиля экземпляра. Returned: always Sample: |
|
id string |
Идентификатор профиля экземпляра. Returned: always Sample: |
|
image_id string |
Идентификатор AMI, используемый для запуска экземпляра. Returned: always Sample: |
|
instance_id string |
Идентификатор экземпляра. Returned: always Sample: |
|
instance_type string |
Размер типа экземпляра работающего экземпляра. Returned: always Sample: |
|
key_name string |
Имя пары ключей, если этот экземпляр был запущен с связанной парой ключей. Returned: always Sample: |
|
launch_time string |
Время запуска экземпляра. Returned: always Sample: |
|
maintenance_options dictionary |
Предоставляет информацию о параметрах восстановления и обслуживания вашего экземпляра. Returned: always |
|
авто_восстановление строка |
Предоставляет информацию о текущем поведении автоматического восстановления вашего экземпляра. Возвращается: успех Пример: |
|
параметры_метаданных сложный |
Параметры метаданных для экземпляра. Возвращается: всегда |
|
http_адрес строка |
Указывает, включен или выключен HTTP-адрес метаданных на ваших экземплярах. Возвращается: успех Пример: |
|
http_протокол_ipv6 строка |
Указывает, включен или выключен IPv6-адрес для службы метаданных экземпляра. Возвращается: успех Пример: |
|
http_put_ответ_предел_переходов целое число |
Максимальное количество переходов, которые может совершить маркер метаданных. Возвращается: успех Пример: |
|
http_токены строка |
Указывает, требуется ли IMDSv2. Возвращается: успех Пример: |
|
метки_метаданных_экземпляра строка |
Указывает, включен или выключен доступ к меткам экземпляра из метаданных экземпляра. Возвращается: успех Пример: |
|
состояние строка |
Состояние изменения параметров метаданных. Возвращается: успех Пример: |
|
мониторинг сложный |
Мониторинг экземпляра. Возвращается: всегда |
|
состояние строка |
Указывает, включен ли подробный мониторинг. В противном случае включен базовый мониторинг. Возвращается: всегда Пример: |
|
сетевые_интерфейсы сложный |
Один или несколько сетевых интерфейсов для экземпляра. Возвращается: всегда |
|
ассоциация сложный |
Информация об ассоциации для Elastic IPv4, связанного с сетевым интерфейсом. Возвращается: всегда |
|
id_владельца_ip строка |
ID владельца адреса Elastic IP. Возвращается: всегда Пример: |
|
общедоступное_имя_dns строка |
Общедоступное имя DNS. Возвращается: всегда Пример: |
|
общедоступный_ip строка |
Общедоступный IP-адрес или Elastic IP-адрес, привязанный к сетевому интерфейсу. Возвращается: всегда Пример: |
|
прикрепление сложный |
Прикрепление сетевого интерфейса. Возвращается: всегда |
|
время_присоединения строка |
Отметка времени начала прикрепления. Возвращается: всегда Пример: |
|
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 |
Информация об ассоциации для Elastic IP-адреса (IPv4), связанного с сетевым интерфейсом. Возвращается: успех |
|
ip_owner_id string |
Идентификатор владельца Elastic IP-адреса. Возвращается: всегда Пример: |
|
public_dns_name string |
Публичное DNS-имя. Возвращается: всегда Пример: |
|
public_ip string |
Публичный IP-адрес или Elastic 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 |
Текущее состояние экземпляра. Возвращается: всегда |
|
код целое число |
Низкий байт представляет состояние. Возвращается: всегда Пример: |
|
название строка |
Имя состояния. Возвращается: всегда Пример: |
|
причина_перехода_состояния строка |
Причина последнего перехода состояния. Возвращается: всегда |
|
идентификатор_подсети строка |
Идентификатор подсети, в которой работает экземпляр. Возвращается: всегда Пример: |
|
метки словарь |
Любые метки, назначенные экземпляру. Возвращается: всегда |
|
тип_виртуализации строка |
Тип виртуализации AMI. Возвращается: всегда Пример: |
|
идентификатор_vpc словарь |
Идентификатор VPC, в котором находится экземпляр. Возвращается: всегда Пример: |
Ссылки на сборки
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/ec2_instance_info_module.html