ec2_eip – manages EC2 elastic IP (EIP) addresses — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ec2_eip – manages EC2 elastic IP (EIP) addresses

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- This module can allocate or release an EIP.
- This module can associate/disassociate an EIP with instances or network interfaces.

## Requirements

The below requirements are needed on the host that executes this module.

- python >= 2.6
- boto

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
allow_reassociation boolean added in 2.5 | Choices: no ← yes | Specify this option to allow an Elastic IP address that is already associated with another network interface or instance to be re-associated with the specified instance or interface.
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 | Choices: no ← yes | 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.
device_id - |  | The id of the device for the EIP. Can be an EC2 Instance id or Elastic Network Interface (ENI) id. aliases: instance_id
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.
in_vpc boolean | Choices: no ← yes | Allocate an EIP inside a VPC or not. Required if specifying an ENI.
private_ip_address - |  | The primary or secondary private IP address to associate with the Elastic IP address.
profile string |  | Uses a boto profile. Only works with boto >= 2.24.0.
public_ip - |  | The IP address of a previously allocated EIP. If present and device is specified, the EIP is associated with the device. If absent and device is specified, the EIP is disassociated from the device. aliases: ip
public_ipv4_pool - added in 2.9 | Default: "no" | Allocates the new Elastic IP from the provided public IPv4 pool (BYOIP) only applies to newly allocated Elastic IPs, isn't validated when reuse_existing_ip_allowed is true.
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
release_on_disassociation boolean | Choices: no ← yes | whether or not to automatically release the EIP when it is disassociated
reuse_existing_ip_allowed boolean | Choices: no ← yes | Reuse an EIP that is not associated to a device (when available), instead of allocating a new one.
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 - | Choices: present ← absent | If present, allocate an EIP or associate an existing EIP with a device. If absent, disassociate the EIP from the device and optionally release it.
tag_name - added in 2.9 | Default: "no" | When reuse_existing_ip_allowed is true, supplement with this option to only reuse an Elastic IP if it is tagged with tag_name.
tag_value - added in 2.9 | Default: "no" | Supplements tag_name but also checks that the value of the tag provided in tag_name matches tag_value. matches the tag_value
validate_certs boolean | Choices: no yes ← | When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

## Notes

Note

- There may be a delay between the time the EIP is assigned and when the cloud instance is reachable via the new address. Use wait_for and pause to delay further playbook execution until the instance is reachable, if necessary.
- This module returns multiple changed statuses on disassociation or release. It returns an overall status based on any changes occurring. It also returns individual changed statuses for disassociation and release.
- 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 https://boto.readthedocs.io/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

## Examples

    # Note: These examples do not set authentication details, see the AWS Guide for details.

    - name: associate an elastic IP with an instance
      ec2_eip:
        device_id: i-1212f003
        ip: 93.184.216.119

    - name: associate an elastic IP with a device
      ec2_eip:
        device_id: eni-c8ad70f3
        ip: 93.184.216.119

    - name: associate an elastic IP with a device and allow reassociation
      ec2_eip:
        device_id: eni-c8ad70f3
        public_ip: 93.184.216.119
        allow_reassociation: yes

    - name: disassociate an elastic IP from an instance
      ec2_eip:
        device_id: i-1212f003
        ip: 93.184.216.119
        state: absent

    - name: disassociate an elastic IP with a device
      ec2_eip:
        device_id: eni-c8ad70f3
        ip: 93.184.216.119
        state: absent

    - name: allocate a new elastic IP and associate it with an instance
      ec2_eip:
        device_id: i-1212f003

    - name: allocate a new elastic IP without associating it to anything
      ec2_eip:
        state: present
      register: eip

    - name: output the IP
      debug:
        msg: "Allocated IP is {{ eip.public_ip }}"

    - name: provision new instances with ec2
      ec2:
        keypair: mykey
        instance_type: c1.medium
        image: ami-40603AD1
        wait: yes
        group: webserver
        count: 3
      register: ec2

    - name: associate new elastic IPs with each of the instances
      ec2_eip:
        device_id: "{{ item }}"
      loop: "{{ ec2.instance_ids }}"

    - name: allocate a new elastic IP inside a VPC in us-west-2
      ec2_eip:
        region: us-west-2
        in_vpc: yes
      register: eip

    - name: output the IP
      debug:
        msg: "Allocated IP inside a VPC is {{ eip.public_ip }}"

    - name: allocate eip - reuse unallocated ips (if found) with FREE tag
      ec2_eip:
        region: us-east-1
        in_vpc: yes
        reuse_existing_ip_allowed: yes
        tag_name: FREE

    - name: allocate eip - reuse unallocted ips if tag reserved is nope
      ec2_eip:
        region: us-east-1
        in_vpc: yes
        reuse_existing_ip_allowed: yes
        tag_name: reserved
        tag_value: nope

    - name: allocate new eip - from servers given ipv4 pool
      ec2_eip:
        region: us-east-1
        in_vpc: yes
        public_ipv4_pool: ipv4pool-ec2-0588c9b75a25d1a02

    - name: allocate eip - from a given pool (if no free addresses where dev-servers tag is dynamic)
      ec2_eip:
        region: us-east-1
        in_vpc: yes
        reuse_existing_ip_allowed: yes
        tag_name: dev-servers
        public_ipv4_pool: ipv4pool-ec2-0588c9b75a25d1a02

    - name: allocate eip from pool - check if tag reserved_for exists and value is our hostname
      ec2_eip:
        region: us-east-1
        in_vpc: yes
        reuse_existing_ip_allowed: yes
        tag_name: reserved_for
        tag_value: "{{ inventory_hostname }}"
        public_ipv4_pool: ipv4pool-ec2-0588c9b75a25d1a02

## Return Values

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

Key | Returned | Description
--- | --- | ---
allocation_id string | on success | allocation_id of the elastic ip Sample: eipalloc-51aa3a6c
public_ip string | on success | an elastic ip address Sample: 52.88.159.209

## Status

- This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
- This module is maintained by the Ansible Community. [community]

### Authors

- Rick Mendes (@rickmendes) <rmendes@illumina.com>

Hint

If you notice any issues in this documentation, you can edit this document to improve it.