elb_target – Manage a target in a target group¶
New in version 2.5.
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.6
- boto
Parameters¶
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.
|
deregister_unused
boolean
|
|
The default behaviour for targets that are unused is to leave them registered. If instead you would like to remove them set deregister_unused to yes.
|
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.
|
|
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 |
|
state
-
/ required
|
|
Register or deregister the target.
|
target_az
-
|
An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer. This parameter is not supported if the target type of the target group is instance.
|
|
target_group_arn
-
|
The Amazon Resource Name (ARN) of the target group. Mutually exclusive of target_group_name.
|
|
target_group_name
-
|
The name of the target group. Mutually exclusive of target_group_arn.
|
|
target_id
-
/ required
|
The ID of the target.
|
|
target_port
-
|
Default: "The default port for a target is the port for the target group."
|
The port on which the target is listening. You can specify a port override. If a target is already registered, you can register it again using a different port.
|
target_status
-
|
|
Blocks and waits for the target status to equal given value. For more detail on target status see https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html#target-health-states
|
target_status_timeout
-
|
Default: 60
|
Maximum time in seconds to wait for target_status change
|
validate_certs
boolean
|
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
Notes¶
Note
- If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it.
- 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_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
- 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.
# Register an IP address target to a target group
- elb_target:
target_group_name: myiptargetgroup
target_id: i-1234567
state: present
# Register an instance target to a target group
- elb_target:
target_group_name: mytargetgroup
target_id: i-1234567
state: present
# Deregister a target from a target group
- elb_target:
target_group_name: mytargetgroup
target_id: i-1234567
state: absent
# Modify a target to use a different port
# Register a target to a target group
- elb_target:
target_group_name: mytargetgroup
target_id: i-1234567
target_port: 8080
state: present
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Rob White (@wimnat)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.