New in version 2.7.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
aws_access_key | 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 | 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 | 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. | |
get_unused_target_groups bool |
| Whether or not to get target groups not used by any load balancers. |
instance_id str required | What instance ID to get facts for. | |
profile (added in 1.6) | Uses a boto profile. Only works with boto >= 2.24.0. | |
region | 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) | 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 | |
validate_certs bool (added in 1.5) |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
Note
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
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# practical use case - dynamically deregistering and reregistering nodes - name: Get EC2 Metadata action: ec2_metadata_facts - name: Get initial list of target groups delegate_to: localhost elb_target_facts: instance_id: "{{ ansible_ec2_instance_id }}" region: "{{ ansible_ec2_placement_region }}" register: target_facts - name: save fact for later set_fact: original_tgs: "{{ target_facts.instance_target_groups }}" - name: Deregister instance from all target groups delegate_to: localhost elb_target: target_group_arn: "{{ item.0.target_group_arn }}" target_port: "{{ item.1.target_port }}" target_az: "{{ item.1.target_az }}" target_id: "{{ item.1.target_id }}" state: absent target_status: "draining" region: "{{ ansible_ec2_placement_region }}" with_subelements: - "{{ original_tgs }}" - "targets" # This avoids having to wait for 'elb_target' to serially deregister each # target group. An alternative would be to run all of the 'elb_target' # tasks async and wait for them to finish. - name: wait for all targets to deregister simultaneously delegate_to: localhost elb_target_facts: get_unused_target_groups: false instance_id: "{{ ansible_ec2_instance_id }}" region: "{{ ansible_ec2_placement_region }}" register: target_facts until: (target_facts.instance_target_groups | length) == 0 retries: 60 delay: 10 - name: reregister in elbv2s elb_target: region: "{{ ansible_ec2_placement_region }}" target_group_arn: "{{ item.0.target_group_arn }}" target_port: "{{ item.1.target_port }}" target_az: "{{ item.1.target_az }}" target_id: "{{ item.1.target_id }}" state: present target_status: "initial" with_subelements: - "{{ original_tgs }}" - "targets" # wait until all groups associated with this instance are 'healthy' or # 'unused' - name: wait for registration elb_target_facts: get_unused_target_groups: false instance_id: "{{ ansible_ec2_instance_id }}" region: "{{ ansible_ec2_placement_region }}" register: target_facts until: (target_facts.instance_target_groups | map(attribute='targets') | flatten | map(attribute='target_health') | rejectattr('state', 'equalto', 'healthy') | rejectattr('state', 'equalto', 'unused') | list | length) == 0 retries: 61 delay: 10 # using the target groups to generate AWS CLI commands to reregister the # instance - useful in case the playbook fails mid-run and manual # rollback is required - name: "reregistration commands: ELBv2s" debug: msg: > aws --region {{ansible_ec2_placement_region}} elbv2 register-targets --target-group-arn {{item.target_group_arn}} --targets{%for target in item.targets%} Id={{target.target_id}}, Port={{target.target_port}}{%if target.target_az%},AvailabilityZone={{target.target_az}} {%endif%} {%endfor%} with_items: "{{target_facts.instance_target_groups}}"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||
---|---|---|---|---|---|
instance_target_groups complex | always | a list of target groups to which the instance is registered to | |||
target_group_arn string | always | The ARN of the target group Sample: ['arn:aws:elasticloadbalancing:eu-west-1:111111111111:targetgroup/target-group/deadbeefdeadbeef'] | |||
targets complex | always | A list of targets that point to this instance ID | |||
target_id str | always | the target ID referiing to this instance Sample: ['i-deadbeef', '1.2.3.4'] | |||
target_az str | when an AZ is associated with this instance | which availability zone is explicitly associated with this target Sample: ['us-west-2a'] | |||
target_port str | always | which port this target is listening on Sample: [80] | |||
target_health complex | always | the target health description (see https://boto3.readthedocs.io/en/latest/ reference/services/elbv2.html#ElasticLoadBalancingv2.Client.describe_target_health) for all possible values | |||
reason | if state!=healthy | reason code for target health Sample: ['Target.Deregistration in progress'] | |||
description | if state!=present | description of target health Sample: ['Target desregistration is in progress'] | |||
state | always | health state Sample: ['healthy', 'draining', 'initial', 'unhealthy', 'unused', 'unavailable'] | |||
target_group_type string | always | Which target type is used for this group Sample: ['ip', 'instance'] |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/elb_target_facts_module.html