amazon.aws.ec2_vol 模块 – 创建并附加卷，返回卷 ID 和设备映射

注意

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

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

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

要在 playbook 中使用它，请指定：amazon.aws.ec2_vol。

amazon.aws 1.0.0 中的新功能

概要

• 创建一个 EBS 卷，并可选择将其附加到实例。

• 如果同时给出 实例 和 名称，并且实例在设备名称处有一个设备，则不会创建卷，也不会进行附加。

要求

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

• 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_access_key_id 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 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 回调输出到 playbook 期间制作的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选择 false ← (默认) true
delete_on_termination 布尔值	设置为 true 时，卷将在实例终止时删除。 选择 false ← (默认) true
device_name 字符串	用于覆盖设备映射的设备 ID。对于 Linux/UNIX，假设为 /dev/sdf，对于 Windows，假设为 /dev/xvdf。
encrypted 布尔值	为此卷启用静态加密。 选择 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 之后的版本中移除。
id 字符串	如果要挂载现有卷（需要实例）或删除现有卷，则为卷 ID。
instance 字符串	如果要挂载卷，则为实例 ID。 设置为 None 以分离卷。
iops 整数	您要与此卷关联的预置 IOPs（整数）。
kms_key_id 字符串	指定要使用的 KMS 密钥的 ID。
modify_volume 布尔值 在 amazon.aws 1.4.0 中添加	除非此键为 true，否则不会修改卷。 选择 false ← (默认) true
multi_attach 布尔值 在 amazon.aws 2.0.0 中添加	如果设置为 true，则在创建卷时将启用多重挂载。 当您创建新卷时，默认情况下禁用多重挂载。 此参数仅支持 io1 和 io2 卷。 选择 false true
name 字符串	如果要挂载现有卷（需要实例），则为卷名称标签。
outpost_arn 字符串 在 amazon.aws 3.1.0 中添加	Outpost 的亚马逊资源名称 (ARN)。 如果设置，则允许在 Outpost 中创建卷。
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 选项互斥。
purge_tags 布尔值	如果 purge_tags=true 且设置了 tags，则现有标签将从资源中清除，以完全匹配 tags 参数定义的标签。 如果未设置 tags 参数，则不会修改标签，即使 purge_tags=True 也是如此。 以 aws: 开头的标签键由 Amazon 保留，无法修改。因此，它们将被 purge_tags 参数忽略。有关更多信息，请参阅 Amazon 文档 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。 选择 false true ← (默认)
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_secret_access_key 别名已在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 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 之后的版本中移除。
snapshot 字符串	要作为卷基础的快照 ID。
state 字符串	是否确保卷存在或不存在。 state=list 已在 1.1.0 版本中弃用，并且在 4.0.0 版本中不再可用。 list 功能已移至专用模块 amazon.aws.ec2_vol_info。 选择 "absent" "present" ← (默认)
tags 别名：resource_tags 字典	一个表示要应用于资源的标签的字典。 如果未设置 tags 参数，则不会修改标签。
throughput 整数 在 amazon.aws 1.4.0 中添加	卷吞吐量，单位为 MB/s。 此参数仅对 gp3 卷有效。 有效范围为 125 到 1000。
validate_certs 布尔值	设置为 false 时，与 AWS API 通信时将不会验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选择 false true ← (默认)
volume_size 整数	要创建的卷的大小（单位为 GiB）。
volume_type 字符串	EBS 卷的类型；standard（磁性）、gp2（SSD）、gp3（SSD）、io1（预置 IOPS）、io2（预置 IOPS）、st1（吞吐量优化 HDD）、sc1（冷 HDD）。 standard 是旧的 EBS 默认值，并且为了向后兼容，仍然是 Ansible 的默认值。 选择 "standard" ← (默认) "gp2" "io1" "st1" "sc1" "gp3" "io2"
zone 别名：availability_zone, aws_zone, ec2_zone 字符串	要在其中创建卷的区域，如果未设置，则使用实例所在的区域（如果已设置）。

备注

注意

• 对 purge_tags 的支持已在 1.5.0 版本中添加。

• 注意： 对于模块，环境变量和配置文件是从 Ansible “主机” 上下文中读取的，而不是从“控制器” 上下文中读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible “控制器” 上下文中读取的，而不是从“主机” 上下文中读取的。

