amazon.aws.elb_classic_lb_info module – Gather information about EC2 Classic Elastic Load Balancers in AWS

Note

This module is part of the amazon.aws collection (version 9.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install amazon.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.aws.elb_classic_lb_info.

New in community.aws 1.0.0

Synopsis

  • Gather information about EC2 Classic Elastic Load Balancers in AWS.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

AWS access key ID.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

The aws_access_key and profile options are mutually exclusive.

The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

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.

Choices:

  • false ← (default)

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS.

The AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

names

list / elements=string

List of ELB names to gather information about. Pass this option to gather information about a set of ELBs, otherwise, all ELBs are returned.

Default: []

profile

aliases: aws_profile

string

A named AWS profile to use for authentication.

See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

The AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

AWS secret access key.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

The secret_key and profile options are mutually exclusive.

The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

AWS STS session token for use with temporary credentials.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0.

The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

  • The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.
# Output format tries to match amazon.aws.elb_classic_lb module input parameters

- name: Gather information about all ELBs
  amazon.aws.elb_classic_lb_info:
  register: elb_info

- ansible.builtin.debug:
    msg: "{{ item.dns_name }}"
  loop: "{{ elb_info.elbs }}"

- name: Gather information about a particular ELB
  amazon.aws.elb_classic_lb_info:
    names: frontend-prod-elb
  register: elb_info

- ansible.builtin.debug:
    msg: "{{ elb_info.elbs.0.dns_name }}"

- name: Gather information about a set of ELBs
  amazon.aws.elb_classic_lb_info:
    names:
      - frontend-prod-elb
      - backend-prod-elb
  register: elb_info

- ansible.builtin.debug:
    msg: "{{ item.dns_name }}"
  loop: "{{ elb_info.elbs }}"

Return Values

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

Key

Description

elbs

list / elements=dictionary

A list of load balancers.

Returned: always

attributes

dictionary

Information about the load balancer attributes.

Returned: always

access_log

dictionary

Information on whether access logs are enabled or not.

Returned: success

Sample: {"enabled": false}

additional_attributes

list / elements=dictionary

Information about additional load balancer attributes.

Returned: success

Sample: [{"key": "elb.http.desyncmitigationmode", "value": "defensive"}]

connection_draining

dictionary

Information on connection draining configuration of elastic load balancer.

Returned: success

Sample: {"enabled": true, "timeout": 300}

enabled

boolean

Whether connection draining is enabled.

Returned: always

timeout

integer

The maximum time, in seconds, to keep the existing connections open before deregistering the instances.

Returned: always

connection_settings

dictionary

Information on connection settings.

Returned: success

Sample: {"idle_timeout": 60}

cross_zone_load_balancing

dictionary

Information on whether cross zone load balancing is enabled or not.

Returned: success

Sample: {"enabled": true}

availability_zones

list / elements=string

The Availability Zones for the load balancer.

Returned: always

Sample: ["us-west-2a"]

backend_server_descriptions

list / elements=dictionary

Information about your EC2 instances.

Returned: always

Sample: [{"instance_port": 8085, "policy_names": ["MyPolicy1"]}]

canonical_hosted_zone_name

string

The DNS name of the load balancer.

Returned: always

Sample: "test-123456789.us-west-2.elb.amazonaws.com"

canonical_hosted_zone_name_id

string

The ID of the Amazon Route 53 hosted zone for the load balancer.

Returned: always

Sample: "Z1Z1ZZ5HABSF5"

created_time

string

The date and time the load balancer was created.

Returned: always

Sample: "2024-09-04T17:52:22.270000+00:00"

dns_name

string

The DNS name of the load balancer.

Returned: always

Sample: "test-123456789.us-west-2.elb.amazonaws.com"

health_check

dictionary

Information about the health checks conducted on the load balancer.

Returned: always

Sample: {"healthy_threshold": 10, "interval": 5, "target": "HTTP:80/index.html", "timeout": 2, "unhealthy_threshold": 2}

healthy_threshold

integer

The number of consecutive health checks successes required before moving the instance to the Healthy state.

Returned: always

interval

integer

The approximate interval, in seconds, between health checks of an individual instance.

Returned: always

target

string

The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

Returned: always

timeout

integer

The amount of time, in seconds, during which no response means a failed health check.

Returned: always

unhealthy_threshold

integer

The number of consecutive health checks successes required before moving the instance to the Unhealthy state.

Returned: always

instances

list / elements=dictionary

The IDs of the instances for the load balancer.

Returned: always

Sample: [{"instance_id": "i-11d1f111ea111111b"}]

instances_inservice

list / elements=string

Information about instances for load balancer in state “InService”.

Returned: always

Sample: ["i-11d1f111ea111111b"]

instances_inservice_count

integer

Total number of instances for load balancer with state “InService”.

Returned: always

Sample: 1

instances_outofservice

list / elements=string

Information about instances for load balancer in state “OutOfService”.

Returned: always

Sample: ["i-11d1f111ea111111b"]

instances_outofservice_count

integer

Total number of instances for load balancer with state “OutOfService”.

Returned: always

Sample: 0

instances_unknownservice

list / elements=string

Information about instances for load balancer in state “Unknown”.

Returned: always

Sample: ["i-11d1f111ea111111b"]

instances_unknownservice_count

integer

Total number of instances for load balancer with state “Unknown”.

Returned: always

Sample: 1

listener_descriptions

list / elements=dictionary

Information about the listeners for the load balancer.

Returned: always

Sample: [{"listener": {"instance_port": 80, "instance_protocol": "HTTP", "load_balancer_port": 80, "protocol": "HTTP"}, "policy_names": []}]

load_balancer_name

string

The name of the elastic load balancer.

Returned: always

Sample: "MyLoadBalancer"

policies

dictionary

Information about the policies defined for the load balancer.

Returned: always

Sample: {"app_cookie_stickiness_policies": [], "lb_cookie_stickiness_policies": [], "other_policies": []}

list / elements=string

The stickiness policies created using CreateAppCookieStickinessPolicy.

Returned: always

list / elements=string

The stickiness policies created using CreateLBCookieStickinessPolicy.

Returned: always

other_policies

list / elements=string

The policies other than the stickiness policies.

Returned: always

scheme

string

The type of load balancer.

Returned: always

Sample: "internet-facing"

security_groups

list / elements=string

The security groups for the load balancer.

Returned: always

Sample: ["sg-111111af1111cb111"]

source_security_group

dictionary

The security group for the load balancer, which are used as part of inbound rules for registered instances.

Returned: always

Sample: {"group_name": "default", "owner_alias": "721111111111"}

group_name

string

The name of the security group.

Returned: always

owner_alias

string

The owner of the security group.

Returned: always

subnets

list / elements=string

The IDs of the subnets for the load balancer.

Returned: always

Sample: ["subnet-111111af1111cb111"]

tags

dictionary

The tags associated with a load balancer.

Returned: always

Sample: {"Env": "Dev", "Owner": "Dev001"}

vpc_id

string

The ID of the VPC for the load balancer.

Returned: always

Sample: "vpc-0cc28c9e20d111111"

Authors

  • Michael Schultz (@mjschultz)

  • Fernando Jose Pando (@nand0p)