Spec-Zone.ru › Ansible

Модуль 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_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY также могут использоваться в порядке убывания предпочтения.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной окружения EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

path

Расположение пакета CA, используемого при проверке SSL-сертификатов.

Переменная окружения AWS_CA_BUNDLE также может использоваться.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

Использовать botocore.endpoint журналирование для анализа уникальных (а не общих) "resource:action" вызовов API, выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте aws_resource_action обратный вызов для вывода полного списка, сделанного во время playbook.

Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может использоваться.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS.

Переменные окружения AWS_URL или EC2_URL также могут использоваться в порядке убывания предпочтения.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной окружения EC2_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

Описывает указанные атрибуты возвращаемых экземпляров.

Варианты:

  • "instanceType"
  • "kernel"
  • "ramdisk"
  • "userData"
  • "disableApiTermination"
  • "instanceInitiatedShutdownBehavior"
  • "rootDeviceName"
  • "blockDeviceMapping"
  • "productCodes"
  • "sourceDestCheck"
  • "groupSet"
  • "ebsOptimized"
  • "sriovNetSupport"
  • "enclaveOptions"
  • "disableApiStop"

instance_ids

list / elements=string

Если вы укажете один или несколько идентификаторов экземпляров, будут возвращены только экземпляры с указанными идентификаторами.

Значение по умолчанию: []

minimum_uptime

aliases: uptime

integer

Минимальное время работы в минутах для экземпляров. Например, если uptime равно 60, вернет все экземпляры, работающие более 60 минут.

profile

aliases: aws_profile

string

Именованный профиль AWS для использования для аутентификации.

См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Переменная окружения AWS_PROFILE также может использоваться.

Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token.

region

aliases: aws_region, ec2_region

string

Регион AWS для использования.

Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется.

Переменные окружения AWS_REGION или EC2_REGION также могут использоваться.

См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной окружения EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

ключ_секрета

псевдонимы: 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, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры ключ_секрета и профиль взаимоисключающие.

Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK botocore AWS.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды 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, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры токен_безопасности и профиль взаимоисключающие.

Псевдонимы aws_session_token и токен_сессии были добавлены в релизе 3.2.0, а параметр был переименован из токен_безопасности в токен_сессии в релизе 6.0.0.

Псевдонимы токен_безопасности, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

проверять_сертификаты

булево

При значении false, сертификаты SSL для связи с API AWS не будут проверены.

Установка проверять_сертификаты=false категорически не рекомендуется, в качестве альтернативы рассмотрите установку aws_ca_bundle вместо этого.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста 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, который можно использовать для поиска этого экземпляра в группе запуска.

Возвращается: всегда

Пример: 0

architecture

string

Архитектура образа.

Возвращается: всегда

Пример: "x86_64"

attributes

dictionary

добавлено в amazon.aws 6.3.0

Подробная информация об атрибуте экземпляра, указанном на входе.

Возвращается: когда include_attributes указан

Пример: {"disable_api_termination": {"value": true}, "ebs_optimized": {"value": true}}

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

Состояние подключения.

Возвращается: всегда

Пример: "attached"

volume_id

string

ИД тома EBS.

Возвращается: всегда

Пример: "vol-12345678"

capacity_reservation_specification

complex

Информация о параметре целевого резервирования емкости.

Возвращается: успех

capacity_reservation_preference

string

Описывает предпочтения резервирования емкости.

Возвращается: успех

Пример: "open"

client_token

string

Токен идемпотентности, предоставленный вами при запуске экземпляра, если применимо.

Возвращается: всегда

Пример: "mytoken"

cpu_options

complex

Параметры ЦП, установленные для экземпляра.

Возвращается: всегда

core_count

integer

Количество ядер ЦП для экземпляра.

Возвращается: всегда

Пример: 1

threads_per_core

integer

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

Возвращается: всегда

Пример: 1

current_instance_boot_mode

string

