google.cloud.gcp_compute_target_vpn_gateway_info 模块 – 收集 GCP TargetVpnGateway 的信息

注意

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

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

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

要在 Playbook 中使用它，请指定：google.cloud.gcp_compute_target_vpn_gateway_info。

注意

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

概要

  • 收集 GCP TargetVpnGateway 的信息

要求

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

  • 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=字符串

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

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

project

字符串

要使用的 Google Cloud Platform 项目。

region

字符串 / 必需

此网关应所在的区域。

scopes

列表 / elements=字符串

要使用的作用域数组

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 target vpn gateway
  gcp_compute_target_vpn_gateway_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复杂

资源列表

返回：始终

creationTimestamp

字符串

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

返回：成功

description

字符串

此资源的可选描述。

返回：成功

forwardingRules

列表 / elements=字符串

与此 VPN 网关关联的 ForwardingRule 资源的引用列表。

返回：成功

id

整数

资源的唯一标识符。

返回：成功

name

字符串

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

返回：成功

network

字典

此 VPN 网关正在接受流量的网络。

返回：成功

region

字符串

此网关应所在的区域。

返回：成功

tunnels

列表 / elements=字符串

与此 VPN 网关关联的 VpnTunnel 资源的引用列表。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)