New in version 2.4.
elb_application_lb_facts before Ansible 2.9. The usage did not change.Aliases: elb_application_lb_facts
The below requirements are needed on the host that executes this module.
| 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 |
| 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. | |
| 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 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 | |
| validate_certs boolean |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
Note
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
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# 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
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 | |
| access_logs_s3_bucket string | when status is present | The name of the S3 bucket for the access logs. Sample: mys3bucket | |
| access_logs_s3_enabled string | when status is present | Indicates whether access logs stored in Amazon S3 are enabled. Sample: True | |
| access_logs_s3_prefix string | when status is present | The prefix for the location in the S3 bucket. Sample: /my/logs | |
| availability_zones list | when status is present | The Availability Zones for the load balancer. Sample: [{'subnet_id': 'subnet-aabbccddff', 'zone_name': 'ap-southeast-2a'}] | |
| 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 | |
| created_time string | when status is present | The date and time the load balancer was created. Sample: 2015-02-12T02:14:02+00:00 | |
| deletion_protection_enabled string | when status is present | Indicates whether deletion protection is enabled. Sample: True | |
| 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 | |
| idle_timeout_timeout_seconds string | when status is present | The idle timeout value, in seconds. Sample: 60 | |
| 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_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 | |
| load_balancer_name string | when status is present | The name of the load balancer. Sample: my-elb | |
| scheme string | when status is present | Internet-facing or internal load balancer. Sample: internal | |
| security_groups list | when status is present | The IDs of the security groups for the load balancer. Sample: ['sg-0011223344'] | |
| state dictionary | when status is present | The state of the load balancer. Sample: {'code': 'active'} | |
| tags dictionary | when status is present | The tags attached to the load balancer. Sample: { 'Tag': 'Example' } | |
| type string | when status is present | The type of load balancer. Sample: application | |
| vpc_id string | when status is present | The ID of the VPC for the load balancer. Sample: vpc-0011223344 | |
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.9/modules/elb_application_lb_info_module.html