amazon.aws.ec2_eni 模块 – 创建并可选地将弹性网络接口 (ENI) 附加到实例

注意

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

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

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

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

amazon.aws 1.0.0 中的新增功能

概要

• 创建并可选地将弹性网络接口 (ENI) 附加到实例。

• 如果提供 eni_id 或 private_ip_address，则将修改现有 ENI（如果存在）。

• attached 参数控制网络接口的附加状态。

要求

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

• 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_reassignment 布尔值	指示是否允许将已分配给另一个网络接口或实例的 IP 地址重新分配给指定的网络接口。 选项 false ← (默认) true
attached 布尔值	指定网络接口是否应附加到或从实例分离。如果省略，附加状态将不会更改 选项 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
delete_on_termination 布尔值	当附加它的实例终止时删除接口。只有在修改接口时才能指定此标志，而不能在创建时指定。 选项 false true
description 字符串	ENI 的可选描述。
device_index 整数	实例上网络接口附加的设备索引。 默认值： 0
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之后的一个版本中移除。
eni_id 字符串	ENI（要修改的）的 ID。 如果eni_id=None且state=present，则会创建一个新的 ENI。
force_detach 布尔值	强制分离接口。当通过设置instance_id=None显式分离接口或使用state=absent删除接口时，此选项适用。 选项 false ← (默认) true
instance_id 字符串	要将 ENI 附加到的实例 ID。
name 字符串	ENI 的名称。这将创建一个键为Name，值为此处指定值的标签。 这可以与subnet_id结合使用，作为识别网络接口的另一种方法。 AWS 并不强制执行唯一的Name标签，因此如果您这样配置，则可能出现重复名称。如果是这种情况，您需要提供其他识别信息，例如private_ip_address或eni_id。
private_ip_address 字符串	私有 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选项互斥。
purge_secondary_private_ip_addresses 布尔值	与secondary_private_ip_addresses一起使用，以确定是否删除除指定以外的任何辅助 IP 地址。 设置secondary_private_ip_addresses=[]可清除所有辅助地址。 选项 false ← (默认) 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之后的一个版本中移除。
secondary_private_ip_address_count 整数	要分配给网络接口的辅助 IP 地址数量。 此选项与secondary_private-ip-addresses互斥。
secondary_private_ip_addresses 列表 / 元素=字符串	要分配为网络接口的辅助 IP 地址的 IP 地址列表。 此选项与secondary_private_ip_address_count互斥。
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 botocore SDK 保持一致，在 5.1.0 版本中添加了aws_secret_access_key别名。 别名ec2_secret_key已弃用，将在2024-12-01之后的一个版本中移除。 对环境变量EC2_SECRET_KEY的支持已弃用，将在2024-12-01之后的一个版本中移除。
security_groups 列表 / 元素=字符串	与接口关联的安全组列表。 当state=absent时忽略。 默认值：[]
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之后的一个版本中移除。
source_dest_check 布尔值	默认情况下，接口执行源/目标检查。但是，NAT 实例需要禁用此检查。只有在修改接口时才能指定此标志，而不能在创建时指定。 选项 false true
state 字符串	创建或删除 ENI。 选项 "present" ← (默认) "absent"
subnet_id 字符串	要在其中创建 ENI 的子网 ID。
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果没有设置tags参数，则不会修改标签。
validate_certs 布尔值	设置为false时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置validate_certs=false，作为替代方案，请考虑改用aws_ca_bundle。 选项 false true ← (默认)

备注

注意

• 此模块基于以下任一条件标识和识别弹性网络接口 (ENI)：eni_id、private_ip_address 和 subnet_id 的组合，或 instance_id 和 device_index 的组合。任何这些选项都允许您指定特定的 ENI。

• 对 tags 和 purge_tags 的支持已在 1.3.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.

# Create an ENI. As no security group is defined, ENI will be created in default security group
- amazon.aws.ec2_eni:
    private_ip_address: 172.31.0.20
    subnet_id: subnet-xxxxxxxx
    state: present

