amazon.aws.ec2_vpc_subnet_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_subnet_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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 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 之后的一个版本中移除。
filters 字典	要应用的过滤器字典。每个字典项包含一个过滤器键和一个过滤器值。有关可能的过滤器，请参阅 https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSubnets.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保持一致，在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选项互斥。 在3.2.0版本中添加了aws_session_token和session_token别名，在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之后的发行版本中移除。
subnet_ids 别名：subnet_id 列表 / 元素=字符串	要收集信息的子网 ID 列表。 默认值：[]
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 VPC subnets
- amazon.aws.ec2_vpc_subnet_info:

# Gather information about a particular VPC subnet using ID
- amazon.aws.ec2_vpc_subnet_info:
    subnet_ids: subnet-00112233

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

# Gather information about any VPC subnet within VPC with ID vpc-abcdef00
- amazon.aws.ec2_vpc_subnet_info:
    filters:
      vpc-id: vpc-abcdef00

# Gather information about a set of VPC subnets, publicA, publicB and publicC within a
# VPC with ID vpc-abcdef00 and then use the jinja map function to return the
# subnet_ids as a list.

- amazon.aws.ec2_vpc_subnet_info:
    filters:
      vpc-id: vpc-abcdef00
      "tag:Name": "{{ item }}"
  loop:
    - publicA
    - publicB
    - publicC
  register: subnet_info

- set_fact:
    subnet_ids: "{{ subnet_info.results | sum(attribute='subnets', start=[]) | map(attribute='subnet_id') }}"

返回值

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

键	描述
subnets 复杂类型	返回如下所述的复杂对象数组。 返回值：成功
assign_ipv6_address_on_creation 布尔值	是否为新实例自动分配IPv6地址。 返回值：始终 示例：false
availability_zone 字符串	子网的可用区。 返回值：始终 示例："us-east-1a"
availability_zone_id 字符串	子网的 AZ ID。 返回值：始终 示例："use1-az6"
available_ip_address_count 字符串	可用 IPv4 地址的数量。 返回值：始终 示例："251"
cidr_block 字符串	子网的 IPv4 CIDR。 返回值：始终 示例："10.0.0.0/16"
default_for_az 布尔值	指示这是否是此可用区的默认子网。 返回值：始终 示例：false
enable_dns64 布尔值	指示是否应为仅 IPv4 的目标返回合成的 IPv6 地址。 返回值：成功 示例：false
id 字符串	子网资源 ID。 返回值：始终 示例："subnet-b883b2c4"
ipv6_association_id 字符串	当前关联的 CIDR 的 IPv6 关联 ID。 返回值：始终 示例："subnet-cidr-assoc-b85c74d2"
ipv6_cidr_block 字符串	与子网主动关联的 IPv6 CIDR 块。 返回值：始终 示例："2001:db8:0:102::/64"
ipv6_cidr_block_association_set 复杂类型	IPv6 cidr 块关联集信息的数组。 返回值：始终
association_id 字符串	关联 ID。 返回值：始终
ipv6_cidr_block 字符串	与子网关联的 IPv6 CIDR 块。 返回值：始终
ipv6_cidr_block_state 字典	包含单个项目的哈希/字典。cidr 块关联的状态。 返回值：始终
state 字符串	CIDR 块关联状态。 返回值：始终
ipv6_native 布尔值	指示这是否是仅 IPv6 子网。 返回值：成功 示例：false
map_customer_owned_ip_on_launch 布尔值	指示网络接口是否接收客户拥有的 IPv4 地址。 返回值：成功 示例："flase"
map_public_ip_on_launch 布尔值	是否为新实例自动分配公网 IP。 返回值：始终 示例：false
owner_id 字符串	拥有子网的 Amazon Web Services 账户的 ID。 返回值：成功 示例："12344567"
private_dns_name_options_on_launch 字典	启动时分配给子网中实例的主机名类型。 实例主机名基于实例的 IPv4 地址或 ID。 返回值：成功 示例：{"enable_resource_name_dns_a_record": false, "enable_resource_name_dns_aaaa_record": false, "hostname_type": "ip-name"}
state 字符串	子网的状态。 返回值：始终 示例："available"
subnet_arn 字符串	子网的 Amazon 资源名称 (ARN)。 返回值：成功 示例："arn:aws:ec2:us-east-1:xxx:subnet/subnet-xxx"
subnet_id 字符串	子网的 ID。 返回值：始终
tags 字典	附加到子网的标签，包括名称。 返回值：始终 示例：{"Name": "My Subnet", "env": "staging"}
vpc_id 字符串	此子网所在的 VPC 的 ID。 返回值：始终 示例："vpc-67236184"

作者

• Rob White (@wimnat)

资源链接

• 问题追踪
• 代码仓库
• 通信