community.aws.ec2_instance_facts – Gather information about ec2 instances in AWS

Note

This plugin is part of the community.aws collection.

To install it use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.ec2_instance_facts.

New in version 1.0.0: of community.aws

Synopsis

  • Gather information about ec2 instances in AWS

  • This module was called ec2_instance_facts before Ansible 2.9. The usage did not change.

Requirements

The below requirements are needed on the host that executes this module.

  • boto

  • boto3

  • botocore

  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
aws_access_key
string
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.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
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.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
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.
ec2_url
string
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.

aliases: aws_endpoint_url, endpoint_url
filters
dictionary
Default:
{}
A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html for possible filters. Filter names and values are case sensitive.
instance_ids
list / elements=string
If you specify one or more instance IDs, only instances that have the specified IDs are returned.
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
region
string
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
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

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_PROFILE or AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE

  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/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

Examples

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

- name: Gather information about all instances
  community.aws.ec2_instance_info:

- name: Gather information about all instances in AZ ap-southeast-2a
  community.aws.ec2_instance_info:
    filters:
      availability-zone: ap-southeast-2a

- name: Gather information about a particular instance using ID
  community.aws.ec2_instance_info:
    instance_ids:
      - i-12345678

- name: Gather information about any instance with a tag key Name and value Example
  community.aws.ec2_instance_info:
    filters:
      "tag:Name": Example

- name: Gather information about any instance in states "shutting-down", "stopping", "stopped"
  community.aws.ec2_instance_info:
    filters:
      instance-state-name: [ "shutting-down", "stopping", "stopped" ]

Return Values

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

Key Returned Description
instances
complex
always
a list of ec2 instances

 
ami_launch_index
integer
always
The AMI launch index, which can be used to find this instance in the launch group.

 
architecture
string
always
The architecture of the image

Sample:
x86_64
 
block_device_mappings
complex
always
Any block device mapping entries for the instance.

   
device_name
string
always
The device name exposed to the instance (for example, /dev/sdh or xvdh).

Sample:
/dev/sdh
   
ebs
complex
always
Parameters used to automatically set up EBS volumes when the instance is launched.

     
attach_time
string
always
The time stamp when the attachment initiated.

Sample:
2017-03-23T22:51:24+00:00
     
delete_on_termination
boolean
always
Indicates whether the volume is deleted on instance termination.

Sample:
True
     
status
string
always
The attachment state.

Sample:
attached
     
volume_id
string
always
The ID of the EBS volume

Sample:
vol-12345678
 
client_token
string
always
The idempotency token you provided when you launched the instance, if applicable.

Sample:
mytoken
 
cpu_options
complex
always if botocore version >= 1.10.16
The CPU options set for the instance.

   
core_count
integer
always
The number of CPU cores for the instance.

Sample:
1
   
threads_per_core
integer
always
The number of threads per CPU core. On supported instance, a value of 1 means Intel Hyper-Threading Technology is disabled.

Sample:
1
 
ebs_optimized
boolean
always
Indicates whether the instance is optimized for EBS I/O.

 
hypervisor
string
always
The hypervisor type of the instance.

Sample:
xen
 
iam_instance_profile
complex
always
The IAM instance profile associated with the instance, if applicable.

   
arn
string
always
The Amazon Resource Name (ARN) of the instance profile.

Sample:
arn:aws:iam::000012345678:instance-profile/myprofile
   
id
string
always
The ID of the instance profile

Sample:
JFJ397FDG400FG9FD1N
 
image_id
string
always
The ID of the AMI used to launch the instance.

Sample:
ami-0011223344
 
instance_id
string
always
The ID of the instance.

Sample:
i-012345678
 
instance_type
string
always
The instance type size of the running instance.

Sample:
t2.micro
 
key_name
string
always
The name of the key pair, if this instance was launched with an associated key pair.

Sample:
my-key
 
launch_time
string
always
The time the instance was launched.

Sample:
2017-03-23T22:51:24+00:00
 
monitoring
complex
always
The monitoring for the instance.

   
state
string
always
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

Sample:
disabled
 
network_interfaces
complex
always
One or more network interfaces for the instance.

   
association
complex
always
The association information for an Elastic IPv4 associated with the network interface.

     
ip_owner_id
string
always
The ID of the owner of the Elastic IP address.

Sample:
amazon
     
public_dns_name
string
always
The public DNS name.

     
public_ip
string
always
The public IP address or Elastic IP address bound to the network interface.

Sample:
1.2.3.4
   
attachment
complex
always
The network interface attachment.

     
attach_time
string
always
The time stamp when the attachment initiated.