• Ansible 使用的 AWS SDK (boto3) 也可能会从其在 Ansible “主机” 上下文中的配置文件（通常为 ~/.aws/credentials）中读取凭据和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

# Simple attachment action
- amazon.aws.ec2_vol:
    instance: XXXXXX
    volume_size: 5
    device_name: sdd
    region: us-west-2

# Example using custom iops params
- amazon.aws.ec2_vol:
    instance: XXXXXX
    volume_size: 5
    iops: 100
    device_name: sdd
    region: us-west-2

# Example using snapshot id
- amazon.aws.ec2_vol:
    instance: XXXXXX
    snapshot: "{{ snapshot }}"

# Playbook example combined with instance launch
- amazon.aws.ec2:
    keypair: "{{ keypair }}"
    image: "{{ image }}"
    wait: true
    count: 3
  register: ec2
- amazon.aws.ec2_vol:
    instance: "{{ item.id }}"
    volume_size: 5
  loop: "{{ ec2.instances }}"
  register: ec2_vol

# Example: Launch an instance and then add a volume if not already attached
#   * Volume will be created with the given name if not already created.
#   * Nothing will happen if the volume is already attached.

- amazon.aws.ec2:
    keypair: "{{ keypair }}"
    image: "{{ image }}"
    zone: YYYYYY
    id: my_instance
    wait: true
    count: 1
  register: ec2

- amazon.aws.ec2_vol:
    instance: "{{ item.id }}"
    name: my_existing_volume_Name_tag
    device_name: /dev/xvdf
  loop: "{{ ec2.instances }}"
  register: ec2_vol

# Remove a volume
- amazon.aws.ec2_vol:
    id: vol-XXXXXXXX
    state: absent

# Detach a volume (since 1.9)
- amazon.aws.ec2_vol:
    id: vol-XXXXXXXX
    instance: None
    region: us-west-2

# Create new volume using SSD storage
- amazon.aws.ec2_vol:
    instance: XXXXXX
    volume_size: 50
    volume_type: gp2
    device_name: /dev/xvdf

# Create new volume with multi-attach enabled
- amazon.aws.ec2_vol:
    zone: XXXXXX
    multi_attach: true
    volume_size: 4
    volume_type: io1
    iops: 102

# Attach an existing volume to instance. The volume will be deleted upon instance termination.
- amazon.aws.ec2_vol:
    instance: XXXXXX
    id: XXXXXX
    device_name: /dev/sdf
    delete_on_termination: true

返回值

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

键	描述
device 字符串	已挂载卷的设备名称。 返回：成功时 示例： "/dev/sdf"
卷 字典	一个字典，包含卷的详细属性。 返回：成功时
attachment_set 列表 / 元素=字典	关于卷附件的信息。 此项在 2.0.0 版本中从字典更改为字典列表。 返回：成功时 示例： [{"attach_time": "2015-10-23T00:22:29.000Z", "deleteOnTermination": "false", "device": "/dev/sdf", "instance_id": "i-8356263c", "status": "attached"}]
create_time 字符串	启动卷创建的时间戳。 返回：成功时 示例： "2015-10-21T14:36:08.870Z"
encrypted 布尔值	指示卷是否已加密。 返回：成功时 示例： false
id 字符串	卷的 ID。 返回：成功时 示例： "vol-35b333d9"
iops 整数	卷支持的每秒 I/O 操作数 (IOPS)。 返回：成功时
size 整数	卷的大小，以 GiB 为单位。 返回：成功时 示例： 1
snapshot_id 字符串	创建卷的快照（如果适用）。 返回：成功时 示例： ""
status 字符串	卷的状态。 返回：成功时 示例： "in-use"
tags 字典	分配给卷的任何标签。 返回：成功时 示例： {"env": "dev"}
throughput 整数	卷支持的吞吐量，以 MiB/秒 为单位。 返回：成功时 示例： 131
type 字符串	卷的类型。可以是 gp2、io1、st1、sc1 或 standard。 返回：成功时 示例： "standard"
zone 字符串	卷的可用区。 返回：成功时 示例： "us-east-1b"
volume_id 字符串	卷的 ID。 返回：成功时 示例： "vol-35b333d9"
volume_type 字符串	卷的类型。 返回：成功时 示例： "standard"

作者

• Lester Wade (@lwade)

合集链接

• 问题跟踪器
• 存储库（源代码）
• 通信