Режим загрузки, используемый для загрузки экземпляра при запуске или старте.

Returned: success

Sample: "legacy-bios"

ebs_optimized

boolean

Указывает, оптимизирован ли экземпляр для ввода-вывода EBS.

Returned: always

Sample: false

ena_support

boolean

Указывает, включена ли расширенная работа в сети с ENA.

Returned: always

Sample: true

enclave_options

dictionary

Указывает, включен ли экземпляр для Amazon Web Services Nitro Enclaves.

Returned: success

enabled

boolean

Если этот параметр установлен в true, экземпляр включен для Amazon Web Services Nitro Enclaves.

Returned: always

Sample: false

hibernation_options

dictionary

Указывает, включен ли экземпляр для гибернации.

Returned: success

configured

boolean

Если true, ваш экземпляр включен для гибернации; в противном случае он не включен для гибернации.

Returned: always

Sample: false

hypervisor

string

Тип гипервизора экземпляра.

Returned: always

Sample: "xen"

iam_instance_profile

complex

Профиль экземпляра IAM, связанный с экземпляром, если применимо.

Returned: success

arn

string

Универсальное имя ресурса (ARN) профиля экземпляра.

Returned: always

Sample: "arn:aws:iam::123456789012:instance-profile/myprofile"

id

string

Идентификатор профиля экземпляра.

Returned: always

Sample: "JFJ397FDG400FG9FD1N"

image_id

string

Идентификатор AMI, используемый для запуска экземпляра.

Returned: always

Sample: "ami-0011223344"

instance_id

string

Идентификатор экземпляра.

Returned: always

Sample: "i-012345678"

instance_type

string

Размер типа экземпляра работающего экземпляра.

Returned: always

Sample: "t2.micro"

key_name

string

Имя пары ключей, если этот экземпляр был запущен с связанной парой ключей.

Returned: always

Sample: "my-key"

launch_time

string

Время запуска экземпляра.

Returned: always

Sample: "2017-03-23T22:51:24+00:00"

maintenance_options

dictionary

Предоставляет информацию о параметрах восстановления и обслуживания вашего экземпляра.

Returned: always

авто_восстановление

строка

Предоставляет информацию о текущем поведении автоматического восстановления вашего экземпляра.

Возвращается: успех

Пример: "default"

параметры_метаданных

сложный

Параметры метаданных для экземпляра.

Возвращается: всегда

http_адрес

строка

Указывает, включен или выключен HTTP-адрес метаданных на ваших экземплярах.

Возвращается: успех

Пример: "enabled"

http_протокол_ipv6

строка

Указывает, включен или выключен IPv6-адрес для службы метаданных экземпляра.

Возвращается: успех

Пример: "disabled"

http_put_ответ_предел_переходов

целое число

Максимальное количество переходов, которые может совершить маркер метаданных.

Возвращается: успех

Пример: 1

http_токены

строка

Указывает, требуется ли IMDSv2.

Возвращается: успех

Пример: "optional"

метки_метаданных_экземпляра

строка

Указывает, включен или выключен доступ к меткам экземпляра из метаданных экземпляра.

Возвращается: успех

Пример: "disabled"

состояние

строка

Состояние изменения параметров метаданных.

Возвращается: успех

Пример: "applied"

мониторинг

сложный

Мониторинг экземпляра.

Возвращается: всегда

состояние

строка

Указывает, включен ли подробный мониторинг. В противном случае включен базовый мониторинг.

Возвращается: всегда

Пример: "disabled"

сетевые_интерфейсы

сложный

Один или несколько сетевых интерфейсов для экземпляра.

Возвращается: всегда

ассоциация

сложный

Информация об ассоциации для Elastic IPv4, связанного с сетевым интерфейсом.

Возвращается: всегда

id_владельца_ip

строка

ID владельца адреса Elastic IP.

Возвращается: всегда

Пример: "amazon"

общедоступное_имя_dns

строка

