Try SpotterGather information about EC2 Elastic Load Balancers in AWS
| "added in version" 2.0 of ansible.builtin"
Authors: Michael Schultz (@mjschultz), Fernando Jose Pando (@nand0p)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Gather information about EC2 Elastic Load Balancers in AWS
This module was called C(elb_classic_lb_facts) before Ansible 2.9. The usage did not change.
# Note: These examples do not set authentication details, see the AWS Guide for details. # Output format tries to match ec2_elb_lb module input parameters # Gather information about all ELBs - elb_classic_lb_info: register: elb_info
- debug:
msg: "{{ item.dns_name }}"
loop: "{{ elb_info.elbs }}"
# Gather information about a particular ELB
- elb_classic_lb_info:
names: frontend-prod-elb
register: elb_info
- debug:
msg: "{{ elb_info.elbs.0.dns_name }}"
# Gather information about a set of ELBs
- elb_classic_lb_info:
names:
- frontend-prod-elb
- backend-prod-elb
register: elb_info
- debug:
msg: "{{ item.dns_name }}"
loop: "{{ elb_info.elbs }}"
names:
aliases:
- elb_ids
- ec2_elbs
description:
- List of ELB names to gather information about. Pass this option to gather information
about a set of ELBs, otherwise, all ELBs are returned.
region:
aliases:
- aws_region
- ec2_region
description:
- 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- 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.
type: str
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
type: bool
elbs:
description: a list of load balancers
returned: always
sample:
elbs:
- attributes:
access_log:
enabled: false
connection_draining:
enabled: true
timeout: 300
connection_settings:
idle_timeout: 60
cross_zone_load_balancing:
enabled: true
availability_zones:
- us-east-1a
- us-east-1b
- us-east-1c
- us-east-1d
- us-east-1e
backend_server_description: []
canonical_hosted_zone_name: test-lb-XXXXXXXXXXXX.us-east-1.elb.amazonaws.com
canonical_hosted_zone_name_id: XXXXXXXXXXXXXX
created_time: '2017-08-23T18:25:03.280000+00:00'
dns_name: test-lb-XXXXXXXXXXXX.us-east-1.elb.amazonaws.com
health_check:
healthy_threshold: 10
interval: 30
target: HTTP:80/index.html
timeout: 5
unhealthy_threshold: 2
instances: []
instances_inservice: []
instances_inservice_count: 0
instances_outofservice: []
instances_outofservice_count: 0
instances_unknownservice: []
instances_unknownservice_count: 0
listener_descriptions:
- listener:
instance_port: 80
instance_protocol: HTTP
load_balancer_port: 80
protocol: HTTP
policy_names: []
load_balancer_name: test-lb
policies:
app_cookie_stickiness_policies: []
lb_cookie_stickiness_policies: []
other_policies: []
scheme: internet-facing
security_groups:
- sg-29d13055
source_security_group:
group_name: default
owner_alias: XXXXXXXXXXXX
subnets:
- subnet-XXXXXXXX
- subnet-XXXXXXXX
tags: {}
vpc_id: vpc-c248fda4
type: list