amazon.aws.ec2_import_image 模块 – 管理 AWS EC2 导入镜像任务

注意

此模块是 amazon.aws 集合（版本 9.0.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。

要在 Playbook 中使用它，请指定：amazon.aws.ec2_import_image。

amazon.aws 7.0.0 中的新增功能

概要

  • 将单个或多卷磁盘映像或 EBS 快照导入 Amazon Machine Image (AMI)。

  • 取消正在进行中的导入虚拟机任务。

要求

执行此模块的主机需要满足以下要求。

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

参数

参数

注释

access_key

别名：aws_access_key_id、aws_access_key、ec2_access_key

字符串

AWS 访问密钥 ID。

有关访问令牌的更多信息，请参阅 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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。

ec2_access_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。

对 EC2_ACCESS_KEY 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。

architecture

字符串

虚拟机的架构。

选项

  • "i386"

  • "x86_64"

aws_ca_bundle

路径

用于验证 SSL 证书的 CA 捆绑包的位置。

还可以使用 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 回调来输出 Playbook 期间发出的总列表。

还可以使用 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 快照的 ID。

url

字符串

要导入的基于 Amazon S3 的磁盘映像的 URL。该 URL 可以是 https URL (https://..) 或 Amazon S3 URL (s3://..)。

user_bucket

字典

磁盘映像的 S3 存储桶。

s3_bucket

字符串

磁盘映像所在的 Amazon S3 存储桶的名称。

s3_key

字符串

磁盘映像的文件名。

encrypted

布尔值

指定导入映像的目标 AMI 是否应加密。

默认情况下使用 EBS 的默认 KMS 密钥，除非您使用 kms_key_id 指定非默认 KMS 密钥。

选项

  • false

  • true

endpoint_url

别名：ec2_url、aws_endpoint_url、s3_url

字符串

要连接到的 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

字符串

目标虚拟机管理程序平台。

选项

  • "xen"

kms_key_id

字符串

用于创建加密 AMI 时使用的对称 KMS 密钥的标识符。 只有当您想使用非默认 KMS 密钥时，此参数才是必需的；如果未指定此参数，则使用 EBS 的默认 KMS 密钥。 如果指定了 kms_key_id，则还必须设置 encrypted 标志。

license_specifications

列表 / 元素=字典

许可证配置的 ARN。

license_configuration_arn

字符串

许可证配置的 ARN。

license_type

字符串

导入后将用于 Amazon Machine Image (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 和 security_token 选项互斥。

region

别名：aws_region, ec2_region

字符串

要使用的 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

字符串

在不使用默认角色“vmimport”时要使用的角色名称。

secret_key

别名：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 环境变量。

secret_key 和 profile 选项互斥。

为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。

ec2_secret_key 别名已弃用，将在 2024-12-01 之后的版本中删除。

对 EC2_SECRET_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。

session_token

别名：aws_session_token, security_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 环境变量。

security_token 和 profile 选项互斥。

别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数在 6.0.0 版本中从 security_token 重命名为 session_token。

security_token、aws_security_token 和 access_token 别名已弃用，将在 2024-12-01 之后的版本中删除。

对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。

state

字符串

使用 state=present 将单个或多卷磁盘映像或 EBS 快照导入到 Amazon Machine Image (AMI) 中。

使用 state=absent 取消正在进行中的导入虚拟机任务。

选项

  • "present" ← (默认)

  • "absent"

tags

别名：resource_tags

字典

在创建期间应用于导入映像任务的标签。

task_name

别名：name

string / required

EC2 映像导入任务的名称。

usage_operation

字符串

使用操作值。

validate_certs

布尔值

当设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。

强烈建议不要设置 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

复杂

一个包含有关 EC2 导入任务的信息的字典。

返回值：始终

architecture

字符串

虚拟机的架构。

返回值：成功

description

字符串

导入镜像任务的描述字符串。

返回值：成功

encrypted

布尔值

指定导入映像的目标 AMI 是否应加密。

返回值：成功

hypervisor

字符串

目标虚拟机管理程序平台。

返回值：成功

image_id

字符串

导入任务创建的 Amazon Machine Image (AMI) 的 ID。

返回值：成功

import_task_id

字符串

导入映像任务的任务 ID。

返回值：成功

kms_key_id

字符串

用于创建加密 AMI 的对称 KMS 密钥的标识符。

返回值：成功

license_specifications

字典

许可证配置的 ARN。

返回值：成功

license_type

字符串

导入后将用于 Amazon Machine Image (AMI) 的许可证类型。

返回值：成功

platform

字符串

虚拟机的操作系统。

返回值：成功

progress

字符串

任务的进度。

返回值：成功

role_name

字符串

在不使用默认角色“vmimport”时要使用的角色名称。

返回值：成功

snapshot_details

字典

描述从导入的磁盘创建的快照。

返回值：成功

description

字符串

快照的描述。

返回值：成功

device_name

字符串

快照的块设备映射。

返回值：成功

disk_image_size

浮点数

快照中磁盘的大小，以 GiB 为单位。

返回值：成功

format

字符串

从中创建快照的磁盘映像的格式。

返回值：成功

progress

字符串

任务的进度百分比。

返回值：成功

snapshot_id

字符串

正在导入的磁盘的快照 ID。

返回值：成功

status

字符串

快照创建的简要状态。

返回值：成功

status_message

字符串

快照创建的详细状态消息。

返回值：成功

url

字符串

用于访问磁盘映像的 URL。

返回值：成功

user_bucket

字典

磁盘映像的 Amazon S3 存储桶。

返回值：成功

status

字符串

任务的简要状态。

返回值：成功

status_message

字符串

导入任务的详细状态消息。

返回值：成功

tags

字典

在创建期间应用于导入映像任务的标签。

返回值：成功

task_name

字符串

EC2 映像导入任务的名称。

返回值：成功

usage_operation

字典

使用操作值。

返回值：成功

作者

  • Alina Buzachis (@alinabuzachis)