Try SpotterGather facts about ELB target groups in AWS
| "added in version" 2.4 of ansible.builtin"
Authors: Rob White (@wimnat)
preview | supported by community
pipInstall with pip install ansible==2.7.18
Gather facts about ELB target groups in AWS
# Note: These examples do not set authentication details, see the AWS Guide for details. # Gather facts about all target groups - elb_target_group_facts:
# Gather facts about the target group attached to a particular ELB
- elb_target_group_facts:
load_balancer_arn: "arn:aws:elasticloadbalancing:ap-southeast-2:001122334455:loadbalancer/app/my-elb/aabbccddeeff"
# Gather facts about a target groups named 'tg1' and 'tg2'
- elb_target_group_facts:
names:
- tg1
- tg2
names:
description:
- The names of the target groups.
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:
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:
description:
- Uses a boto profile. Only works with boto >= 2.24.0.
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_access_key:
aliases:
- ec2_access_key
- access_key
description:
- 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.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- 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.
type: str
security_token:
aliases:
- access_token
description:
- AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN
environment variable is used.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
type: bool
load_balancer_arn:
description:
- The Amazon Resource Name (ARN) of the load balancer.
required: false
target_group_arns:
description:
- The Amazon Resource Names (ARN) of the target groups.
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
target_groups:
contains:
deregistration_delay_timeout_seconds:
description: 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
type: int
health_check_interval_seconds:
description: The approximate amount of time, in seconds, between health checks
of an individual target.
returned: always
sample: 30
type: int
health_check_path:
description: The destination for the health check request.
returned: always
sample: /index.html
type: string
health_check_port:
description: The port to use to connect with the target.
returned: always
sample: traffic-port
type: string
health_check_protocol:
description: The protocol to use to connect with the target.
returned: always
sample: HTTP
type: string
health_check_timeout_seconds:
description: The amount of time, in seconds, during which no response means
a failed health check.
returned: always
sample: 5
type: int
healthy_threshold_count:
description: The number of consecutive health checks successes required before
considering an unhealthy target healthy.
returned: always
sample: 5
type: int
load_balancer_arns:
description: The Amazon Resource Names (ARN) of the load balancers that route
traffic to this target group.
returned: always
sample: []
type: list
matcher:
description: The HTTP codes to use when checking for a successful response from
a target.
returned: always
sample:
http_code: '200'
type: dict
port:
description: The port on which the targets are listening.
returned: always
sample: 80
type: int
protocol:
description: The protocol to use for routing traffic to the targets.
returned: always
sample: HTTP
type: string
stickiness_enabled:
description: Indicates whether sticky sessions are enabled.
returned: always
sample: true
type: bool
stickiness_lb_cookie_duration_seconds:
description: Indicates whether sticky sessions are enabled.
returned: always
sample: 86400
type: int
stickiness_type:
description: The type of sticky sessions.
returned: always
sample: lb_cookie
type: string
tags:
description: The tags attached to the target group.
returned: always
sample: '{ ''Tag'': ''Example'' }'
type: dict
target_group_arn:
description: The Amazon Resource Name (ARN) of the target group.
returned: always
sample: arn:aws:elasticloadbalancing:ap-southeast-2:01234567890:targetgroup/mytargetgroup/aabbccddee0044332211
type: string
target_group_name:
description: The name of the target group.
returned: always
sample: mytargetgroup
type: string
unhealthy_threshold_count:
description: The number of consecutive health check failures required before
considering the target unhealthy.
returned: always
sample: 2
type: int
vpc_id:
description: The ID of the VPC for the targets.
returned: always
sample: vpc-0123456
type: string
description: a list of target groups
returned: always
type: complex