Sample:
2017-03-23T22:51:24+00:00
     
attachment_id
string
always
The ID of the network interface attachment.

Sample:
eni-attach-3aff3f
     
delete_on_termination
boolean
always
Indicates whether the network interface is deleted when the instance is terminated.

Sample:
True
     
device_index
integer
always
The index of the device on the instance for the network interface attachment.

     
status
string
always
The attachment state.

Sample:
attached
   
description
string
always
The description.

Sample:
My interface
   
groups
list / elements=dictionary
always
One or more security groups.

     
group_id
string
always
The ID of the security group.

Sample:
sg-abcdef12
     
group_name
string
always
The name of the security group.

Sample:
mygroup
   
ipv6_addresses
list / elements=dictionary
always
One or more IPv6 addresses associated with the network interface.

     
ipv6_address
string
always
The IPv6 address.

Sample:
2001:0db8:85a3:0000:0000:8a2e:0370:7334
   
mac_address
string
always
The MAC address.

Sample:
00:11:22:33:44:55
   
network_interface_id
string
always
The ID of the network interface.

Sample:
eni-01234567
   
owner_id
string
always
The AWS account ID of the owner of the network interface.

Sample:
01234567890
   
private_ip_address
string
always
The IPv4 address of the network interface within the subnet.

Sample:
10.0.0.1
   
private_ip_addresses
list / elements=dictionary
always
The private IPv4 addresses associated with the network interface.

     
association
complex
always
The association information for an Elastic IP address (IPv4) associated with the network interface.

       
ip_owner_id
string
always
The ID of the owner of the Elastic IP address.

Sample:
amazon
       
public_dns_name
string
always
The public DNS name.

       
public_ip
string
always
The public IP address or Elastic IP address bound to the network interface.

Sample:
1.2.3.4
     
primary
boolean
always
Indicates whether this IPv4 address is the primary private IP address of the network interface.

Sample:
True
     
private_ip_address
string
always
The private IPv4 address of the network interface.

Sample:
10.0.0.1
   
source_dest_check
boolean
always
Indicates whether source/destination checking is enabled.

Sample:
True
   
status
string
always
The status of the network interface.

Sample:
in-use
   
subnet_id
string
always
The ID of the subnet for the network interface.

Sample:
subnet-0123456
   
vpc_id
string
always
The ID of the VPC for the network interface.

Sample:
vpc-0123456
 
placement
complex
always
The location where the instance launched, if applicable.

   
availability_zone
string
always
The Availability Zone of the instance.

Sample:
ap-southeast-2a
   
group_name
string
always
The name of the placement group the instance is in (for cluster compute instances).

   
tenancy
string
always
The tenancy of the instance (if the instance is running in a VPC).

Sample:
default
 
private_dns_name
string
always
The private DNS name.

Sample:
ip-10-0-0-1.ap-southeast-2.compute.internal
 
private_ip_address
string
always
The IPv4 address of the network interface within the subnet.

Sample:
10.0.0.1
 
product_codes
list / elements=dictionary
always
One or more product codes.

   
product_code_id
string
always
The product code.

Sample:
aw0evgkw8ef3n2498gndfgasdfsd5cce
   
product_code_type
string
always
The type of product code.

Sample:
marketplace
 
public_dns_name
string
always
The public DNS name assigned to the instance.

 
public_ip_address
string
always
The public IPv4 address assigned to the instance

Sample:
52.0.0.1
 
root_device_name
string
always
The device name of the root device

Sample:
/dev/sda1
 
root_device_type
string
always
The type of root device used by the AMI.

Sample:
ebs
 
security_groups
list / elements=dictionary
always
One or more security groups for the instance.

   
group_id
string
always
The ID of the security group.

Sample:
sg-0123456
   
group_name
string
always
The name of the security group.

Sample:
my-security-group
 
source_dest_check
boolean
always
Indicates whether source/destination checking is enabled.

Sample:
True
 
state
complex
always
The current state of the instance.

   
code
integer
always
The low byte represents the state.

Sample:
16
   
name
string
always
The name of the state.

Sample:
running
 
state_transition_reason
string
always
The reason for the most recent state transition.

 
subnet_id
string
always
The ID of the subnet in which the instance is running.

Sample:
subnet-00abcdef
 
tags
dictionary
always
Any tags assigned to the instance.

 
virtualization_type
string
always
The type of virtualization of the AMI.

Sample:
hvm
 
vpc_id
dictionary
always
The ID of the VPC the instance is in.

Sample:
vpc-0011223344


Authors

  • Michael Schuett (@michaeljs1990)

  • Rob White (@wimnat)