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

string

如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

bgp

字典

特定于此路由器的 BGP 信息。

advertise_mode

string

用户指定的标志，指示要使用的通告模式。

一些有效的选择包括：“DEFAULT”、“CUSTOM”

默认值： "DEFAULT"

advertised_groups

列表 / 元素=字符串

用户指定的要在自定义模式中通告的前缀组列表。

仅当 advertiseMode 为 CUSTOM 时才能填充此字段，并且该字段会通告给路由器的所有对等方。除了任何指定的前缀之外，还会通告这些组。将此字段留空以不通告任何自定义组。

此枚举字段有一个有效值：ALL_SUBNETS 。

advertised_ip_ranges

列表 / 元素=字典

用户指定的要在自定义模式中通告的各个 IP 范围的列表。仅当 advertiseMode 为 CUSTOM 时才能填充此字段，并且该字段会通告给路由器的所有对等方。除了任何指定的组之外，还会通告这些 IP 范围。

将此字段留空以不通告任何自定义 IP 范围。

description

string

用户指定的 IP 范围的描述。

range

字符串 / 必需

要通告的 IP 范围。该值必须是 CIDR 格式的字符串。

asn

整数 / 必需

本地 BGP 自治系统编号 (ASN)。必须是 RFC6996 私有 ASN，可以是 16 位或 32 位。该值将为此路由器资源固定。链接到此路由器的所有 VPN 隧道都将具有相同的本地 ASN。

description

string

此资源的可选描述。

env_type

string

指定您在此模块中运行的 Ansible 环境。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 API 请求的用户代理字符串。

name

字符串 / 必需

资源的名称。名称的长度必须为 1-63 个字符，并且符合 RFC1035。具体来说，名称的长度必须为 1-63 个字符，并且匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，并且所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。

network

字典 / 必需

此路由器所属网络的引用。

此字段表示指向 GCP 中网络资源的链接。可以通过两种方式指定。首先，您可以放置一个键为“selfLink”，值为您的资源 selfLink 的字典。或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_network 任务，然后将此网络字段设置为“{{ name-of-resource }}”

project

string

要使用的 Google Cloud Platform 项目。

region

字符串 / 必需

路由器所在的区域。

scopes

列表 / 元素=字符串

要使用的作用域数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，可以是字典形式，也可以是表示它的 JSON 字符串形式。

service_account_email

string

如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则可以选择服务帐户电子邮件地址。

service_account_file

路径

如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

state

string

给定对象是否应存在于 GCP 中

选项

  • "present" ←（默认）

  • "absent"

备注

注意

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

  • Google Cloud Router: 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 信息。

返回： 成功

advertisedGroups

列表 / 元素=字符串

用户指定的要在自定义模式中通告的前缀组列表。

仅当 advertiseMode 为 CUSTOM 时才能填充此字段，并且该字段会通告给路由器的所有对等方。除了任何指定的前缀之外，还会通告这些组。将此字段留空以不通告任何自定义组。

此枚举字段有一个有效值：ALL_SUBNETS 。

返回： 成功

advertisedIpRanges

复杂

用户指定的要在自定义模式中通告的各个 IP 范围的列表。仅当 advertiseMode 为 CUSTOM 时才能填充此字段，并且该字段会通告给路由器的所有对等方。除了任何指定的组之外，还会通告这些 IP 范围。

将此字段留空以不通告任何自定义 IP 范围。

返回： 成功

description

string

用户指定的 IP 范围的描述。

返回： 成功

range

string

要通告的 IP 范围。该值必须是 CIDR 格式的字符串。

返回： 成功

advertiseMode

string

用户指定的标志，指示要使用的通告模式。

返回： 成功

asn

整数

本地 BGP 自治系统编号 (ASN)。必须是 RFC6996 私有 ASN，可以是 16 位或 32 位。该值将为此路由器资源固定。链接到此路由器的所有 VPN 隧道都将具有相同的本地 ASN。

返回： 成功

creationTimestamp

string

RFC3339 文本格式的创建时间戳。

返回： 成功

description

string

此资源的可选描述。

返回： 成功

id

整数

资源的唯一标识符。

返回： 成功

name

string

资源的名称。名称的长度必须为 1-63 个字符，并且符合 RFC1035。具体来说，名称的长度必须为 1-63 个字符，并且匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，并且所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。

返回： 成功

network

字典

此路由器所属网络的引用。

返回： 成功

region

string

路由器所在的区域。

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)