Общедоступное имя DNS.

Возвращается: всегда

Пример: ""

общедоступный_ip

строка

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

Возвращается: всегда

Пример: "1.2.3.4"

прикрепление

сложный

Прикрепление сетевого интерфейса.

Возвращается: всегда

время_присоединения

строка

Отметка времени начала прикрепления.

Возвращается: всегда

Пример: "2017-03-23T22:51:24+00:00"

END_OF_DOCUMENT_MARKER

attachment_id

string

Идентификатор вложения сетевого интерфейса.

Возвращается: всегда

Пример: "eni-attach-3aff3f"

delete_on_termination

boolean

Указывает, удаляется ли сетевой интерфейс при завершении работы экземпляра.

Возвращается: всегда

Пример: true

device_index

integer

Индекс устройства на экземпляре для вложения сетевого интерфейса.

Возвращается: всегда

Пример: 0

network_card_index

integer

Индекс сетевой карты.

Возвращается: всегда

Пример: 0

status

string

Состояние вложения.

Возвращается: всегда

Пример: "attached"

description

string

Описание.

Возвращается: всегда

Пример: "My interface"

groups

list / elements=dictionary

Одна или несколько групп безопасности.

Возвращается: всегда

group_id

string

Идентификатор группы безопасности.

Возвращается: всегда

Пример: "sg-abcdef12"

group_name

string

Имя группы безопасности.

Возвращается: всегда

Пример: "mygroup"

interface_type

string

Тип сетевого интерфейса.

Возвращается: всегда

Пример: "interface"

ipv6_addresses

list / elements=dictionary

Один или несколько IPv6-адресов, связанных с сетевым интерфейсом.

Возвращается: всегда

ipv6_address

string

IPv6-адрес.

Возвращается: всегда

Пример: "2001:0db8:85a3:0000:0000:8a2e:0370:7334"

mac_address

string

MAC-адрес.

Возвращается: всегда

Пример: "00:11:22:33:44:55"

network_interface_id

string

Идентификатор сетевого интерфейса.

Возвращается: всегда

Пример: "eni-01234567"

owner_id

string

Идентификатор учетной записи AWS владельца сетевого интерфейса.

Возвращается: всегда

Пример: "01234567890"

private_dns_name

string

Имя частного хоста DNS, назначенное экземпляру.

Возвращается: всегда

Пример: "ip-10-1-0-156.ec2.internal"

private_ip_address

string

IPv4-адрес сетевого интерфейса в подсети.

Возвращается: всегда

Пример: "10.0.0.1"

private_ip_addresses

list / elements=dictionary

Частные IPv4-адреса, связанные с сетевым интерфейсом.

Возвращается: всегда

association

complex

Информация об ассоциации для Elastic IP-адреса (IPv4), связанного с сетевым интерфейсом.

Возвращается: успех

ip_owner_id

string

Идентификатор владельца Elastic IP-адреса.

Возвращается: всегда

Пример: "amazon"

public_dns_name

string

Публичное DNS-имя.

Возвращается: всегда

Пример: ""

public_ip

string

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

Возвращается: всегда

Пример: "1.2.3.4"

primary

boolean

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

Возвращается: всегда

Пример: true

private_dns_name

string

Имя частного хост-имени DNS, назначенное экземпляру.

Возвращается: всегда

Пример: "ip-10-1-0-156.ec2.internal"

private_ip_address

string

Частный IPv4-адрес сетевого интерфейса.

Возвращается: всегда

Пример: "10.0.0.1"

source_dest_check

boolean

Указывает, включена ли проверка источника/назначения.

Возвращается: всегда

Пример: true

status

string

Состояние сетевого интерфейса.

Возвращается: всегда

Пример: "in-use"

subnet_id

string

Идентификатор подсети для сетевого интерфейса.

Возвращается: всегда

Пример: "subnet-0123456"

vpc_id

string

Идентификатор VPC для сетевого интерфейса.

