Documentation

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

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
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
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
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
The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
names
The names of the load balancers.
profile
(added in 1.6)
Uses a boto profile. Only works with boto >= 2.24.0.
region
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)
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
bool

(added in 1.5)
    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_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.

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

Key Returned Description
load_balancers
complex
always
a list of load balancers

  idle_timeout_timeout_seconds
string
when status is present
The idle timeout value, in seconds.

Sample:
60
  load_balancer_arn
string
when status is present
The Amazon Resource Name (ARN) of the load balancer.

Sample:
arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-elb/001122334455
  access_logs_s3_enabled
string
when status is present
Indicates whether access logs stored in Amazon S3 are enabled.

Sample:
True
  tags
dict
when status is present
The tags attached to the load balancer.

Sample:
{ 'Tag': 'Example' }
  created_time
string
when status is present
The date and time the load balancer was created.

Sample:
2015-02-12T02:14:02+00:00
  access_logs_s3_prefix
string
when status is present
The prefix for the location in the S3 bucket.

Sample:
/my/logs
  security_groups
list
when status is present
The IDs of the security groups for the load balancer.

Sample:
['sg-0011223344']
  canonical_hosted_zone_id
string
when status is present
The ID of the Amazon Route 53 hosted zone associated with the load balancer.

Sample:
ABCDEF12345678
  availability_zones
list
when status is present
The Availability Zones for the load balancer.

Sample:
[{'subnet_id': 'subnet-aabbccddff', 'zone_name': 'ap-southeast-2a'}]
  access_logs_s3_bucket
string
when status is present
The name of the S3 bucket for the access logs.

Sample:
mys3bucket
  deletion_protection_enabled
string
when status is present
Indicates whether deletion protection is enabled.

Sample:
True
  ip_address_type
string
when status is present
The type of IP addresses used by the subnets for the load balancer.

Sample:
ipv4
  load_balancer_name
string
when status is present
The name of the load balancer.

Sample:
my-elb
  state
dict
when status is present
The state of the load balancer.

Sample:
{'code': 'active'}
  dns_name
string
when status is present
The public DNS name of the load balancer.

Sample:
internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com
  vpc_id
string
when status is present
The ID of the VPC for the load balancer.

Sample:
vpc-0011223344
  scheme
string
when status is present
Internet-facing or internal load balancer.

Sample:
internal
  type
string
when status is present
The type of load balancer.

Sample:
application


Status

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

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Rob White (@wimnat)

Hint

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