W3cubDocs

/Ansible

ec2_asg_facts - Gather facts about ec2 Auto Scaling Groups (ASGs) in AWS

New in version 2.2.

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

Synopsis

Gather facts about ec2 Auto Scaling Groups (ASGs) 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.
name	no			The prefix or name of the auto scaling group(s) you are searching for. Note: This is a regular expression match with implicit '^' (beginning of string). Append '$' for a complete name match.
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
tags	no			A dictionary/hash of tags in the format { tag1_name: 'tag1_value', tag2_name: 'tag2_value' } to match against the auto scaling group(s) you are searching for.
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.

# Find all groups
- ec2_asg_facts:
  register: asgs

# Find a group with matching name/prefix
- ec2_asg_facts:
    name: public-webserver-asg
  register: asgs

# Find a group with matching tags
- ec2_asg_facts:
    tags:
      project: webapp
      env: production
  register: asgs

# Find a group with matching name/prefix and tags
- ec2_asg_facts:
    name: myproject
    tags:
      env: production
  register: asgs

# Fail if no groups are found
- ec2_asg_facts:
    name: public-webserver-asg
  register: asgs
  failed_when: "{{ asgs.results | length == 0 }}"

# Fail if more than 1 group is found
- ec2_asg_facts:
    name: public-webserver-asg
  register: asgs
  failed_when: "{{ asgs.results | length > 1 }}"

Return Values

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

name	description	returned	type	sample
status	The current state of the group when DeleteAutoScalingGroup is in progress.	success	str	None
new_instances_protected_from_scale_in	Whether or not new instances a protected from automatic scaling in.	success	boolean	false
default_cooldown	The default cooldown time in seconds.	success	int	300
tags	List of tags for the ASG, and whether or not each tag propagates to instances at launch.	success	list	[{'propagate_at_launch': 'true', 'key': 'Name', 'value': 'public-webapp-production-1', 'resource_type': 'auto-scaling-group', 'resource_id': 'public-webapp-production-1'}, {'propagate_at_launch': 'true', 'key': 'env', 'value': 'production', 'resource_type': 'auto-scaling-group', 'resource_id': 'public-webapp-production-1'}]
load_balancer_names	List of load balancers names attached to the ASG.	success	list	['elb-webapp-prod']
min_size	Minimum size of group	success	int	1
instances	List of EC2 instances and their status as it relates to the ASG.	success	list	[{'instance_id': 'i-es22ad25', 'lifecycle_state': 'InService', 'health_status': 'Healthy', 'protected_from_scale_in': 'false', 'availability_zone': 'us-west-2a', 'launch_configuration_name': 'public-webapp-production-1'}]
health_check_period	Length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health.	success	int	30
created_time	The date and time this ASG was created, in ISO 8601 format.	success	string	2015-11-25T00:05:36.309Z
max_size	Maximum size of group	success	int	3
availability_zones	List of Availability Zones that are enabled for this ASG.	success	list	['us-west-2a', 'us-west-2b', 'us-west-2a']
launch_configuration_name	Name of launch configuration associated with the ASG.	success	str	public-webapp-production-1
auto_scaling_group_arn	The Amazon Resource Name of the ASG	success	string	arn:aws:autoscaling:us-west-2:1234567890:autoScalingGroup:10787c52-0bcb-427d-82ba-c8e4b008ed2e:autoScalingGroupName/public-webapp-production-1
target_group_arns	List of ARNs of the target groups that the ASG populates	success	list	['arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:targetgroup/target-group-host-hello/1a2b3c4d5e6f1a2b', 'arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:targetgroup/target-group-path-world/abcd1234abcd1234']
termination_policies	A list of termination policies for the group.	success	str	['Default']
desired_capacity	The number of EC2 instances that should be running in this group.	success	int	3
health_check_type	The service you want the health status from, one of "EC2" or "ELB".	success	str	ELB
auto_scaling_group_name	Name of autoscaling group	success	str	public-webapp-production-1
launch_config_name	Name of launch configuration associated with the ASG. Same as launch_configuration_name, provided for compatibility with ec2_asg module.	success	str	public-webapp-production-1
placement_group	Placement group into which instances are launched, if any.	success	str	None
target_group_names	List of names of the target groups that the ASG populates	success	list	['target-group-host-hello', 'target-group-path-world']

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_asg_facts_module.html