W3cubDocs

/Ansible

ec2_instance_facts - Gather facts about ec2 instances in AWS

New in version 2.4.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
- Status

Synopsis

Gather facts about ec2 instances in AWS

Requirements (on host that executes module)

python >= 2.6
boto

Options

parameter	required	default	choices	comments
aws_access_key	no			AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. aliases: ec2_access_key, access_key
aws_secret_key	no			AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. aliases: ec2_secret_key, secret_key
ec2_url	no			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.
filters	no			A dict of filters to apply. Each dict item consists of a filter key and a filter value. See http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html for possible filters. Filter names and values are case sensitive.
instance_ids (added in 2.4)	no			If you specify one or more instance IDs, only instances that have the specified IDs are returned.
profile (added in 1.6)	no			Uses a boto profile. Only works with boto >= 2.24.0.
region	no			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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region aliases: aws_region, ec2_region
security_token (added in 1.6)	no			AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token
validate_certs (added in 1.5)	no	yes	yes no	When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Gather facts about all instances
- ec2_instance_facts:

# Gather facts about all instances in AZ ap-southeast-2a
- ec2_instance_facts:
    filters:
      availability-zone: ap-southeast-2a

# Gather facts about a particular instance using ID
- ec2_instance_facts:
    instance_ids:
      - i-12345678

# Gather facts about any instance with a tag key Name and value Example
- ec2_instance_facts:
    filters:
      "tag:Name": Example

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name

description

returned

type

sample

instances

a list of ec2 instances

always

complex

contains:

name	description	returned	type	sample
network_interfaces	One or more network interfaces for the instance.	always	complex
root_device_type	The type of root device used by the AMI.	always	string	ebs
private_dns_name	The private DNS name.	always	string	ip-10-0-0-1.ap-southeast-2.compute.internal
tags	Any tags assigned to the instance.	always	dict	None
key_name	The name of the key pair, if this instance was launched with an associated key pair.	always	string	my-key
image_id	The ID of the AMI used to launch the instance.	always	string	ami-0011223344
block_device_mappings	Any block device mapping entries for the instance.	always	complex
public_dns_name	The public DNS name assigned to the instance.	always	string	None
placement	The location where the instance launched, if applicable.	always	complex
architecture	The architecture of the image	always	string	x86_64
security_groups	One or more security groups for the instance.	always	complex
public_ip_address	The public IPv4 address assigned to the instance	always	string	52.0.0.1
product_codes	One or more product codes.	always	complex
monitoring	The monitoring for the instance.	always	complex
ami_launch_index	The AMI launch index, which can be used to find this instance in the launch group.	always	int	0
subnet_id	The ID of the subnet in which the instance is running.	always	string	subnet-00abcdef
hypervisor	The hypervisor type of the instance.	always	string	xen
ebs_optimized	Indicates whether the instance is optimized for EBS I/O.	always	bool	False
launch_time	The time the instance was launched.	always	string	2017-03-23T22:51:24+00:00
iam_instance_profile	The IAM instance profile associated with the instance, if applicable.	always	complex
instance_id	The ID of the instance.	always	string	i-012345678
instance_type	The instance type size of the running instance.	always	string	t2.micro
state	The current state of the instance.	always	complex
source_dest_check	Indicates whether source/destination checking is enabled.	always	bool	True
state_transition_reason	The reason for the most recent state transition.	always	string	None
private_ip_address	The IPv4 address of the network interface within the subnet.	always	string	10.0.0.1
vpc_id	The ID of the VPC the instance is in.	always	dict	vpc-0011223344
client_token	The idempotency token you provided when you launched the instance, if applicable.	always	string	mytoken
virtualization_type	The type of virtualization of the AMI.	always	string	hvm
root_device_name	The device name of the root device	always	string	/dev/sda1

Notes

Note

If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION
Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html
AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/ec2_instance_facts_module.html