amazon.aws.ec2_vpc_route_table_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_route_table_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 之后的版本中删除。
过滤器 字典	要应用的过滤器字典。每个字典项由一个过滤器键和一个过滤器值组成。有关可能的过滤器，请参阅 https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRouteTables.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 选项是互斥的。 别名 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.

- name: Gather information about all VPC route tables
  amazon.aws.ec2_vpc_route_table_info:

- name: Gather information about a particular VPC route table using route table ID
  amazon.aws.ec2_vpc_route_table_info:
    filters:
      route-table-id: rtb-00112233

- name: Gather information about any VPC route table with a tag key Name and value Example
  amazon.aws.ec2_vpc_route_table_info:
    filters:
      "tag:Name": Example

- name: Gather information about any VPC route table within VPC with ID vpc-abcdef00
  amazon.aws.ec2_vpc_route_table_info:
    filters:
      vpc-id: vpc-abcdef00

返回值

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

键	描述
route_tables 复杂	描述路由表的字典列表。 另请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2.Client.describe_route_tables。 返回： 始终
associations 复杂	路由表与一个或多个子网或网关之间的关联列表。 返回： 始终
association_state 复杂	关联的状态。 返回： 始终
state 字符串	关联的状态。 返回： 始终 示例： "associated"
state_message 字符串	有关关联状态的附加信息。 返回： 当可用时 示例： "正在创建关联"
gateway_id 字符串	互联网网关或虚拟专用网关的 ID。 返回： 当路由表是网关路由表时 示例： "igw-03312309"
main 布尔值	这是否是主路由表。 返回： 始终 示例： false
route_table_association_id 字符串	路由表和子网之间关联的 ID。 返回： 始终 示例： "rtbassoc-ab47cfc3"
route_table_id 字符串	路由表的 ID。 返回： 始终 示例： "rtb-bf779ed7"
subnet_id 字符串	子网的 ID。 返回： 当路由表是子网路由表时 示例： "subnet-82055af9"
id 字符串	路由表的 ID（与 route_tables.route_table_id 相同，为了向后兼容）。 返回： 始终 示例： "rtb-bf779ed7"
owner_id 字符串	拥有该路由表的账户的 ID。 返回： 始终 示例： "012345678912"
propagating_vgws 列表 / 元素=字符串	传播路由的虚拟专用网关的列表。 返回： 始终 示例： []
route_table_id 字符串	路由表的 ID。 返回： 始终 示例： "rtb-bf779ed7"
routes 复杂	路由表中的路由列表。 返回： 始终
destination_cidr_block 字符串	目的地的 CIDR 块。 返回： 始终 示例： "10.228.228.0/22"
gateway_id 字符串	网关的 ID。 返回： 当网关是本地网关或互联网网关时 示例： "local"
instance_id 字符串	NAT 实例的 ID。 除非路由是通过 EC2 实例，否则为空。 返回： 始终 示例： "i-abcd123456789"
instance_owner_id 字符串	拥有 NAT 实例的 AWS 账户。 除非路由是通过 EC2 实例，否则为空。 返回： 始终 示例： "123456789012"
nat_gateway_id 字符串	NAT 网关的 ID。 返回： 当路由是通过 NAT 网关时。 示例： "local"
network_interface_id 字符串	网络接口的 ID。 除非路由是通过 EC2 实例，否则为空。 返回： 始终 示例： "123456789012"
origin 字符串	路由在表中存在的机制。 返回： 始终 示例： "CreateRouteTable"
state 字符串	路由的状态。 返回： 始终 示例： "active"
transit_gateway_id 字符串 在 amazon.aws 8.3.0 中添加	传输网关的 ID。 返回： 当路由是通过传输网关时。 示例： "tgw-123456789012"
tags 字典	应用于路由表的标签。 返回： 始终 示例： {"Name": "公共路由表", "Public": "true"}
vpc_id 字符串	路由所在的 VPC 的 ID。 返回： 始终 示例： "vpc-6e2d2407"

作者

• Rob White (@wimnat)

• Mark Chappell (@tremble)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 沟通