ansible / ansible.builtin / v2.8.19 / module / ec2_eip_facts List EC2 EIP details | "added in version" 2.6 of ansible.builtin" Authors: Brad Macpherson (@iiibrad) preview | supported by communityansible.builtin.ec2_eip_facts (v2.8.19) — module
pip
Install with pip install ansible==2.8.19
List details of EC2 Elastic IP addresses.
# Note: These examples do not set authentication details or the AWS region, # see the AWS Guide for details. # List all EIP addresses in the current region. - ec2_eip_facts: register: regional_eip_addresses
# List all EIP addresses for a VM. - ec2_eip_facts: filters: instance-id: i-123456789 register: my_vm_eips
- debug: msg="{{ my_vm_eips.addresses | json_query("[?private_ip_address=='10.0.0.5']") }}"
# List all EIP addresses for several VMs. - ec2_eip_facts: filters: instance-id: - i-123456789 - i-987654321 register: my_vms_eips
# List all EIP addresses using the 'Name' tag as a filter. - ec2_eip_facts: filters: tag:Name: www.example.com register: my_vms_eips
# List all EIP addresses using the Allocation-id as a filter - ec2_eip_facts: filters: allocation-id: eipalloc-64de1b01 register: my_vms_eips
# Set the variable eip_alloc to the value of the first allocation_id # and set the variable my_pub_ip to the value of the first public_ip - set_fact: eip_alloc: my_vms_eips.addresses[0].allocation_id my_pub_ip: my_vms_eips.addresses[0].public_ip
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 filters: default: {} description: - A dict of filters to apply. Each dict item consists of a filter key and filter value. See U(https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-addresses.html#options) for possible filters. Filter names and values are case sensitive. required: false profile: aliases: - aws_profile description: - Uses a boto profile. Only works with boto >= 2.24.0. - 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 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_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Only used for boto3 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 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. - 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: - 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. - 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: - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or 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 boto versions >= 2.6.0. type: bool 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
addresses: description: Properties of all Elastic IP addresses matching the provided filters. Each element is a dict with all the information related to an EIP. returned: on success sample: - allocation_id: eipalloc-64de1b01 association_id: eipassoc-0fe9ce90d6e983e97 domain: vpc instance_id: i-01020cfeb25b0c84f network_interface_id: eni-02fdeadfd4beef9323b network_interface_owner_id: 0123456789 private_ip_address: 10.0.0.1 public_ip: 54.81.104.1 tags: Name: test-vm-54.81.104.1 type: list