amazon.aws.ec2_vpc_route_table 模块 – 管理 AWS 虚拟私有云的路由表

注意

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

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

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，请参阅 要求 以了解详情。

要在剧本中使用它，请指定：amazon.aws.ec2_vpc_route_table。

amazon.aws 1.0.0 中的新增功能

概要

• 管理 AWS 虚拟私有云 (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 回调来输出在剧本期间进行的总列表。 还可以使用 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 之后的一个版本中删除。
gateway_id 字符串 amazon.aws 3.2.0 中新增	要与路由表关联的网关的 ID。 如果 gateway_id 为 'None' 或 ''，则网关将与路由表断开关联。
lookup 字符串	通过 tags 或 route_table_id 来查找路由表。 如果 lookup=tag 并且未指定 tags，则不会执行现有路由表的查找，并且将创建一个新的路由表。 使用 lookup=tag 时，如果找到多个匹配项，则会导致失败，并且不会进行任何更改。 要更改路由表的标签，请使用 lookup=id。 当lookup=tag时，必须指定vpc_id。 选择 "tag" ← (默认) "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选项互斥。
propagating_vgw_ids 列表 / 元素=字符串	启用来自由 ID 指定的虚拟网关的路由传播。
purge_routes 布尔值	清除路由中未找到的现有路由。 选择 false true ← (默认)
purge_subnets 布尔值	清除子网中未找到的现有子网。 除非提供子网选项，否则将被忽略。 选择 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 之后的发行版中删除。
route_table_id 字符串	要更新或删除的路由表的 ID。 当lookup=id时为必需。
routes 列表 / 元素=字典	路由表中的路由列表。 路由指定为包含键dest和gateway_id、instance_id、network_interface_id、transit_gateway_id或vpc_peering_connection_id之一的字典。 dest的值用于目标匹配。它可以是 IPv4 CIDR 块或 IPv6 CIDR 块。 如果指定了gateway_id，则可以使用值igw引用 VPC 的 IGW。 当前状态需要路由。 默认值： []
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 之后的发行版中删除。
state 字符串	创建或销毁 VPC 路由表。 选择 "present" ← (默认) "absent"
subnets 列表 / 元素=字符串	要添加到此路由表的子网数组。子网可以通过子网 ID、名称标签或 CIDR（例如“10.0.0.0/24”或“fd00::/8”）指定。
tags 别名: resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置tags参数，则不会修改标签。
validate_certs 布尔值	设置为false时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置validate_certs=false，作为替代方案，请考虑改用aws_ca_bundle。 选择 false true ← (默认)
vpc_id 字符串	要在其中创建路由表的 VPC 的 VPC ID。 当state=present或lookup=tag时为必需。

注释

注意

• 当未提供route_table_id时，标签用于唯一标识 VPC 中的路由表。

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

# Basic creation example:
- name: Set up public subnet route table
  amazon.aws.ec2_vpc_route_table:
    vpc_id: vpc-1245678
    region: us-west-1
    tags:
      Name: Public
    subnets:
      - "{{ jumpbox_subnet.subnet.id }}"
      - "{{ frontend_subnet.subnet.id }}"
      - "{{ vpn_subnet.subnet_id }}"
    routes:
      - dest: 0.0.0.0/0
        gateway_id: "{{ igw.gateway_id }}"
      - dest: ::/0
        gateway_id: "{{ igw.gateway_id }}"
      - dest: 0.0.0.0/0
        gateway_id: "{{ transit_gateway_id }}"
  register: public_route_table

- name: Create VPC gateway
  amazon.aws.ec2_vpc_igw:
    vpc_id: vpc-1245678
  register: vpc_igw

- name: Create gateway route table
  amazon.aws.ec2_vpc_route_table:
    vpc_id: vpc-1245678
    tags:
      Name: Gateway route table
    gateway_id: "{{ vpc_igw.gateway_id }}"
  register: gateway_route_table

- name: Disassociate gateway from route table
  amazon.aws.ec2_vpc_route_table:
    vpc_id: vpc-1245678
    tags:
      Name: Gateway route table
    gateway_id: None
  register: gateway_route_table

- name: Set up NAT-protected route table
  amazon.aws.ec2_vpc_route_table:
    vpc_id: vpc-1245678
    region: us-west-1
    tags:
      Name: Internal
    subnets:
      - "{{ application_subnet.subnet.id }}"
      - 'Database Subnet'
      - '10.0.0.0/8'
    routes:
      - dest: 0.0.0.0/0
        instance_id: "{{ nat.instance_id }}"
  register: nat_route_table

- name: delete route table
  amazon.aws.ec2_vpc_route_table:
    vpc_id: vpc-1245678
    region: us-west-1
    route_table_id: "{{ route_table.id }}"
    lookup: id
    state: absent

返回值

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

键	描述
route_table 复杂	路由表结果。 已返回：始终
associations 复杂	路由表与一个或多个子网或网关之间关联的列表。 已返回：始终
association_state 复杂	关联的状态。 已返回：始终
state 字符串	关联的状态。 已返回：始终 示例： "associated"
state_message 字符串	关于关联状态的附加信息。 返回： 可用时 示例： "Creating" association"
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_table.route_table_id 相同，为了向后兼容）。 已返回：始终 示例： "rtb-bf779ed7"
owner_id 字符串	拥有资源的 AWS 账户。 返回： 成功时 示例： "123456789012"
propagating_vgws 列表 / 元素=字符串	传播路由的虚拟私有网关列表。 已返回：始终 示例： []
route_table_id 字符串	路由表的 ID。 已返回：始终 示例： "rtb-bf779ed7"
routes 复杂	路由表中的路由列表。 已返回：始终
carrier_gateway_id 字符串 amazon.aws 6.0.0 版本中添加	运营商网关的 ID。 返回： 路由通过运营商网关时 示例： "local"
destination_cidr_block 字符串	目的地的 IPv4 CIDR 块 已返回：始终 示例： "10.228.228.0/22"
destination_ipv6_cidr_block 字符串	目的地的 IPv6 CIDR 块 返回： 路由包含 IPv6 目的地时 示例： "2600:1f1c:1b3:8f00:8000::/65"
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"
origin 字符串	路由在表中的机制。 已返回：始终 示例： "CreateRouteTable"
state 字符串	路由的状态。 已返回：始终 示例： "active"
transit_gateway_id 字符串 amazon.aws 8.3.0 版本中添加	Transit 网关的 ID。 返回： 路由通过 Transit 网关时 示例： "tgw-123456789012"
tags 字典	应用于路由表的标签。 已返回：始终 示例： {"Name": "Public" route table", "Public": "true"}
vpc_id 字符串	路由所在的 VPC 的 ID。 已返回：始终 示例： "vpc-6e2d2407"

作者

• Robert Estelle (@erydo)

• Rob White (@wimnat)

• Will Thames (@willthames)

集合链接

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