Try SpotterGather information about application ELBs in AWS
| "added in version" 2.4 of ansible.builtin"
Authors: Rob White (@wimnat)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Gather information about application ELBs in AWS
This module was called C(elb_application_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. # Gather information about all target groups - elb_application_lb_info:
# Gather information about the target group attached to a particular ELB
- elb_application_lb_info:
load_balancer_arns:
- "arn:aws:elasticloadbalancing:ap-southeast-2:001122334455:loadbalancer/app/my-elb/aabbccddeeff"
# Gather information about a target groups named 'tg1' and 'tg2'
- elb_application_lb_info:
names:
- elb1
- elb2
# Gather information about specific ALB
- elb_application_lb_info:
names: "alb-name"
region: "aws-region"
register: alb_info
- debug:
var: alb_info
names:
description:
- The names of the load balancers.
required: false
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
load_balancer_arns:
description:
- The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20
load balancers in a single call.
required: false
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
load_balancers:
contains:
access_logs_s3_bucket:
description: The name of the S3 bucket for the access logs.
returned: when status is present
sample: mys3bucket
type: str
access_logs_s3_enabled:
description: Indicates whether access logs stored in Amazon S3 are enabled.
returned: when status is present
sample: true
type: str
access_logs_s3_prefix:
description: The prefix for the location in the S3 bucket.
returned: when status is present
sample: /my/logs
type: str
availability_zones:
description: The Availability Zones for the load balancer.
returned: when status is present
sample: '[{''subnet_id'': ''subnet-aabbccddff'', ''zone_name'': ''ap-southeast-2a''}]'
type: list
canonical_hosted_zone_id:
description: The ID of the Amazon Route 53 hosted zone associated with the load
balancer.
returned: when status is present
sample: ABCDEF12345678
type: str
created_time:
description: The date and time the load balancer was created.
returned: when status is present
sample: '2015-02-12T02:14:02+00:00'
type: str
deletion_protection_enabled:
description: Indicates whether deletion protection is enabled.
returned: when status is present
sample: true
type: str
dns_name:
description: The public DNS name of the load balancer.
returned: when status is present
sample: internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com
type: str
idle_timeout_timeout_seconds:
description: The idle timeout value, in seconds.
returned: when status is present
sample: 60
type: str
ip_address_type:
description: The type of IP addresses used by the subnets for the load balancer.
returned: when status is present
sample: ipv4
type: str
load_balancer_arn:
description: The Amazon Resource Name (ARN) of the load balancer.
returned: when status is present
sample: arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-elb/001122334455
type: str
load_balancer_name:
description: The name of the load balancer.
returned: when status is present
sample: my-elb
type: str
scheme:
description: Internet-facing or internal load balancer.
returned: when status is present
sample: internal
type: str
security_groups:
description: The IDs of the security groups for the load balancer.
returned: when status is present
sample:
- sg-0011223344
type: list
state:
description: The state of the load balancer.
returned: when status is present
sample: '{''code'': ''active''}'
type: dict
tags:
description: The tags attached to the load balancer.
returned: when status is present
sample: '{ ''Tag'': ''Example'' }'
type: dict
type:
description: The type of load balancer.
returned: when status is present
sample: application
type: str
vpc_id:
description: The ID of the VPC for the load balancer.
returned: when status is present
sample: vpc-0011223344
type: str
description: a list of load balancers
returned: always
type: complex