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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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 Machine Image (AMI).
Отмена задачи виртуальной машины в процессе импорта.

Требования

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

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	ID ключа доступа 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.
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 число с плавающей точкой	Размер загруженного образа диска в GiB.
upload_start строка	Время начала загрузки диска.
debug_botocore_endpoint_logs логический	Используйте `botocore.endpoint` логирование для анализа уникальных (а не всех) `"resource:action"` API-вызовов, сделанных во время задачи, выводя набор в ключ 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 строка	ID снимка EBS, который будет использован для импорта снимка.
url строка	URL изображения диска на основе Amazon S3. URL может быть либо https URL (https://..) или URL Amazon S3 (s3://..).
user_bucket словарь	Ведро S3 для изображения диска.
s3_bucket строка	Имя ведра Amazon S3, где находится изображение диска.

END_OF_DOCUMENT_MARKER

s3_key string	Имя файла образа диска.
encrypted boolean	Указывает, следует ли шифровать целевой AMI импортированного образа. Используется стандартный ключ KMS для EBS, если не указан другой ключ KMS с помощью `kms_key_id`. Варианты: `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.
hypervisor string	Целевая платформа гипервизора. Варианты: `"xen"`
kms_key_id string	Идентификатор симметричного ключа KMS, который будет использоваться при создании зашифрованного AMI. Этот параметр требуется только если вы хотите использовать ключ KMS, отличный от стандартного; если этот параметр не указан, используется стандартный ключ KMS для EBS. Если указан `kms_key_id`, то необходимо также установить флаг `encrypted`.
license_specifications list / elements=dictionary	ARN-ы конфигураций лицензий.
license_configuration_arn string	ARN конфигурации лицензии.
license_type string	Тип лицензии, который будет использоваться для Amazon Machine Image (AMI) после импорта.
platform string	Операционная система виртуальной машины. Варианты: `"Windows"` `"Linux"`
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.
role_name string	Имя роли для использования, если нужно не использовать стандартную роль «vmimport».
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	Секретный ключ доступа 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`, в порядке убывания приоритета. Параметры secret_key и profile несовместимы. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для соответствия SDK botocore AWS. Псевдоним ec2_secret_key устарел и будет удален в выпуске после 2024-12-01. Поддержка переменной окружения `EC2_SECRET_KEY` устарела и будет удалена в выпуске после 2024-12-01.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	Маркер сеанса 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`, в порядке убывания приоритета. Параметры security_token и profile несовместимы. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в выпуске после 2024-12-01. Поддержка переменных окружения `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в выпуске после 2024-12-01.

state string	Используйте `state=present`, чтобы импортировать образы дисков с одним или несколькими томами или снимки EBS в Amazon Machine Image (AMI). Используйте `state=absent`, чтобы отменить задачу импорта виртуальной машины, которая выполняется в данный момент. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags aliases: resource_tags dictionary	Теги, которые необходимо применить к задаче импорта образа при создании.
task_name aliases: name string / обязательно	Имя задачи импорта образа EC2.
usage_operation string	Значение операции использования.
validate_certs boolean	Если установлено значение `false`, сертификаты SSL не будут проверены при общении с API AWS. Установка validate_certs=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: 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 сложный	Словарь, содержащий информацию о задаче импорта EC2. Возвращается: всегда
architecture строка	Архитектура виртуальной машины. Возвращается: успешно
description строка	Строка описания задачи импорта изображения. Возвращается: успешно
encrypted булево	Указывает, следует ли шифровать целевой AMI импортированного изображения. Возвращается: успешно
hypervisor строка	Целевая платформа гипервизора. Возвращается: успешно
image_id строка	Идентификатор Amazon Machine Image (AMI), созданного задачей импорта. Возвращается: успешно

END_OF_DOCUMENT_MARKER

status_message string	Подробное сообщение о статусе создания моментальной копии. Возвращаемое значение: success
url string	URL для доступа к диску с образом. Возвращаемое значение: success
user_bucket dictionary	Ведро Amazon S3 для диска с образом. Возвращаемое значение: success
status string	Краткое состояние задачи. Возвращаемое значение: success
status_message string	Подробное сообщение о статусе задачи импорта. Возвращаемое значение: success
tags dictionary	Теги для применения к задаче импорта образа во время создания. Возвращаемое значение: success
task_name string	Имя задачи импорта образа EC2. Возвращаемое значение: success
usage_operation dictionary	Значение операции использования. Возвращаемое значение: success

Авторы

Alina Buzachis (@alinabuzachis)

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

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