elb_target_group_facts - Gather facts about ELB target groups in AWS

New in version 2.4.

Synopsis

  • Gather facts about ELB target groups in AWS

Requirements (on host that executes module)

  • python >= 2.6
  • boto

Options

parameter required default choices comments
aws_access_key
 no
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
 no
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
ec2_url
 no
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_arn
 no
The Amazon Resource Name (ARN) of the load balancer.
names
 no
The names of the target groups.
profile
(added in 1.6)
 no
Uses a boto profile. Only works with boto >= 2.24.0.
region
 no
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
(added in 1.6)
 no
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
target_group_arns
 no
The Amazon Resource Names (ARN) of the target groups.
validate_certs
(added in 1.5)
 no yes
  • yes
  • no
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Examples

# 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

Return Values

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

name description returned type sample
target_groups
a list of target groups
 always complex
contains:
name description returned type sample
protocol
The protocol to use for routing traffic to the targets.
 always string HTTP
tags
The tags attached to the target group.
 always dict { 'Tag': 'Example' }
matcher
The HTTP codes to use when checking for a successful response from a target.
 always dict {'http_code': '200'}
health_check_port
The port to use to connect with the target.
 always string traffic-port
target_group_name
The name of the target group.
 always string mytargetgroup
target_group_arn
The Amazon Resource Name (ARN) of the target group.
 always string arn:aws:elasticloadbalancing:ap-southeast-2:01234567890:targetgroup/mytargetgroup/aabbccddee0044332211
deregistration_delay_timeout_seconds
The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused.
 always int 300
healthy_threshold_count
The number of consecutive health checks successes required before considering an unhealthy target healthy.
 always int 5
port
The port on which the targets are listening.
 always int 80
load_balancer_arns
The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
 always list []
health_check_protocol
The protocol to use to connect with the target.
 always string HTTP
unhealthy_threshold_count
The number of consecutive health check failures required before considering the target unhealthy.
 always int 2
stickiness_type
The type of sticky sessions.
 always string lb_cookie
health_check_timeout_seconds
The amount of time, in seconds, during which no response means a failed health check.
 always int 5
stickiness_lb_cookie_duration_seconds
Indicates whether sticky sessions are enabled.
 always int 86400
stickiness_enabled
Indicates whether sticky sessions are enabled.
 always bool True
health_check_path
The destination for the health check request.
 always string /index.html
vpc_id
The ID of the VPC for the targets.
 always string vpc-0123456
health_check_interval_seconds
The approximate amount of time, in seconds, between health checks of an individual target.
 always int 30

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence 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
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html
  • 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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/elb_target_group_facts_module.html