summaryrefslogtreecommitdiff
path: root/lib/ansible/modules/extras/cloud/amazon/ec2_remote_facts.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/modules/extras/cloud/amazon/ec2_remote_facts.py')
-rw-r--r--lib/ansible/modules/extras/cloud/amazon/ec2_remote_facts.py186
1 files changed, 186 insertions, 0 deletions
diff --git a/lib/ansible/modules/extras/cloud/amazon/ec2_remote_facts.py b/lib/ansible/modules/extras/cloud/amazon/ec2_remote_facts.py
new file mode 100644
index 0000000000..5b3f909976
--- /dev/null
+++ b/lib/ansible/modules/extras/cloud/amazon/ec2_remote_facts.py
@@ -0,0 +1,186 @@
+#!/usr/bin/python
+#
+# This is a 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.
+#
+# This Ansible library 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 this library. If not, see <http://www.gnu.org/licenses/>.
+
+DOCUMENTATION = '''
+---
+module: ec2_remote_facts
+short_description: Gather facts about ec2 instances in AWS
+description:
+ - Gather facts about ec2 instances in AWS
+version_added: "2.0"
+options:
+ filters:
+ description:
+ - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) for possible filters.
+ required: false
+ default: null
+author:
+ - "Michael Schuett (@michaeljs1990)"
+extends_documentation_fragment:
+ - aws
+ - ec2
+'''
+
+EXAMPLES = '''
+# Note: These examples do not set authentication details, see the AWS Guide for details.
+
+# Gather facts about all ec2 instances
+- ec2_remote_facts:
+
+# Gather facts about all running ec2 instances with a tag of Name:Example
+- ec2_remote_facts:
+ filters:
+ instance-state-name: running
+ "tag:Name": Example
+
+# Gather facts about instance i-123456
+- ec2_remote_facts:
+ filters:
+ instance-id: i-123456
+
+# Gather facts about all instances in vpc-123456 that are t2.small type
+- ec2_remote_facts:
+ filters:
+ vpc-id: vpc-123456
+ instance-type: t2.small
+
+'''
+
+try:
+ import boto.ec2
+ from boto.exception import BotoServerError
+ HAS_BOTO = True
+except ImportError:
+ HAS_BOTO = False
+
+def get_instance_info(instance):
+
+ # Get groups
+ groups = []
+ for group in instance.groups:
+ groups.append({ 'id': group.id, 'name': group.name }.copy())
+
+ # Get interfaces
+ interfaces = []
+ for interface in instance.interfaces:
+ interfaces.append({ 'id': interface.id, 'mac_address': interface.mac_address }.copy())
+
+ # If an instance is terminated, sourceDestCheck is no longer returned
+ try:
+ source_dest_check = instance.sourceDestCheck
+ except AttributeError:
+ source_dest_check = None
+
+ # Get block device mapping
+ try:
+ bdm_dict = []
+ bdm = getattr(instance, 'block_device_mapping')
+ for device_name in bdm.keys():
+ bdm_dict.append({
+ 'device_name': device_name,
+ 'status': bdm[device_name].status,
+ 'volume_id': bdm[device_name].volume_id,
+ 'delete_on_termination': bdm[device_name].delete_on_termination,
+ 'attach_time': bdm[device_name].attach_time
+ })
+ except AttributeError:
+ pass
+
+ instance_info = { 'id': instance.id,
+ 'kernel': instance.kernel,
+ 'instance_profile': instance.instance_profile,
+ 'root_device_type': instance.root_device_type,
+ 'private_dns_name': instance.private_dns_name,
+ 'public_dns_name': instance.public_dns_name,
+ 'ebs_optimized': instance.ebs_optimized,
+ 'client_token': instance.client_token,
+ 'virtualization_type': instance.virtualization_type,
+ 'architecture': instance.architecture,
+ 'ramdisk': instance.ramdisk,
+ 'tags': instance.tags,
+ 'key_name': instance.key_name,
+ 'source_destination_check': source_dest_check,
+ 'image_id': instance.image_id,
+ 'groups': groups,
+ 'interfaces': interfaces,
+ 'spot_instance_request_id': instance.spot_instance_request_id,
+ 'requester_id': instance.requester_id,
+ 'monitoring_state': instance.monitoring_state,
+ 'placement': {
+ 'tenancy': instance._placement.tenancy,
+ 'zone': instance._placement.zone
+ },
+ 'ami_launch_index': instance.ami_launch_index,
+ 'launch_time': instance.launch_time,
+ 'hypervisor': instance.hypervisor,
+ 'region': instance.region.name,
+ 'persistent': instance.persistent,
+ 'private_ip_address': instance.private_ip_address,
+ 'public_ip_address': instance.ip_address,
+ 'state': instance._state.name,
+ 'vpc_id': instance.vpc_id,
+ 'block_device_mapping': bdm_dict,
+ }
+
+ return instance_info
+
+
+def list_ec2_instances(connection, module):
+
+ filters = module.params.get("filters")
+ instance_dict_array = []
+
+ try:
+ all_instances = connection.get_only_instances(filters=filters)
+ except BotoServerError as e:
+ module.fail_json(msg=e.message)
+
+ for instance in all_instances:
+ instance_dict_array.append(get_instance_info(instance))
+
+ module.exit_json(instances=instance_dict_array)
+
+
+def main():
+ argument_spec = ec2_argument_spec()
+ argument_spec.update(
+ dict(
+ filters = dict(default=None, type='dict')
+ )
+ )
+
+ module = AnsibleModule(argument_spec=argument_spec)
+
+ if not HAS_BOTO:
+ module.fail_json(msg='boto required for this module')
+
+ region, ec2_url, aws_connect_params = get_aws_connection_info(module)
+
+ if region:
+ try:
+ connection = connect_to_aws(boto.ec2, region, **aws_connect_params)
+ except (boto.exception.NoAuthHandlerFound, AnsibleAWSError), e:
+ module.fail_json(msg=str(e))
+ else:
+ module.fail_json(msg="region must be specified")
+
+ list_ec2_instances(connection, module)
+
+# import module snippets
+from ansible.module_utils.basic import *
+from ansible.module_utils.ec2 import *
+
+if __name__ == '__main__':
+ main()