# Create an ENI and attach it to an instance
- amazon.aws.ec2_eni:
    instance_id: i-xxxxxxx
    device_index: 1
    private_ip_address: 172.31.0.20
    subnet_id: subnet-xxxxxxxx
    state: present

# Create an ENI with two secondary addresses
- amazon.aws.ec2_eni:
    subnet_id: subnet-xxxxxxxx
    state: present
    secondary_private_ip_address_count: 2

# Assign a secondary IP address to an existing ENI
# This will purge any existing IPs
- amazon.aws.ec2_eni:
    subnet_id: subnet-xxxxxxxx
    eni_id: eni-yyyyyyyy
    state: present
    secondary_private_ip_addresses:
      - 172.16.1.1

# Remove any secondary IP addresses from an existing ENI
- amazon.aws.ec2_eni:
    subnet_id: subnet-xxxxxxxx
    eni_id: eni-yyyyyyyy
    state: present
    secondary_private_ip_address_count: 0

# Destroy an ENI, detaching it from any instance if necessary
- amazon.aws.ec2_eni:
    eni_id: eni-xxxxxxx
    force_detach: true
    state: absent

# Update an ENI
- amazon.aws.ec2_eni:
    eni_id: eni-xxxxxxx
    description: "My new description"
    state: present

# Update an ENI using name and subnet_id
- amazon.aws.ec2_eni:
    name: eni-20
    subnet_id: subnet-xxxxxxx
    description: "My new description"
    state: present

# Update an ENI identifying it by private_ip_address and subnet_id
- amazon.aws.ec2_eni:
    subnet_id: subnet-xxxxxxx
    private_ip_address: 172.16.1.1
    description: "My new description"

# Detach an ENI from an instance
- amazon.aws.ec2_eni:
    eni_id: eni-xxxxxxx
    instance_id: None
    state: present

### Delete an interface on termination
# First create the interface
- amazon.aws.ec2_eni:
    instance_id: i-xxxxxxx
    device_index: 1
    private_ip_address: 172.31.0.20
    subnet_id: subnet-xxxxxxxx
    state: present
  register: eni

# Modify the interface to enable the delete_on_terminaton flag
- amazon.aws.ec2_eni:
    eni_id: "{{ eni.interface.id }}"
    delete_on_termination: true

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
interface 复杂	网络接口属性。 返回：当 state != absent 时
attachment 字典	网络接口附件。 返回：成功 示例： {"attach_time": "2024-04-25T20:57:20+00:00", "attachment_id": "eni-attach-0ddce58b341a1846f", "delete_on_termination": true, "device_index": 0, "instance_id": "i-032cb1cceb29250d2", "status": "attached"}
description 字符串	接口描述。 返回：成功 示例： "Firewall network interface"
groups 字典	安全组字典。 返回：成功 示例： {"sg-f8a8a9da": "default"}
id 字符串	网络接口 ID。 返回：成功 示例： "eni-1d889198"
mac_address 字符串	接口的物理地址。 返回：成功 示例： "00:00:5E:00:53:23"
name 字符串	ENI 的名称。 返回：成功 示例： "my-eni-20"
owner_id 字符串	AWS 账户 ID。 返回：成功 示例： "812381371"
private_ip_address 字符串	此接口的主 IP 地址。 返回：成功 示例： "10.20.30.40"
private_ip_addresses 列表 / 元素=字典	与该接口关联的所有私有 IP 地址列表。 返回：成功 示例： [{"primary_address": true, "private_ip_address": "10.20.30.40"}]
source_dest_check 布尔值	源/目标检查标志的值。 返回：成功 示例： true
status 字符串	网络接口状态。 返回：成功 示例： "pending"
subnet_id 字符串	接口绑定的 VPC 子网。 返回：成功 示例： "subnet-b0a0393c"
tags 字典	与 ENI 关联的标签字典。 返回：成功 示例： {"Name": "my-eni", "group": "Finance"}
vpc_id 字符串	此网络接口绑定的 VPC。 返回：成功 示例： "vpc-9a9a9da"

作者

• Rob White (@wimnat)

• Mike Healey (@healem)

集合链接

• 问题跟踪器
• 代码库（源代码）
• 通信