google.cloud.gcp_compute_external_vpn_gateway 模块 – 创建 GCP ExternalVpnGateway

注意

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

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

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。

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

注意

由于违反 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合有 未解决的健全性测试失败。有关详细信息，请参阅 讨论主题。

概要

  • 表示在 GCP 外部管理的 VPN 网关。

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

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

auth_kind

字符串 / 必需

使用的凭据类型。

选择

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

description

字符串

此资源的可选描述。

env_type

字符串

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

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

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

interfaces

列表 / elements=dictionary

此外部 VPN 网关上的接口列表。

id

整数

此接口的数字 ID。允许的值基于此外部 VPN 网关的冗余类型 * `0 - SINGLE_IP_INTERNALLY_REDUNDANT` * `0, 1 - TWO_IPS_REDUNDANCY` * `0, 1, 2, 3 - FOUR_IPS_REDUNDANCY` 。

ip_address

字符串

外部 VPN 网关中接口的 IP 地址。

仅支持 IPv4。此 IP 地址可以来自您的本地网关或其他云提供商的 VPN 网关，它不能是来自 Google Compute Engine 的 IP 地址。

name

字符串 / 必需

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

project

字符串

要使用的 Google Cloud Platform 项目。

redundancy_type

字符串

指示此外部 VPN 网关的冗余类型。

一些有效的选择包括：“FOUR_IPS_REDUNDANCY”、“SINGLE_IP_INTERNALLY_REDUNDANT”、“TWO_IPS_REDUNDANCY”

scopes

列表 / elements=string

要使用的作用域数组

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/beta/externalVpnGateways

  • 对于身份验证，您可以使用 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 external vpn gateway
  google.cloud.gcp_compute_external_vpn_gateway:
    name: test_object
    redundancy_type: SINGLE_IP_INTERNALLY_REDUNDANT
    descrpition: An externalyl managed VPN gateway
    interfaces:
    - id: 0
      ip_address: 8.8.8.8
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

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

键

描述

description

字符串

此资源的可选描述。

返回：成功

interfaces

复杂

此外部 VPN 网关上的接口列表。

返回：成功

id

整数

此接口的数字 ID。允许的值基于此外部 VPN 网关的冗余类型 * `0 - SINGLE_IP_INTERNALLY_REDUNDANT` * `0, 1 - TWO_IPS_REDUNDANCY` * `0, 1, 2, 3 - FOUR_IPS_REDUNDANCY` 。

返回：成功

ipAddress

字符串

外部 VPN 网关中接口的 IP 地址。

仅支持 IPv4。此 IP 地址可以来自您的本地网关或其他云提供商的 VPN 网关，它不能是来自 Google Compute Engine 的 IP 地址。

返回：成功

name

字符串

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

返回：成功

redundancyType

字符串

指示此外部 VPN 网关的冗余类型。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)