community.aws.elb_target_group_info – Gather information about ELB target groups in AWS
Note
This plugin is part of the community.aws collection (version 1.5.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 community.aws
.
To use it in a playbook, specify: community.aws.elb_target_group_info
.
New in version 1.0.0: of community.aws
Synopsis
Gather information about ELB target groups in AWS
This module was called
elb_target_group_facts
before Ansible 2.9. The usage did not change.
Requirements
The below requirements are needed on the host that executes this module.
boto
boto3
python >= 2.6
Parameters
Parameter |
Comments |
---|---|
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. If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
The location of a CA Bundle to use when validating SSL certificates. Only used for boto3 based modules. Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally. |
|
A dictionary to modify the botocore configuration. Parameters can be found at 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 http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration. |
|
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. If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
When set to “yes”, output contains targets health description Choices:
|
|
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:
|
|
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. |
|
The Amazon Resource Name (ARN) of the load balancer. |
|
The names of the target groups. |
|
Uses a boto profile. Only works with boto >= 2.24.0. Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated. aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. |
|
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 |
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
The Amazon Resource Names (ARN) of the target groups. |
|
When set to “no”, SSL certificates will not be validated for boto versions >= 2.6.0. Choices:
|
Notes
Note
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_PROFILE
orAWS_DEFAULT_PROFILE
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_REGION
,AWS_CA_BUNDLE
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
orEC2_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.
- name: Gather information about all target groups
community.aws.elb_target_group_info:
- name: Gather information about the target group attached to a particular ELB
community.aws.elb_target_group_info:
load_balancer_arn: "arn:aws:elasticloadbalancing:ap-southeast-2:001122334455:loadbalancer/app/my-elb/aabbccddeeff"
- name: Gather information about a target groups named 'tg1' and 'tg2'
community.aws.elb_target_group_info:
names:
- tg1
- tg2
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
a list of target groups Returned: always |
|
The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. Returned: always Sample: 300 |
|
The approximate amount of time, in seconds, between health checks of an individual target. Returned: always Sample: 30 |
|
The destination for the health check request. Returned: always Sample: “/index.html” |
|
The port to use to connect with the target. Returned: always Sample: “traffic-port” |
|
The protocol to use to connect with the target. Returned: always Sample: “HTTP” |
|
The amount of time, in seconds, during which no response means a failed health check. Returned: always Sample: 5 |
|
The number of consecutive health checks successes required before considering an unhealthy target healthy. Returned: always Sample: 5 |
|
The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group. Returned: always Sample: [] |
|
The HTTP codes to use when checking for a successful response from a target. Returned: always Sample: {“http_code”: “200”} |
|
The port on which the targets are listening. Returned: always Sample: 80 |
|
The protocol to use for routing traffic to the targets. Returned: always Sample: “HTTP” |
|
Indicates whether sticky sessions are enabled. Returned: always Sample: true |
|
Indicates whether sticky sessions are enabled. Returned: always Sample: 86400 |
|
The type of sticky sessions. Returned: always Sample: “lb_cookie” |
|
The tags attached to the target group. Returned: always Sample: “{ \u0027Tag\u0027: \u0027Example\u0027 }” |
|
The Amazon Resource Name (ARN) of the target group. Returned: always Sample: “arn:aws:elasticloadbalancing:ap-southeast-2:01234567890:targetgroup/mytargetgroup/aabbccddee0044332211” |
|
The name of the target group. Returned: always Sample: “mytargetgroup” |
|
Targets health description. Returned: when collect_targets_health is enabled |
|
The port to check target health. Returned: always Sample: “80” |
|
The target metadata. Returned: always |
|
The ID of the target. Returned: always Sample: “i-0123456789” |
|
The port to use to connect with the target. Returned: always Sample: 80 |
|
The target health status. Returned: always |
|
The state of the target health. Returned: always Sample: “healthy” |
|
The number of consecutive health check failures required before considering the target unhealthy. Returned: always Sample: 2 |
|
The ID of the VPC for the targets. Returned: always Sample: “vpc-0123456” |
Authors
Rob White (@wimnat)