Spec-Zone.ru › Ansible 2.11

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

Примечание

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

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

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

Новое в версии 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 считывается со стороны «модуля» и, возможно, должен быть явно скопирован с контроллера, если он не запускается локально.
aws_config
словарь
Словарь для изменения конфигурации botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации 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:action", выполняемых во время задачи, выводящих набор в ключ 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
integer
всегда
Индекс запуска AMI, который можно использовать для поиска этого экземпляра в группе запуска.
architecture
string
всегда
Архитектура образа

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

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

Пример:
2017-03-23T22:51:24+00:00
delete_on_termination
boolean
всегда
Указывает, удаляется ли том при завершении работы экземпляра.

Пример:
True
status
string
всегда
Состояние подключения.

Пример:
подключено
volume_id
string
всегда
Идентификатор тома EBS

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

Пример:
mytoken
cpu_options
complex
всегда, если версия botocore >= 1.10.16
Настройки процессора для экземпляра.
core_count
integer
всегда
Количество ядер процессора для экземпляра.

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

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

Пример:
xen
iam_instance_profile
complex
всегда
Профиль IAM экземпляра, связанный с экземпляром, если применимо.
arn
string
всегда
Amazon Resource Name (ARN) профиля экземпляра.

Пример:
arn:aws:iam::000012345678:instance-profile/myprofile
id
string
всегда
Идентификатор профиля экземпляра

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

Пример:
ami-0011223344
instance_id
string
всегда
Идентификатор экземпляра.

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

Пример:
t2.micro
key_name
string
всегда
Имя пары ключей, если этот экземпляр был запущен с связанной парой ключей.

Пример:
my-key
launch_time
string
всегда
Время запуска экземпляра.

Пример:
2017-03-23T22:51:24+00:00
monitoring
complex
всегда
Мониторинг экземпляра.
state
string
всегда
Указывает, включен ли подробный мониторинг. В противном случае включен базовый мониторинг.

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

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

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

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

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

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

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

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

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

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

Пример:
по умолчанию
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


Авторы

  • Michael Schuett (@michaeljs1990)
  • Rob White (@wimnat)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/ec2_instance_info_module.html

Spec-Zone.ru

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