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

From Get docs
Ansible/docs/2.8/modules/ec2 asg facts module


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

New in version 2.2.


Synopsis

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

Requirements

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

  • boto
  • boto3
  • 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.


aliases: ec2_access_key, access_key

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.


aliases: ec2_secret_key, secret_key

debug_botocore_endpoint_logs

boolean

added in 2.8

  • 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.

name

-

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

string

Uses a boto profile. Only works with boto >= 2.24.0.

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.


aliases: access_token

tags

-

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

boolean

  • 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_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 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.

# 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, the following are the fields unique to this module:

Key Returned Description

auto_scaling_group_arn

string

success

The Amazon Resource Name of the ASG


Sample:

arn:aws:autoscaling:us-west-2:1234567890:autoScalingGroup:10787c52-0bcb-427d-82ba-c8e4b008ed2e:autoScalingGroupName/public-webapp-production-1

auto_scaling_group_name

string

success

Name of autoscaling group


Sample:

public-webapp-production-1

availability_zones

list

success

List of Availability Zones that are enabled for this ASG.


Sample:

['us-west-2a', 'us-west-2b', 'us-west-2a']

created_time

string

success

The date and time this ASG was created, in ISO 8601 format.


Sample:

2015-11-25T00:05:36.309Z

default_cooldown

integer

success

The default cooldown time in seconds.


Sample:

300

desired_capacity

integer

success

The number of EC2 instances that should be running in this group.


Sample:

3

health_check_period

integer

success

Length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health.


Sample:

30

health_check_type

string

success

The service you want the health status from, one of "EC2" or "ELB".


Sample:

ELB

instances

list

success

List of EC2 instances and their status as it relates to the ASG.


Sample:

[{'availability_zone': 'us-west-2a', 'health_status': 'Healthy', 'instance_id': 'i-es22ad25', 'launch_configuration_name': 'public-webapp-production-1', 'lifecycle_state': 'InService', 'protected_from_scale_in': 'false'}]

launch_config_name

string

success

Name of launch configuration associated with the ASG. Same as launch_configuration_name, provided for compatibility with ec2_asg module.


Sample:

public-webapp-production-1

launch_configuration_name

string

success

Name of launch configuration associated with the ASG.


Sample:

public-webapp-production-1

load_balancer_names

list

success

List of load balancers names attached to the ASG.


Sample:

['elb-webapp-prod']

max_size

integer

success

Maximum size of group


Sample:

3

min_size

integer

success

Minimum size of group


Sample:

1

new_instances_protected_from_scale_in

boolean

success

Whether or not new instances a protected from automatic scaling in.


Sample:

false

placement_group

string

success

Placement group into which instances are launched, if any.


Sample:

None

status

string

success

The current state of the group when DeleteAutoScalingGroup is in progress.


Sample:

None

tags

list

success

List of tags for the ASG, and whether or not each tag propagates to instances at launch.


Sample:

[{'key': 'Name', 'value': 'public-webapp-production-1', 'resource_id': 'public-webapp-production-1', 'resource_type': 'auto-scaling-group', 'propagate_at_launch': 'true'}, {'key': 'env', 'value': 'production', 'resource_id': 'public-webapp-production-1', 'resource_type': 'auto-scaling-group', 'propagate_at_launch': 'true'}]

target_group_arns

list

success

List of ARNs of the target groups that the ASG populates


Sample:

['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']

target_group_names

list

success

List of names of the target groups that the ASG populates


Sample:

['target-group-host-hello', 'target-group-path-world']

termination_policies

string

success

A list of termination policies for the group.


Sample:

['Default']




Status

Authors

  • Rob White (@wimnat)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ec2_asg_facts_module.html