Модуль amazon.aws.ec2_import_image — управление задачами импорта образов AWS EC2

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.ec2_import_image.

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

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Импорт отдельных или многотомных образов дисков либо снимков EBS в образ виртуальной машины Amazon (AMI).
Отмена выполняющейся задачи импорта виртуальной машины.

Требования

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

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_ID` или `AWS_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласования с AWS botocore SDK.
architecture строка	Архитектура виртуальной машины. Варианты: `"i386"` `"x86_64"`
aws_ca_bundle путь	Расположение пакета центров сертификации (CA), используемого для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Описание параметров приведено в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
boot_mode строка	Режим загрузки виртуальной машины. Варианты: `"legacy-bios"` `"uefi"`
cancel_reason строка	Причина отмены задачи.
client_data словарь	Данные, относящиеся к клиенту.
comment строка	Комментарий пользователя об отправке диска.
upload_end строка	Время завершения отправки диска.
upload_size число с плавающей точкой	Размер отправленного образа диска в ГиБ.
upload_start строка	Время начала отправки диска.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и выводить этот набор в ключ resource_actions результатов задачи. Используйте обратный вызов `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в ходе плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
description строка	Строка с описанием задачи импорта образа.
disk_containers список / элементы=словарь	Сведения о контейнерах дисков.
description строка	Описание образа диска.
device_name строка	Сопоставление блочного устройства для диска.
format строка	Формат импортируемого образа диска. Варианты: `"OVA"` `"ova"` `"VHD"` `"vhd"` `"VHDX"` `"vhdx"` `"VMDK"` `"vmdk"` `"RAW"` `"raw"`
snapshot_id строка	Идентификатор снимка EBS, используемого для импорта снимка.
url строка	URL образа диска в Amazon S3, который импортируется. URL может быть HTTPS-адресом (https://..) или адресом Amazon S3 (s3://..).
user_bucket словарь	Бакет S3 для образа диска.
s3_bucket строка	Имя бакета Amazon S3, в котором находится образ диска.
s3_key строка	Имя файла образа диска.
encrypted логическое значение	Указывает, следует ли шифровать целевой AMI импортированного образа. Используется ключ KMS EBS по умолчанию, если вы не укажете нестандартный ключ KMS с помощью `kms_key_id`. Варианты: `false` `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws проверяются только с AWS. Также можно использовать переменную среды `AWS_URL`.
hypervisor строка	Целевая платформа гипервизора. Варианты: `"xen"`
kms_key_id строка	Идентификатор симметричного ключа KMS, используемого при создании зашифрованного AMI. Этот параметр требуется только в том случае, если необходимо использовать нестандартный ключ KMS; если параметр не указан, используется ключ KMS EBS по умолчанию. Если указан `kms_key_id`, необходимо также установить флаг `encrypted`.
license_specifications список / элементы=словарь	ARN конфигураций лицензий.
license_configuration_arn строка	ARN конфигурации лицензии.
license_type строка	Тип лицензии, используемый для образа виртуальной машины Amazon (AMI) после импорта.
platform строка	Операционная система виртуальной машины. Варианты: `"Windows"` `"Linux"`
profile псевдонимы: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.
region псевдонимы: aws_region строка	Регион AWS, который следует использовать. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
role_name строка	Имя роли, используемой вместо роли по умолчанию «vmimport».
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. Также можно использовать переменные среды `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласования с AWS botocore SDK.
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. Также можно использовать переменную среды `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
state строка	Используйте `state=present` для импорта отдельных или многотомных образов дисков либо снимков EBS в образ виртуальной машины Amazon (AMI). Используйте `state=absent` для отмены выполняющейся задачи импорта виртуальной машины. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags псевдонимы: resource_tags словарь	Теги, применяемые к задаче импорта образа при ее создании.
task_name псевдонимы: name строка / обязательный	Имя задачи импорта образа EC2.
usage_operation строка	Значение операции использования.
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты при обмене данными с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» 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: Import image
  amazon.aws.ec2_import_image:
    state: present
    task_name: "clone-vm-import-image"
    disk_containers:
      - format: raw
        user_bucket:
          s3_bucket: "clone-vm-s3-bucket"
          s3_key: "clone-vm-s3-bucket/ubuntu-vm-clone.raw"

- name: Cancel an import image task
  amazon.aws.ec2_import_image:
    state: absent
    task_name: "clone-vm-import-image"

Возвращаемые значения

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

Ключ	Описание
import_image complex	Словарь с информацией о задаче импорта EC2. Возвращается: всегда
architecture string	Архитектура виртуальной машины. Возвращается: при успехе
description string	Строка с описанием задачи импорта образа. Возвращается: при успехе
encrypted boolean	Указывает, следует ли зашифровать целевой AMI импортированного образа. Возвращается: при успехе
hypervisor string	Целевая платформа гипервизора. Возвращается: при успехе
image_id string	Идентификатор Amazon Machine Image (AMI), созданного задачей импорта. Возвращается: при успехе
import_task_id string	Идентификатор задачи импорта образа. Возвращается: при успехе
kms_key_id string	Идентификатор симметричного ключа KMS, использованного для создания зашифрованного AMI. Возвращается: при успехе
license_specifications dictionary	ARN конфигураций лицензий. Возвращается: при успехе
license_type string	Тип лицензии для Amazon Machine Image (AMI) после импорта. Возвращается: при успехе
platform string	Операционная система виртуальной машины. Возвращается: при успехе
progress string	Ход выполнения задачи. Возвращается: при успехе
role_name string	Имя роли, используемой вместо роли по умолчанию «vmimport». Возвращается: при успехе
snapshot_details dictionary	Описание снимка, созданного на основе импортированного диска. Возвращается: при успехе
description string	Описание снимка. Возвращается: при успехе
device_name string	Сопоставление блочного устройства для снимка. Возвращается: при успехе
disk_image_size float	Размер диска в снимке, в ГиБ. Возвращается: при успехе
format string	Формат образа диска, на основе которого создан снимок. Возвращается: при успехе
progress string	Процент выполнения задачи. Возвращается: при успехе
snapshot_id string	Идентификатор снимка импортируемого диска. Возвращается: при успехе
status string	Краткий статус создания снимка. Возвращается: при успехе
status_message string	Подробное сообщение о статусе создания снимка. Возвращается: при успехе
url string	URL для доступа к образу диска. Возвращается: при успехе
user_bucket dictionary	Бакет Amazon S3 для образа диска. Возвращается: при успехе
status string	Краткий статус задачи. Возвращается: при успехе
status_message string	Подробное сообщение о статусе задачи импорта. Возвращается: при успехе
tags dictionary	Теги, применяемые к задаче импорта образа при создании. Возвращается: при успехе
task_name string	Имя задачи импорта образа EC2. Возвращается: при успехе
usage_operation dictionary	Значение операции использования. Возвращается: при успехе

Авторы

Alina Buzachis (@alinabuzachis)

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

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