amazon.aws.ec2_import_image_info 模块 – 收集导入虚拟机任务信息

注意

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

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

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

要在剧本中使用它，请指定：amazon.aws.ec2_import_image_info。

amazon.aws 7.0.0 中的新增功能

概要

  • 显示有关已创建的导入虚拟机任务的详细信息。

要求

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

  • 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 之后的一个版本中删除。

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。

debug_botocore_endpoint_logs

布尔值

使用 botocore.endpoint 日志记录器来解析在任务期间进行的唯一（而不是全部）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到剧本期间进行的全部列表。

还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • 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 之后的一个版本中删除。

filters

列表 / 元素=字典

要应用的过滤器字典。每个字典项包含一个过滤器键和一个过滤器值。

有关可能的过滤器，请参见 https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImportImageTasks.html。

import_task_ids

别名：ids

列表 / 元素=字符串

导入映像任务的 ID。

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之后的一个版本中移除。

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保持一致，aws_secret_access_key 别名在5.1.0版本中添加。

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之后的一个版本中移除。

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: Check status of import image
  amazon.aws.ec2_import_image_info:
    filters:
      - Name: "tag:Name"
        Values: ["clone-vm-import-image"]
      - Name: "task-state"
        Values: ["completed", "active"]

返回值

常用的返回值已在此处记录，以下是此模块独有的字段

键

描述

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)