Возвращается: всегда

Пример: "vpc-0123456"

placement

complex

Местоположение, где запущен экземпляр, если применимо.

Возвращается: всегда

availability_zone

string

Зона доступности экземпляра.

Возвращается: всегда

Пример: "ap-southeast-2a"

group_name

string

Имя группы размещения, в которой находится экземпляр (для вычислительных экземпляров кластера).

Возвращается: всегда

Пример: ""

tenancy

string

Тип владения экземпляра (если экземпляр работает в VPC).

Возвращается: всегда

Пример: "default"

platform_details

string

Значение подробных сведений о платформе для экземпляра.

Возвращается: всегда

Пример: "Linux/UNIX"

private_dns_name

string

Приватное DNS-имя.

Возвращается: всегда

Пример: "ip-10-0-0-1.ap-southeast-2.compute.internal"

private_dns_name_options

dictionary

Параметры имени хоста экземпляра.

Возвращается: успех

enable_resource_name_dns_a_record

boolean

Указывает, следует ли отвечать на DNS-запросы для имен хостов экземпляров с помощью DNS A-записей.

Возвращается: успех

Пример: false

enable_resource_name_dns_aaaa_record

boolean

Указывает, следует ли отвечать на DNS-запросы для имен хостов экземпляров с помощью DNS AAAA-записей.

Возвращается: успех

Пример: false

hostname_type

string

Тип имени хоста, который нужно назначить экземпляру.

Возвращается: успех

Пример: "ip-name"

private_ip_address

string

IPv4-адрес сетевого интерфейса в подсети.

Возвращается: всегда

Пример: "10.0.0.1"

product_codes

list / elements=dictionary

Один или несколько кодов продукта.

Возвращается: всегда

product_code_id

string

Код продукта.

Возвращается: всегда

Пример: "aw0evgkw8ef3n2498gndfgasdfsd5cce"

product_code_type

string

Тип кода продукта.

Возвращается: всегда

Пример: "marketplace"

public_dns_name

string

Публичное DNS-имя, назначенное экземпляру.

Возвращается: всегда

public_ip_address

string

Публичный IPv4-адрес, назначенный экземпляру.

Возвращается: всегда

Пример: "52.0.0.1"

root_device_name

string

Имя устройства корневого раздела.

Возвращается: всегда

Пример: "/dev/sda1"

root_device_type

string

Тип корневого устройства, используемого AMI.

Возвращается: всегда

Пример: "ebs"

security_groups

list / elements=dictionary

Одна или несколько групп безопасности для экземпляра.

Возвращается: всегда

group_id

string

Идентификатор группы безопасности.

Возвращается: всегда

Пример: "sg-0123456"

group_name

string

Имя группы безопасности.

Возвращается: всегда

Пример: "my-security-group"

source_dest_check

boolean

Указывает, включена ли проверка источника/назначения.

Возвращается: всегда

Пример: true

state

complex

Текущее состояние экземпляра.

Возвращается: всегда

код

целое число

Низкий байт представляет состояние.

Возвращается: всегда

Пример: 16

название

строка

Имя состояния.

Возвращается: всегда

Пример: "running"

причина_перехода_состояния

строка

Причина последнего перехода состояния.

Возвращается: всегда

идентификатор_подсети

строка

Идентификатор подсети, в которой работает экземпляр.

Возвращается: всегда

Пример: "subnet-00abcdef"

метки

словарь

Любые метки, назначенные экземпляру.

Возвращается: всегда

тип_виртуализации

строка

Тип виртуализации AMI.

Возвращается: всегда

Пример: "hvm"

идентификатор_vpc

словарь

Идентификатор VPC, в котором находится экземпляр.

Возвращается: всегда

Пример: "vpc-0011223344"

Авторы

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

Ссылки на сборки

  • Трекер проблем
  • Репозиторий (источники)
  • Связь

© 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

Spec-Zone.ru

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