amazon.aws.ec2_eip 模块 – 管理 EC2 弹性 IP (EIP) 地址。

注意

此模块是 amazon.aws 集合（版本 9.0.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install amazon.aws。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定： amazon.aws.ec2_eip。

amazon.aws 5.0.0 中的新增功能

概要 

此模块可以分配或释放 EIP。
此模块可以将 EIP 与实例或网络接口关联/取消关联。
此模块最初在 1.0.0 版本中添加到 community.aws。

要求 

执行此模块的主机需要满足以下要求。

python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0

参数 

参数	注释
access_key 别名：aws_access_key_id, aws_access_key, ec2_access_key 字符串	AWS 访问密钥 ID。有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。还可以使用 `AWS_ACCESS_KEY_ID`、`AWS_ACCESS_KEY` 或 `EC2_ACCESS_KEY` 环境变量，优先级依次递减。 aws_access_key 和 profile 选项是互斥的。为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。对 `EC2_ACCESS_KEY` 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
allow_reassociation 布尔值	指定此选项以允许将已与另一个网络接口或实例关联的弹性 IP 地址重新关联到指定的实例或接口。选择 `false` ←（默认） `true`
aws_ca_bundle 路径	验证 SSL 证书时要使用的 CA 包的位置。也可以使用 `AWS_CA_BUNDLE` 环境变量。
aws_config 字典	用于修改 botocore 配置的字典。可以在 AWS 文档 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config 中找到参数。
debug_botocore_endpoint_logs 布尔值	使用 `botocore.endpoint` 记录器来解析任务期间执行的唯一（而非总计）`"resource:action"` API 调用，并将该集合输出到任务结果中的 resource_actions 键中。使用 `aws_resource_action` 回调输出在 playbook 期间执行的总列表。也可以使用 `ANSIBLE_DEBUG_BOTOCORE_LOGS` 环境变量。选择 `false` ←（默认） `true`
device_id 字符串	EIP 的设备 ID。可以是 EC2 实例 ID 或弹性网络接口 (ENI) ID。当指定 ENI ID 时，`in_vpc` 必须为 `true`。 instance_id 别名已在 6.0.0 版本中删除。
domain_name 字符串在 amazon.aws 8.3.0 中添加	要附加到 IP 地址的域名。
endpoint_url 别名：ec2_url, aws_endpoint_url, s3_url 字符串	要连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他 AWS 兼容服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。还可以使用 `AWS_URL` 或 `EC2_URL` 环境变量，优先级依次递减。 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的版本中删除。对 `EC2_URL` 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
in_vpc 布尔值	在 VPC 内部或外部分配 EIP。如果使用 `device_id` 指定 ENI，则为必填项。选择 `false` ←（默认） `true`
private_ip_address 字符串	要与弹性 IP 地址关联的主或辅助私有 IP 地址。
profile 别名：aws_profile 字符串	用于身份验证的已命名 AWS 配置文件。有关已命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。也可以使用 `AWS_PROFILE` 环境变量。 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。
public_ip 别名：ip 字符串	先前分配的 EIP 的 IP 地址。当 `state=present` 且指定了设备时，EIP 将与该设备关联。当 `state=absent` 且指定了设备时，EIP 将与该设备解除关联。
public_ipv4_pool 字符串	仅从提供的公有 IPv4 池 (BYOIP) 分配新的弹性 IP，仅适用于新分配的弹性 IP，当 `reuse_existing_ip_allowed=true` 时不进行验证。
purge_tags 布尔值	如果 `purge_tags=true` 且设置了 `tags`，则现有标签将从资源中清除，以精确匹配 `tags` 参数定义的标签。如果未设置 `tags` 参数，则即使 `purge_tags=True`，也不会修改标签。以 `aws:` 开头的标签键由 Amazon 保留，不能修改。因此，为了 `purge_tags` 参数的目的，它们将被忽略。有关更多信息，请参阅 Amazon 文档 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。选择 `false` `true` ← (默认)
region 别名：aws_region, ec2_region 字符串	要使用的 AWS 区域。对于诸如 IAM、Route53 和 CloudFront 之类的全局服务，将忽略 region。也可以使用 `AWS_REGION` 或 `EC2_REGION` 环境变量。有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 `ec2_region` 别名已弃用，将在 2024-12-01 之后的版本中删除。对 `EC2_REGION` 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
release_on_disassociation 布尔值	解除关联时是否自动释放 EIP。选择 `false` ←（默认） `true`
reuse_existing_ip_allowed 布尔值	重用未与设备关联的 EIP（如果可用），而不是分配新的 EIP。选择 `false` ←（默认） `true`
secret_key 别名：aws_secret_access_key, aws_secret_key, ec2_secret_key 字符串	AWS 私有访问密钥。有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。也可以按优先级递减顺序使用 `AWS_SECRET_ACCESS_KEY`、`AWS_SECRET_KEY` 或 `EC2_SECRET_KEY` 环境变量。 secret_key 和 profile 选项是互斥的。 aws_secret_access_key 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 ec2_secret_key 别名已弃用，将在 2024-12-01 之后的版本中删除。对 `EC2_SECRET_KEY` 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
session_token 别名：aws_session_token, security_token, aws_security_token, access_token 字符串	用于临时凭证的 AWS STS 会话令牌。有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。也可以按优先级递减顺序使用 `AWS_SESSION_TOKEN`、`AWS_SECURITY_TOKEN` 或 `EC2_SECURITY_TOKEN` 环境变量。 security_token 和 profile 选项是互斥的。别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数在 6.0.0 版本中从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已弃用，将在 2024-12-01 之后的版本中删除。对 `EC2_SECRET_KEY` 和 `AWS_SECURITY_TOKEN` 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
state 字符串	当 `state=present` 时，分配一个 EIP 或将现有 EIP 与设备关联。当 `state=absent` 时，将 EIP 与设备解除关联，并可以选择释放它。选择 `"present"` ← (默认) `"absent"`
tag_name 字符串	当 `reuse_existing_ip_allowed=true` 时，使用此选项仅重用标记为 `tag_name` 的弹性 IP。
tag_value 字符串	补充 `tag_name`，同时检查 `tag_name` 中提供的标签值是否与 `tag_value` 匹配。
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。如果未设置 `tags` 参数，则不会修改标签。
validate_certs 布尔值	设置为 `false` 时，与 AWS API 通信时不会验证 SSL 证书。强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。选择 `false` `true` ← (默认)

