elb_application_lb_facts - Gather facts about application ELBs in AWS

New in version 2.4.

Synopsis

  • Gather facts about application ELBs 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.
load_balancer_arns
no
The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
names
no
The names of the load balancers.
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 target groups
- elb_application_lb_facts:

# Gather facts about the target group attached to a particular ELB
- elb_application_lb_facts:
    load_balancer_arns:
      - "arn:aws:elasticloadbalancing:ap-southeast-2:001122334455:loadbalancer/app/my-elb/aabbccddeeff"

# Gather facts about a target groups named 'tg1' and 'tg2'
- elb_application_lb_facts:
    names:
      - elb1
      - elb2

Return Values

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

name description returned type sample
load_balancers
a list of load balancers
always complex
contains:
name description returned type sample
idle_timeout_timeout_seconds
The idle timeout value, in seconds.
when status is present string 60
load_balancer_arn
The Amazon Resource Name (ARN) of the load balancer.
when status is present string arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-elb/001122334455
access_logs_s3_enabled
Indicates whether access logs stored in Amazon S3 are enabled.
when status is present string True
tags
The tags attached to the load balancer.
when status is present dict { 'Tag': 'Example' }
created_time
The date and time the load balancer was created.
when status is present string 2015-02-12T02:14:02+00:00
access_logs_s3_prefix
The prefix for the location in the S3 bucket.
when status is present string /my/logs
security_groups
The IDs of the security groups for the load balancer.
when status is present list ['sg-0011223344']
canonical_hosted_zone_id
The ID of the Amazon Route 53 hosted zone associated with the load balancer.
when status is present string ABCDEF12345678
availability_zones
The Availability Zones for the load balancer.
when status is present list [{'subnet_id': 'subnet-aabbccddff', 'zone_name': 'ap-southeast-2a'}]
access_logs_s3_bucket
The name of the S3 bucket for the access logs.
when status is present string mys3bucket
deletion_protection_enabled
Indicates whether deletion protection is enabled.
when status is present string True
ip_address_type
The type of IP addresses used by the subnets for the load balancer.
when status is present string ipv4
load_balancer_name
The name of the load balancer.
when status is present string my-elb
state
The state of the load balancer.
when status is present dict {'code': 'active'}
dns_name
The public DNS name of the load balancer.
when status is present string internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com
vpc_id
The ID of the VPC for the load balancer.
when status is present string vpc-0011223344
scheme
Internet-facing or internal load balancer.
when status is present string internal
type
The type of load balancer.
when status is present string application

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–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/elb_application_lb_facts_module.html