Try Spottercreate and attach a volume, return volume id and device map
| "added in version" 1.1 of ansible.builtin"
Authors: Lester Wade (@lwade)
stableinterface | supported by core
pipInstall with pip install ansible==2.9.17
creates an EBS volume and optionally attaches it to an instance. If both an instance ID and a device name is given and the instance has a device at the device name, then no volume is created and no attachment is made. This module has a dependency on python-boto.
# Simple attachment action
- ec2_vol:
instance: XXXXXX
volume_size: 5
device_name: sdd
# Example using custom iops params
- ec2_vol:
instance: XXXXXX
volume_size: 5
iops: 100
device_name: sdd
# Example using snapshot id
- ec2_vol:
instance: XXXXXX
snapshot: "{{ snapshot }}"
# Playbook example combined with instance launch
- ec2:
keypair: "{{ keypair }}"
image: "{{ image }}"
wait: yes
count: 3
register: ec2
- 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.
# * Requires Ansible 2.0
- ec2:
keypair: "{{ keypair }}"
image: "{{ image }}"
zone: YYYYYY
id: my_instance
wait: yes
count: 1
register: ec2
- ec2_vol:
instance: "{{ item.id }}"
name: my_existing_volume_Name_tag
device_name: /dev/xvdf
loop: "{{ ec2.instances }}"
register: ec2_vol
# Remove a volume
- ec2_vol:
id: vol-XXXXXXXX
state: absent
# Detach a volume (since 1.9)
- ec2_vol:
id: vol-XXXXXXXX
instance: None
# List volumes for an instance
- ec2_vol:
instance: i-XXXXXX
state: list
# Create new volume using SSD storage
- ec2_vol:
instance: XXXXXX
volume_size: 50
volume_type: gp2
device_name: /dev/xvdf
# Attach an existing volume to instance. The volume will be deleted upon instance termination.
- ec2_vol:
instance: XXXXXX
id: XXXXXX
device_name: /dev/sdf
delete_on_termination: yes
id:
description:
- volume id if you wish to attach an existing volume (requires instance) or remove
an existing volume
version_added: '1.6'
version_added_collection: ansible.builtin
iops:
default: 100
description:
- the provisioned IOPs you want to associate with this volume (integer).
version_added: '1.3'
version_added_collection: ansible.builtin
name:
description:
- volume Name tag if you wish to attach an existing volume (requires instance)
version_added: '1.6'
version_added_collection: ansible.builtin
tags:
default: {}
description:
- tag:value pairs to add to the volume after creation
version_added: '2.3'
version_added_collection: ansible.builtin
zone:
aliases:
- aws_zone
- ec2_zone
description:
- zone in which to create the volume, if unset uses the zone the instance is in (if
set)
state:
choices:
- absent
- present
- list
default: present
description:
- whether to ensure the volume is present or absent, or to list existing volumes (The
C(list) option was added in version 1.8).
version_added: '1.6'
version_added_collection: ansible.builtin
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION
environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will
use EC2 endpoints). Ignored for modules where region is required. Must be specified
for all other modules if region is not used. If not set then the value of the EC2_URL
environment variable, if any, is used.
type: str
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
instance:
description:
- instance ID if you wish to attach the volume. Since 1.9 you can set to None to detach.
snapshot:
description:
- snapshot ID on which to base the volume
version_added: '1.5'
version_added_collection: ansible.builtin
encrypted:
default: 'no'
description:
- Enable encryption at rest for this volume.
type: bool
version_added: '1.8'
version_added_collection: ansible.builtin
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
kms_key_id:
description:
- Specify the id of the KMS key to use.
version_added: '2.3'
version_added_collection: ansible.builtin
device_name:
description:
- device id to override device mapping. Assumes /dev/sdf for Linux/UNIX and /dev/xvdf
for Windows.
volume_size:
description:
- size of volume (in GiB) to create.
volume_type:
default: standard
description:
- Type of EBS volume; standard (magnetic), gp2 (SSD), io1 (Provisioned IOPS), st1
(Throughput Optimized HDD), sc1 (Cold HDD). "Standard" is the old EBS default and
continues to remain the Ansible default for backwards compatibility.
version_added: '1.9'
version_added_collection: ansible.builtin
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: 'yes'
description:
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
type: bool
version_added: '1.5'
version_added_collection: ansible.builtin
delete_on_termination:
default: 'no'
description:
- When set to "yes", the volume will be deleted upon instance termination.
type: bool
version_added: '2.1'
version_added_collection: ansible.builtin
debug_botocore_endpoint_logs:
default: 'no'
description:
- Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action"
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the aws_resource_action callback to output to total list made
during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also
be used.
type: bool
device:
description: device name of attached volume
returned: when success
sample: /def/sdf
type: str
volume:
description: a dictionary containing detailed attributes of the volume
returned: when success
sample:
attachment_set:
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: vol-35b333d9
iops: null
size: 1
snapshot_id: ''
status: in-use
tags:
env: dev
type: standard
zone: us-east-1b
type: str
volume_id:
description: the id of volume
returned: when success
sample: vol-35b333d9
type: str
volume_type:
description: the volume type
returned: when success
sample: standard
type: str