amazon.aws.ec2_eni_info 模块 – 收集 AWS 中 EC2 ENI 接口信息

注意

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

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

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

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

amazon.aws 1.0.0 中的新增功能

概要

• 收集 AWS 中 EC2 ENI 接口信息。

要求

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

• 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 保持一致，aws_access_key_id 别名是在 5.1.0 版本中添加的。 ec2_access_key 别名已弃用，并将在 2024-12-01 之后的一个版本中删除。 EC2_ACCESS_KEY 环境变量的支持已弃用，并将在 2024-12-01 之后的一个版本中删除。
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
endpoint_url 别名：ec2_url，aws_endpoint_url，s3_url 字符串	连接到默认 AWS 端点以外的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次递减。 ec2_url 和 s3_url 别名已弃用，并将在 2024-12-01 之后的一个版本中删除。 EC2_URL 环境变量的支持已弃用，并将在 2024-12-01 之后的一个版本中删除。
eni_id 字符串 amazon.aws 1.3.0 中新增	ENI 的 ID。 此选项与 filters 互斥。
filters 字典	要应用的过滤器字典。每个字典项都包含一个过滤器键和一个过滤器值。有关可能的过滤器，请参阅 https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInterfaces.html。 此选项与 eni_id 互斥。 默认值： {}
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 选项互斥。
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之后的一个版本中移除。
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之后的一个版本中移除。
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之后的一个版本中移除。
validate_certs 布尔值	设置为false时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置validate_certs=false，作为替代方案，请考虑设置aws_ca_bundle。 选项 false true ← (默认)

备注

注意

• 警告：对于模块，环境变量和配置文件是从 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.

# Gather information about all ENIs
- amazon.aws.ec2_eni_info:

# Gather information about a particular ENI
- amazon.aws.ec2_eni_info:
    filters:
      network-interface-id: eni-xxxxxxx

返回值

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

键	描述
network_interfaces 复杂类型	匹配的弹性网络接口列表。 返回值：始终返回
association 字典	关联的弹性 IP (EIP) 信息。 返回值：当 ENI 与 EIP 关联时返回 示例：{"allocation_id": "eipalloc-5sdf123", "association_id": "eipassoc-8sdf123", "ip_owner_id": "123456789012", "public_dns_name": "ec2-52-1-0-63.compute-1.amazonaws.com", "public_ip": "52.1.0.63"}
attachment 字典	有关附加的 EC2 实例的信息。 返回值：当 ENI 附加到 EC2 实例时返回 示例：{"attach_time": "2017-08-05T15:25:47+00:00", "attachment_id": "eni-attach-149d21234", "delete_on_termination": false, "device_index": 1, "instance_id": "i-15b8d3cadbafa1234", "instance_owner_id": "123456789012", "network_card_index": 0, "status": "attached"}
availability_zone 字符串	ENI 的可用区。 返回值：始终返回 示例："us-east-1b"
description 字符串	ENI 的描述文本。 返回值：始终返回 示例："My favourite network interface"
groups 列表 / 元素=字符串	附加的安全组列表。 返回值：始终返回 示例：[{"group_id": "sg-26d0f1234", "group_name": "my_ec2_security_group"}]
id 字符串	ENI 的 ID（network_interfaces.network_interface_id 的别名）。 返回值：始终返回 示例："eni-392fsdf"
interface_type 字符串	网络接口的类型。 返回值：始终返回 示例："interface"
ipv6_addresses 列表 / 元素=字符串	此接口的 IPv6 地址列表。 返回值：始终返回 示例：[]
mac_address 字符串	网络接口的 MAC 地址。 返回值：始终返回 示例："0a:f8:10:2f:ab:a1"
name 字符串 amazon.aws 1.3.0 中新增	ENI 的名称标签，通常在 AWS UI 中显示为名称。 返回值：已设置名称标签时返回
network_interface_id 字符串	ENI 的 ID。 返回值：始终返回 示例："eni-392fsdf"
owner_id 字符串	ENI 所有者的 AWS 账户 ID。 返回值：始终返回 示例："123456789012"
private_dns_name 字符串	ENI 的私有 DNS 名称。 返回值：始终返回 示例："ip-172-16-1-180.ec2.internal"
private_ip_address 字符串	ENI 的私有 IP 地址。 返回值：始终返回 示例："172.16.1.180"
private_ip_addresses 列表 / 元素=字符串	附加到 ENI 的私有 IP 地址列表。 返回值：始终返回 示例：[]
requester_id 字符串	启动 ENI 的实体的 ID。 返回值：成功时返回 示例："AIDA12345EXAMPLE54321"
requester_managed 布尔值	指示网络接口是否由 AWS 服务管理。 返回值：始终返回 示例：false
source_dest_check 布尔值	指示网络接口是否执行源/目标检查。 返回值：始终返回 示例：false
status 字符串	指示网络接口是否附加到实例。 返回值：始终返回 示例："in-use"
subnet_id 字符串	ENI 所在的子网 ID。 返回值：始终返回 示例："subnet-7bbf01234"
tag_set 字典	添加到 ENI 的标签字典。 返回值：始终返回 示例：{}
tags 字典 amazon.aws 1.3.0 中新增	添加到 ENI 的标签字典。 返回值：始终返回 示例：{}
vpc_id 字符串	ENI 所属 VPC 的 ID。 返回值：始终返回 示例："vpc-b3f1f123"

作者

• Rob White (@wimnat)

集合链接

• 问题追踪器
• 代码仓库
• 通讯