google.cloud.gcp_compute_vpn_tunnel_info 模块 – 收集 GCP VpnTunnel 的信息

注意

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

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

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

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

注意

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

概要

  • 收集 GCP VpnTunnel 的信息

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

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

auth_kind

字符串 / 必需

使用的凭据类型。

选择

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

env_type

字符串

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

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

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

filters

列表 / elements=string

过滤器值对的列表。可用的过滤器在此处列出 https://cloud.google.com/sdk/gcloud/reference/topic/filters。

列表中的每个附加过滤器都将添加为 AND 条件（过滤器 1 和过滤器 2）。

project

字符串

要使用的 Google Cloud Platform 项目。

region

字符串 / 必需

隧道所在的区域。

scopes

列表 / elements=string

要使用的范围数组

service_account_contents

jsonarg

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

service_account_email

字符串

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

service_account_file

路径

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

备注

注意

  • 对于身份验证，您可以使用 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: get info on a vpn tunnel
  gcp_compute_vpn_tunnel_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

通用返回值在 此处 中记录，以下是此模块特有的字段

键

描述

resources

复杂

资源列表

已返回：总是

creationTimestamp

字符串

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

已返回：成功

description

字符串

此资源的可选描述。

已返回：成功

id

字符串

资源的唯一标识符。此标识符由服务器定义。

已返回：成功

ikeVersion

整数

与对等 VPN 网关建立 VPN 隧道时要使用的 IKE 协议版本。

可接受的 IKE 版本为 1 或 2。默认版本为 2。

已返回：成功

localTrafficSelector

列表 / elements=string

与对等 VPN 网关建立 VPN 隧道时要使用的本地流量选择器。该值应为 CIDR 格式的字符串，例如 `192.168.0.0/16`。范围应不相交。

仅支持 IPv4。

已返回：成功

name

字符串

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

已返回：成功

peerExternalGateway

字典

此 VPN 隧道连接到的对等方外部 VPN 网关的 URL。

已返回：成功

peerExternalGatewayInterface

整数

此 VPN 隧道连接到的外部 VPN 网关的接口 ID。

已返回：成功

peerGcpGateway

字典

此 VPN 隧道连接的对等端 HA GCP VPN 网关的 URL。

如果提供此项，则 VPN 隧道将自动使用对等 GCP VPN 网关中的相同 vpn_gateway_interface ID。

已返回：成功

peerIp

字符串

对等 VPN 网关的 IP 地址。仅支持 IPv4。

已返回：成功

region

字符串

隧道所在的区域。

已返回：成功

remoteTrafficSelector

列表 / elements=string

与对等 VPN 网关建立 VPN 隧道时使用的远程流量选择器。该值应为 CIDR 格式的字符串，例如 `192.168.0.0/16`。范围应不相交。

仅支持 IPv4。

已返回：成功

router

字典

用于动态路由的路由器资源的 URL。

已返回：成功

sharedSecret

字符串

用于在 Cloud VPN 网关和对等 VPN 网关之间建立安全会话的共享密钥。

已返回：成功

sharedSecretHash

字符串

共享密钥的哈希值。

已返回：成功

targetVpnGateway

字典

此 VPN 隧道关联的目标 VPN 网关的 URL。

已返回：成功

vpnGateway

字典

此 VPN 隧道关联的 VPN 网关的 URL。

如果创建了高可用性 VPN 网关资源，则必须使用此项。

已返回：成功

vpnGatewayInterface

整数

此 VPN 隧道关联的 VPN 网关的接口 ID。

已返回：成功

作者

  • Google Inc. (@googlecloudplatform)