Spec-Zone.ru › Ansible

amazon.aws.ec2_ami_info модуль – Сбор информации об EC2 AMIs

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 8.2.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать его в playbook, укажите: amazon.aws.ec2_ami_info.

Добавлен в amazon.aws 1.0.0

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

Обзор

  • Сбор информации об EC2 AMIs.

Требования

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

  • 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 для согласованности с AWS botocore SDK.

Псевдоним 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

describe_image_attributes

boolean

Описать атрибуты (например, launchPermission) найденных образов.

Варианты:

  • 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.

executable_users

aliases: executable_user

list / elements=string

Фильтровать образы по пользователям с явными разрешениями на запуск. Допустимые параметры - идентификатор учетной записи AWS, self или all (общедоступные AMI).

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

filters

dictionary

Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра.

См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html для возможных фильтров.

Имена и значения фильтров чувствительны к регистру.

Значение по умолчанию: {}

image_ids

aliases: image_id

list / elements=string

Один или несколько идентификаторов образов.

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

owners

aliases: owner

list / elements=string

Отфильтровать образы по владельцу. Допустимые параметры - идентификатор учетной записи AWS, self или псевдоним владельца AWS ( amazon | aws-marketplace | microsoft ).

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

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, токен_доступа

строка

Токен сеанса 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 и токен_доступа устарели и будут удалены в релизе после 2024-12-01.

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

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

логическое

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

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

Варианты:

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible ‘хост’ и не из контекста ‘контроллер’. Поэтому, возможно, файлы необходимо явно скопировать на ‘хост’. Для плагинов поиска и подключения переменные среды и конфигурационные файлы читаются из контекста Ansible ‘контроллер’ и не из контекста ‘хост’.
  • SDK AWS (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 an AMI using ami-id
  amazon.aws.ec2_ami_info:
    image_ids: ami-5b488823

- name: gather information about all AMIs with tag key Name and value webapp
  amazon.aws.ec2_ami_info:
    filters:
      "tag:Name": webapp

- name: gather information about an AMI with 'AMI Name' equal to foobar
  amazon.aws.ec2_ami_info:
    filters:
      name: foobar

- name: gather information about Ubuntu 17.04 AMIs published by Canonical (099720109477)
  amazon.aws.ec2_ami_info:
    owners: 099720109477
    filters:
      name: "ubuntu/images/ubuntu-zesty-17.04-*"

Значения возврата

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

Ключ

Описание

images

список / элементы=словарь

Список образов.

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

architecture

строка

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

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

Пример: "x86_64"

block_device_mappings

список / элементы=словарь

Записи отображения блочных устройств.

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

device_name

строка

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

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

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

ebs

сложный

Тома EBS.

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

creation_date

строка

Дата и время создания образа.

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

Пример: "2017-10-16T19:22:13.000Z"

description

строка

Описание AMI.

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

Пример: ""

ena_support

логическое

Включена ли поддержка расширенной сети ENA.

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

Пример: true

hypervisor

строка

Тип гипервизора образа.

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

Пример: "xen"

image_id

строка

Идентификатор AMI.

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

Пример: "ami-5b466623"

image_location

строка

Расположение AMI.

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

Пример: "123456789012/Webapp"

image_type

строка

Тип образа.

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

Пример: "machine"

launch_permissions

список / элементы=словарь

Список AWS-аккаунтов, которые могут запустить AMI.

Возвращается: когда образ принадлежит вызывающему аккаунту и describe_image_attributes=true.

Пример: [{"group": "all"}, {"user_id": "123456789012"}]

group

строка

Значение «all» означает, что AMI общедоступен.

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

user_id

строка

Идентификатор AWS-аккаунта с разрешениями на запуск AMI.

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

name

строка

Имя AMI, предоставленное при создании образа.

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

Пример: "Webapp"

owner_id

строка

Идентификатор AWS-аккаунта владельца образа.

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

Пример: "123456789012"

platform_details

строка

Платформа образа.

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

Пример: "Windows"

public

boolean

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

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

Пример: true

root_device_name

строка

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

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

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

root_device_type

строка

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

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

Пример: "ebs"

sriov_net_support

строка

Включена ли расширенная поддержка сетевого взаимодействия.

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

Пример: "simple"

state

строка

Текущее состояние AMI.

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

Пример: "available"

tags

словарь

Любые теги, назначенные изображению.

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

usage_operation

строка

Операция экземпляра Amazon EC2 и код выставления счетов, связанный с AMI.

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

Пример: "RunInstances"

virtualization_type

строка

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

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

Пример: "hvm"

Авторы

  • Prasad Katti (@prasadkatti)

Ссылки на коллекцию

  • Отслеживание ошибок
  • Репозиторий (источники)
  • Общение

© 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_ami_info_module.html

Spec-Zone.ru

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