ansible / ansible.builtin / v2.9.17 / module / elb_target Manage a target in a target group | "added in version" 2.5 of ansible.builtin" Authors: Rob White (@wimnat) preview | supported by communityansible.builtin.elb_target (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Used to register or deregister a target in a target group
# 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
state: choices: - present - absent description: - Register or deregister the target. required: true 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: aliases: - aws_endpoint_url - endpoint_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: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str target_az: description: - 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_id: description: - The ID of the target. required: true 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 target_port: default: The default port for a target is the port for the target group. description: - 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. required: false aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path target_status: choices: - initial - healthy - unhealthy - unused - draining - unavailable description: - Blocks and waits for the target status to equal given value. For more detail on target status see U(https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html#target-health-states) required: false aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool target_group_arn: description: - The Amazon Resource Name (ARN) of the target group. Mutually exclusive of I(target_group_name). deregister_unused: description: - The default behaviour for targets that are unused is to leave them registered. If instead you would like to remove them set I(deregister_unused) to yes. type: bool target_group_name: description: - The name of the target group. Mutually exclusive of I(target_group_arn). target_status_timeout: default: 60 description: - Maximum time in seconds to wait for target_status change 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