google.cloud.gcp_compute_route 模块 – 创建 GCP 路由
注意
此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，有关详细信息，请参阅 需求。
要在 playbook 中使用它，请指定：google.cloud.gcp_compute_route。
注意
由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在 未解决的健全性测试失败。有关更多信息，请参阅 讨论主题。
概要
表示路由资源。
路由是一条规则，它指定虚拟网络应如何处理某些数据包。路由通过标签与虚拟机关联，特定虚拟机的路由集称为其路由表。对于离开虚拟机的每个数据包，系统会在该虚拟机的路由表中搜索单个最佳匹配路由。
路由按目标 IP 地址匹配数据包，优先选择较小或更具体的范围而不是较大的范围。如果出现平局，系统会选择优先级值最小的路由。如果仍然出现平局，它将使用三层和四层数据包报头来仅选择剩余匹配路由中的一个。然后，数据包将根据获胜路由的 next_hop 字段中指定的转发方式转发 – 要么转发到另一个虚拟机目标，要么转发到虚拟机网关或 Compute Engine 操作的网关。不匹配发送虚拟机的路由表中任何路由的数据包将被丢弃。
路由资源必须恰好有一个 nextHopGateway、nextHopInstance、nextHopIp、nextHopVpnTunnel 或 nextHopIlb 的规范。
需求
执行此模块的主机需要以下要求。
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
参数
参数 |
注释 |
|---|---|
如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。 |
|
使用的凭据类型。 选项
|
|
此资源的可选描述。创建资源时提供此属性。 |
|
此路由适用的出站数据包的目标范围。 仅支持 IPv4。 |
|
指定您在其中运行此模块的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的用户代理字符串。 |
|
资源的名称。创建资源时由客户端提供。名称必须为 1-63 个字符长，并符合 RFC1035。具体来说，名称必须为 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是连字符、小写字母或数字，最后一个字符不能是连字符。 |
|
此路由适用的网络。 此字段表示 GCP 中到网络资源的链接。它可以通过两种方式指定。首先，您可以放置一个键为“selfLink”且值为资源 selfLink 的字典。或者，您可以向 gcp_compute_network 任务添加 `register: name-of-resource`，然后将此 network 字段设置为“{{ name-of-resource }}” |
|
应处理匹配数据包的网关的 URL。 目前，您只能使用完整或部分有效 URL 指定 internet 网关：* https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway。 |
|
应处理匹配数据包的类型为 loadBalancingScheme=INTERNAL 的转发规则的 URL。 您只能将转发规则指定为部分或完整 URL。例如，以下所有 URL 均有效：https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule regions/region/forwardingRules/forwardingRule 请注意，只有当 destinationRange 是公共（非 RFC 1918）IP CIDR 范围时才能使用此项。 此字段表示 GCP 中到 ForwardingRule 资源的链接。它可以通过两种方式指定。首先，您可以放置一个键为“selfLink”且值为资源 selfLink 的字典。或者，您可以向 gcp_compute_forwarding_rule 任务添加 `register: name-of-resource`，然后将此 next_hop_ilb 字段设置为“{{ name-of-resource }}” |
|
应处理匹配数据包的实例的 URL。 您可以将其指定为完整或部分 URL。例如：* https://www.googleapis.com/compute/v1/projects/project/zones/zone/ instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance。 此字段表示 GCP 中 Instance 资源的链接。它可以通过两种方式指定。首先，您可以使用键为“selfLink”、值为您的资源 selfLink 的字典。或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_instance 任务中，然后将此 next_hop_instance 字段设置为 "{{ name-of-resource }}"。 |
|
应处理匹配数据包的实例的网络 IP 地址。 |
|
应处理匹配数据包的 VpnTunnel 的 URL。 此字段表示 GCP 中 VpnTunnel 资源的链接。它可以通过两种方式指定。首先，您可以使用键为“selfLink”、值为您的资源 selfLink 的字典。或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_vpn_tunnel 任务中，然后将此 next_hop_vpn_tunnel 字段设置为 "{{ name-of-resource }}"。 |
|
此路由的优先级。当存在多个具有相同前缀长度的匹配路由时，优先级用于打破平局。 对于两个具有相同前缀长度的路由，优先级数值较低的路由优先。 默认值为 1000。有效范围是 0 到 65535。 |
|
要使用的 Google Cloud Platform 项目。 |
|
要使用的作用域数组 |
|
服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。 |
|
如果选择了 machineaccount 且用户不希望使用默认电子邮件，则可以使用可选的服务帐户电子邮件地址。 |
|
如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。 |
|
指定的对象是否应该存在于 GCP 中 选项
|
|
此路由适用的实例标签列表。 |
注释
注意
API 参考：https://cloud.google.com/compute/docs/reference/rest/v1/routes
对于身份验证，您可以使用
GCP_SERVICE_ACCOUNT_FILE环境变量设置 service_account_file。对于身份验证，您可以使用
GCP_SERVICE_ACCOUNT_CONTENTS环境变量设置 service_account_contents。对于身份验证，您可以使用
GCP_SERVICE_ACCOUNT_EMAIL环境变量设置 service_account_email。对于身份验证，您可以使用
GCP_ACCESS_TOKEN环境变量设置 access_token。对于身份验证，您可以使用
GCP_AUTH_KIND环境变量设置 auth_kind。对于身份验证，您可以使用
GCP_SCOPES环境变量设置 scopes。只有在未设置 playbook 值时才会使用环境变量值。
service_account_email 和 service_account_file 选项是互斥的。
示例
- name: create a network
google.cloud.gcp_compute_network:
name: network-route
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: network
- name: create a route
google.cloud.gcp_compute_route:
name: test_object
dest_range: 192.168.6.0/24
next_hop_gateway: global/gateways/default-internet-gateway
network: "{{ network }}"
tags:
- backends
- databases
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
返回值
常见的返回值已在此处记录 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
此资源的可选描述。创建资源时提供此属性。 返回：success |
|
此路由适用的出站数据包的目标范围。 仅支持 IPv4。 返回：success |
|
资源的名称。创建资源时由客户端提供。名称必须为 1-63 个字符长，并符合 RFC1035。具体来说，名称必须为 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是连字符、小写字母或数字，最后一个字符不能是连字符。 返回：success |
|
此路由适用的网络。 返回：success |
|
应处理匹配数据包的网关的 URL。 目前，您只能使用完整或部分有效 URL 指定 internet 网关：* https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway。 返回：success |
|
应处理匹配数据包的类型为 loadBalancingScheme=INTERNAL 的转发规则的 URL。 您只能将转发规则指定为部分或完整 URL。例如，以下所有 URL 均有效：https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule regions/region/forwardingRules/forwardingRule 请注意，只有当 destinationRange 是公共（非 RFC 1918）IP CIDR 范围时才能使用此项。 返回：success |
|
应处理匹配数据包的实例的 URL。 您可以将其指定为完整或部分 URL。例如：* https://www.googleapis.com/compute/v1/projects/project/zones/zone/ instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance。 返回：success |
|
应处理匹配数据包的实例的网络 IP 地址。 返回：success |
|
应处理匹配数据包的网络的 URL。 返回：success |
|
应处理匹配数据包的 VpnTunnel 的 URL。 返回：success |
|
此路由的优先级。当存在多个具有相同前缀长度的匹配路由时，优先级用于打破平局。 对于两个具有相同前缀长度的路由，优先级数值较低的路由优先。 默认值为 1000。有效范围是 0 到 65535。 返回：success |
|
此路由适用的实例标签列表。 返回：success |