Merge pull request #5092 from willthames/ec2_snapshot

Module to create EC2 snapshots

library/cloud/ec2_snapshot

+#!/usr/bin/python
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+DOCUMENTATION = '''
+---
+module: ec2_snapshot
+short_description: creates a snapshot from an existing volume
+description:
+    - creates an EC2 snapshot from an existing EBS volume
+version_added: "1.5"
+options:
+  ec2_secret_key:
+    description:
+      - AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used. 
+    required: false
+    default: None
+    aliases: ['aws_secret_key', 'secret_key' ]
+  ec2_access_key:
+    description:
+      - AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used.
+    required: false
+    default: None
+    aliases: ['aws_access_key', 'access_key' ]
+  ec2_url:
+    description:
+      - Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints).  Must be specified if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used
+    required: false
+    default: null
+    aliases: []
+  region:
+    description:
+      - The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used.
+    required: false
+    default: null
+    aliases: ['aws_region', 'ec2_region']
+  volume_id:
+    description:
+      - volume from which to take the snapshot
+    required: false
+    default: null
+    aliases: []
+  description:
+    description:
+      - description to be applied to the snapshot
+    required: false
+    default: null
+    aliases: []
+  instance_id:
+    description: 
+    - instance that has a the required volume to snapshot mounted
+    required: false
+    default: null
+    aliases: []
+  device_name:
+    description: 
+    - device name of a mounted volume to be snapshotted
+    required: false
+    default: null
+    aliases: []
+requirements: [ "boto" ]
+author: Will Thames
+'''
+
+EXAMPLES = '''
+# Simple snapshot of volume using volume_id
+- local_action: 
+    module: ec2_snapshot 
+    volume_id: vol-abcdef12   
+    description: snapshot of /data from DB123 taken 2013/11/28 12:18:32
+
+# Snapshot of volume mounted on device_name attached to instance_id
+- local_action: 
+    module: ec2_snapshot 
+    instance_id: i-12345678
+    device_name: /dev/sdb1
+    description: snapshot of /data from DB123 taken 2013/11/28 12:18:32
+'''    
+
+import sys
+import time
+
+try:
+    import boto.ec2
+except ImportError:
+    print "failed=True msg='boto required for this module'"
+    sys.exit(1)
+
+def main():
+    module = AnsibleModule(
+        argument_spec = dict(
+            volume_id = dict(),
+            description = dict(),
+            instance_id = dict(),
+            device_name = dict(),
+            region = dict(aliases=['aws_region', 'ec2_region'], choices=AWS_REGIONS),
+            ec2_url = dict(),
+            ec2_secret_key = dict(aliases=['aws_secret_key', 'secret_key'], no_log=True),
+            ec2_access_key = dict(aliases=['aws_access_key', 'access_key']),
+        )
+    )
+
+    volume_id = module.params.get('volume_id')
+    description = module.params.get('description')
+    instance_id = module.params.get('instance_id')
+    device_name = module.params.get('device_name')
+
+    if not volume_id and not instance_id or volume_id and instance_id:
+        module.fail_json('One and only one of volume_id or instance_id must be specified')
+    if instance_id and not device_name or device_name and not instance_id:
+        module.fail_json('Instance ID and device name must both be specified')
+
+    ec2 = ec2_connect(module)
+
+    if instance_id:
+        try:
+            volumes = ec2.get_all_volumes(filters={'attachment.instance-id': instance_id, 'attachment.device': device_name})
+            if not volumes:
+                module.fail_json(msg="Could not find volume with name %s attached to instance %s" % (device_name, instance_id))
+            volume_id = volumes[0].id
+        except boto.exception.BotoServerError, e:
+            module.fail_json(msg = "%s: %s" % (e.error_code, e.error_message))
+
+    try:
+        snapshot = ec2.create_snapshot(volume_id, description=description)
+    except boto.exception.BotoServerError, e:
+        module.fail_json(msg = "%s: %s" % (e.error_code, e.error_message))
+
+    module.exit_json(changed=True, snapshot_id=snapshot.id)
+
+# import module snippets
+from ansible.module_utils.basic import *
+from ansible.module_utils.ec2 import *
+
+main()