amazon.aws.ec2_vpc_net_info 模块 – 收集 AWS 中 EC2 VPC 的信息

注意

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

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

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

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

amazon.aws 1.0.0 中的新功能

概要

  • 收集 AWS 中 EC2 VPC 的信息。

要求

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

  • 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_access_key_id 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。

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

字符串

要连接的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。

也可以按优先级递减的顺序使用 AWS_URL 或 EC2_URL 环境变量。

ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的版本中删除。

对 EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。

过滤器

字典

要应用的过滤器字典。每个字典项都包含一个过滤器键和一个过滤器值。有关可能的过滤器，请参阅https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html。

默认值： {}

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 保持一致，aws_secret_access_key 别名已在 5.1.0 版本中添加。

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 ← (默认)

vpc_ids

列表 / 元素=字符串

您账户中存在的 VPC ID 列表。

默认值: []

备注

注意

  • 注意： 对于模块，环境变量和配置文件是从 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 VPCs
- amazon.aws.ec2_vpc_net_info:

# Gather information about a particular VPC using VPC ID
- amazon.aws.ec2_vpc_net_info:
    vpc_ids: vpc-00112233

# Gather information about any VPC with a tag key Name and value Example
- amazon.aws.ec2_vpc_net_info:
    filters:
      "tag:Name": Example

返回值

通用返回值记录在这里，以下是此模块特有的字段

键

描述

vpcs

复杂

返回如下所述的复杂对象数组。

返回: 成功

cidr_block

字符串

分配给 VPC 的 IPv4 CIDR 块。

返回: 总是

cidr_block_association_set

复杂

IPv4 cidr 块关联集信息的数组。

返回: 总是

association_id

字符串

关联 ID。

返回: 总是

cidr_block

字符串

与 VPC 关联的 IPv4 CIDR 块。

返回: 总是

cidr_block_state

字典

包含单个项的哈希/字典。cidr 块关联的状态。

返回: 总是

state

字符串

CIDR 块关联状态。

返回: 总是

dhcp_options_id

字符串

与此 VPC 关联的 DHCP 选项的 ID。

返回: 总是

示例: "dopt-12345678"

enable_dns_hostnames

布尔值

根据 DNS 主机名支持的属性设置，为 True/False。

返回: 总是

enable_dns_support

布尔值

根据 DNS 支持的属性设置，为 True/False。

返回: 总是

id

字符串

VPC 的 ID（用于向后兼容）。

返回: 总是

instance_tenancy

字符串

VPC 的实例租户设置。

返回: 总是

ipv6_cidr_block_association_set

复杂

IPv6 cidr 块关联集信息的数组。

返回: 总是

association_id

字符串

关联 ID。

返回: 总是

ipv6_cidr_block

字符串

与 VPC 关联的 IPv6 CIDR 块。

返回: 总是

ipv6_cidr_block_state

字典

包含单个项的哈希/字典。cidr 块关联的状态。

返回: 总是

state

字符串

CIDR 块关联状态。

返回: 总是

is_default

布尔值

如果这是账户的默认 VPC，则为 True。

返回: 总是

owner_id

字符串

拥有 VPC 的 AWS 账户。

返回: 总是

示例: "123456789012"

state

字符串

VPC 的状态。

返回: 总是

tags

字典

与 VPC 关联的标签字典。

返回: 总是

vpc_id

字符串

VPC 的 ID。

返回: 总是

作者

  • Rob White (@wimnat)