google.cloud.gcp_compute_router 模块 – 创建 GCP 路由器

注意

此模块是 google.cloud 集合（版本 1.4.1）的一部分。

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

要安装它，请使用： ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定： google.cloud.gcp_compute_router。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在 未解决的健全性测试失败。请参阅 讨论主题 以了解更多信息。

摘要

• 表示路由器资源。

要求

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

• python >= 2.6

• requests >= 2.18.4

• google-auth >= 1.3.0

参数

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。 选项 "application" "machineaccount" "serviceaccount" "accesstoken"
bgp 字典	此路由器的特定 BGP 信息。
advertise_mode 字符串	用户指定的标志，指示要使用哪种广告模式。 一些有效的选项包括：“DEFAULT”、“CUSTOM” 默认值： "DEFAULT"
advertised_groups 列表 / 元素=字符串	用户指定的在自定义模式下要通告的前缀组列表。 如果 advertiseMode 为 CUSTOM，并且通告给路由器的所有对等体，则只能填充此字段。除了任何指定的前缀之外，还会通告这些组。留空此字段表示不通告任何自定义组。 此枚举字段只有一个有效值：ALL_SUBNETS。
advertised_ip_ranges 列表 / 元素=字典	用户指定的在自定义模式下要通告的单个 IP 范围列表。如果 advertiseMode 为 CUSTOM，并且通告给路由器的所有对等体，则只能填充此字段。除了任何指定的组之外，还会通告这些 IP 范围。 留空此字段表示不通告任何自定义 IP 范围。
description 字符串	IP 范围的用户指定描述。
range 字符串 / 必需	要通告的 IP 范围。该值必须是 CIDR 格式的字符串。
asn 整数 / 必需	本地 BGP 自治系统编号 (ASN)。必须是 RFC6996 私有 ASN，16 位或 32 位。此路由器资源的值将固定不变。连接到此路由器的所有 VPN 隧道将具有相同的本地 ASN。
description 字符串	此资源的可选描述。
env_type 字符串	指定您在哪个 Ansible 环境中运行此模块。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的用户代理字符串。
name 字符串 / 必需	资源的名称。名称必须是 1-63 个字符长，并符合 RFC1035。具体来说，名称必须是 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，最后一个字符不能是破折号。
network 字典 / 必需	对属于此路由器的网络的引用。 此字段表示指向 GCP 中网络资源的链接。它可以通过两种方式指定。首先，您可以放置一个键为“selfLink”且值为资源 selfLink 的字典。或者，您可以向 gcp_compute_network 任务添加 `register: name-of-resource`，然后将此 network 字段设置为“{{ name-of-resource }}”
project 字符串	要使用的 Google Cloud Platform 项目。
region 字符串 / 必需	路由器所在的区域。
scopes 列表 / 元素=字符串	要使用的作用域数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择 machineaccount 并且用户不想使用默认电子邮件，则可以选择的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
state 字符串	给定对象是否应该存在于 GCP 中 选项 "present" ← (默认) "absent"

备注

注意

• API 参考： https://cloud.google.com/compute/docs/reference/rest/v1/routers

• Google Cloud 路由器： https://cloud.google.com/router/docs/

• 对于身份验证，您可以使用 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-router
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: network

- name: create a router
  google.cloud.gcp_compute_router:
    name: test_object
    network: "{{ network }}"
    bgp:
      asn: 64514
      advertise_mode: CUSTOM
      advertised_groups:
      - ALL_SUBNETS
      advertised_ip_ranges:
      - range: 1.2.3.4
      - range: 6.7.0.0/16
    region: us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

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

键	描述
bgp 复杂类型	此路由器的特定 BGP 信息。 返回： success
advertisedGroups 列表 / 元素=字符串	用户指定的在自定义模式下要通告的前缀组列表。 如果 advertiseMode 为 CUSTOM，并且通告给路由器的所有对等体，则只能填充此字段。除了任何指定的前缀之外，还会通告这些组。留空此字段表示不通告任何自定义组。 此枚举字段只有一个有效值：ALL_SUBNETS。 返回： success
advertisedIpRanges 复杂类型	用户指定的在自定义模式下要通告的单个 IP 范围列表。如果 advertiseMode 为 CUSTOM，并且通告给路由器的所有对等体，则只能填充此字段。除了任何指定的组之外，还会通告这些 IP 范围。 留空此字段表示不通告任何自定义 IP 范围。 返回： success
description 字符串	IP 范围的用户指定描述。 返回： success
range 字符串	要通告的 IP 范围。该值必须是 CIDR 格式的字符串。 返回： success
advertiseMode 字符串	用户指定的标志，指示要使用哪种广告模式。 返回： success
asn 整数	本地 BGP 自治系统编号 (ASN)。必须是 RFC6996 私有 ASN，16 位或 32 位。此路由器资源的值将固定不变。连接到此路由器的所有 VPN 隧道将具有相同的本地 ASN。 返回： success
creationTimestamp 字符串	RFC3339 格式的创建时间戳。 返回： success
description 字符串	此资源的可选描述。 返回： success
id 整数	资源的唯一标识符。 返回： success
name 字符串	资源的名称。名称必须是 1-63 个字符长，并符合 RFC1035。具体来说，名称必须是 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，最后一个字符不能是破折号。 返回： success
network 字典	对属于此路由器的网络的引用。 返回： success
region 字符串	路由器所在的区域。 返回： success

作者

• Google Inc. (@googlecloudplatform)

资源链接

• 问题跟踪器
• 主页
• 代码库（源代码）