备注 

注意

EIP 分配的时间与云实例通过新地址可访问的时间之间可能存在延迟。如有必要，请使用 wait_for 和 pause 来延迟进一步的剧本执行，直到实例可访问。
此模块在解除关联或释放时返回多个已更改的状态。它返回基于任何发生的更改的总体状态。它还返回解除关联和释放的各个已更改状态。
对 tags 和 purge_tags 的支持在 2.1.0 版本中添加。
注意： 对于模块，环境变量和配置文件是从 Ansible “主机” 上下文而不是 “控制器” 上下文读取的。因此，可能需要将文件显式复制到 “主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible “控制器” 上下文而不是 “主机” 上下文读取的。
Ansible 使用的 AWS SDK (boto3) 也可能从其在 Ansible “主机” 上下文中的配置文件（通常是 ~/.aws/credentials）读取凭据和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例 

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

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

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

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

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

- name: disassociate an elastic IP with a device
  amazon.aws.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
  amazon.aws.ec2_eip:
    device_id: i-1212f003

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

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

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

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

- name: allocate a new elastic IP inside a VPC in us-west-2
  amazon.aws.ec2_eip:
    region: us-west-2
    in_vpc: true
  register: eip

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

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

- name: allocate eip - reuse unallocated ips if tag reserved is nope
  amazon.aws.ec2_eip:
    region: us-east-1
    in_vpc: true
    reuse_existing_ip_allowed: true
    tag_name: reserved
    tag_value: nope

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

- name: allocate eip - from a given pool (if no free addresses where dev-servers tag is dynamic)
  amazon.aws.ec2_eip:
    region: us-east-1
    in_vpc: true
    reuse_existing_ip_allowed: true
    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
  amazon.aws.ec2_eip:
    region: us-east-1
    in_vpc: true
    reuse_existing_ip_allowed: true
    tag_name: reserved_for
    tag_value: "{{ inventory_hostname }}"
    public_ipv4_pool: ipv4pool-ec2-0588c9b75a25d1a02

- name: create new IP and modify it's reverse DNS record
  amazon.aws.ec2_eip:
    state: present
    domain_name: test-domain.xyz

- name: Modify reverse DNS record of an existing EIP
  amazon.aws.ec2_eip:
    public_ip: 44.224.84.105
    domain_name: test-domain.xyz
    state: present

- name: Remove reverse DNS record of an existing EIP
  amazon.aws.ec2_eip:
    public_ip: 44.224.84.105
    domain_name: ""
    state: present

返回值 

通用返回值记录在此处，以下是此模块独有的字段

键	描述
allocation_id 字符串	弹性 IP 的分配 ID。返回：成功时示例： `"eipalloc-51aa3a6c"`
public_ip 字符串	弹性 IP 地址。返回：成功时示例： `"52.88.159.209"`
update_reverse_dns_record_result 字典	有关更新反向 DNS 记录操作结果的信息。返回：当指定 `domain_name` 时。
address 字典	有关弹性 IP 地址的信息。返回：始终
allocation_id 字符串	分配 ID。返回：始终示例： `"eipalloc-00a11aa111aaa1a11"`
ptr_record 字符串	IP 地址的指针 (PTR) 记录。返回：始终示例: `"ec2-11-22-33-44.us-east-2.compute.amazonaws.com."`
ptr_record_update 字典	IP 地址的更新后的 PTR 记录。返回：始终
status 字符串	PTR 记录更新的状态。返回：始终示例: `"PENDING"`
value 字符串	PTR 记录更新的值。返回：始终示例: `"example.com"`
public_ip 字符串	公共 IP 地址。返回：始终示例: `"11.22.33.44"`

作者

Rick Mendes (@rickmendes)