ansible / ansible.builtin / v2.9.0 / module / ec2_eip manages EC2 elastic IP (EIP) addresses. | "added in version" 1.4 of ansible.builtin" Authors: Rick Mendes (@rickmendes) <rmendes@illumina.com> stableinterface | supported by communityansible.builtin.ec2_eip (v2.9.0) — module
pip
Install with pip install ansible==2.9.0
This module can allocate or release an EIP.
This module can associate/disassociate an EIP with instances or network interfaces.
# 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
state: choices: - present - absent default: present description: - 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. in_vpc: default: 'no' description: - Allocate an EIP inside a VPC or not. Required if specifying an ENI. type: bool version_added: '1.4' version_added_collection: ansible.builtin 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 tag_name: default: 'no' description: - When reuse_existing_ip_allowed is true, supplement with this option to only reuse an Elastic IP if it is tagged with tag_name. version_added: '2.9' version_added_collection: ansible.builtin device_id: aliases: - instance_id description: - The id of the device for the EIP. Can be an EC2 Instance id or Elastic Network Interface (ENI) id. required: false version_added: '2.0' version_added_collection: ansible.builtin public_ip: aliases: - ip description: - 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. tag_value: default: 'no' description: - Supplements tag_name but also checks that the value of the tag provided in tag_name matches tag_value. matches the tag_value version_added: '2.9' version_added_collection: ansible.builtin 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. - 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 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_session_token - session_token - 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. - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0. 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 public_ipv4_pool: default: 'no' description: - 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. version_added: '2.9' version_added_collection: ansible.builtin private_ip_address: description: - The primary or secondary private IP address to associate with the Elastic IP address. version_added: '2.3' version_added_collection: ansible.builtin allow_reassociation: default: 'no' description: - 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. type: bool version_added: '2.5' version_added_collection: ansible.builtin release_on_disassociation: default: 'no' description: - whether or not to automatically release the EIP when it is disassociated type: bool version_added: '2.0' version_added_collection: ansible.builtin reuse_existing_ip_allowed: default: 'no' description: - Reuse an EIP that is not associated to a device (when available), instead of allocating a new one. type: bool version_added: '1.6' version_added_collection: ansible.builtin 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
allocation_id: description: allocation_id of the elastic ip returned: on success sample: eipalloc-51aa3a6c type: str public_ip: description: an elastic ip address returned: on success sample: 52.88.159.209 type: str