google.cloud.gcp_compute_network_info 模块 – 收集 GCP 网络信息

注意

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

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

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

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

注意

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

概要

  • 收集 GCP 网络信息

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

说明

access_token

string

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

auth_kind

string / 必需

使用的凭证类型。

选择

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

env_type

string

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

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

这只会更改任何 API 请求的 User Agent 字符串。

filters

list / elements=string

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

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

project

string

要使用的 Google Cloud Platform 项目。

scopes

list / elements=string

要使用的作用域数组

service_account_contents

jsonarg

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

service_account_email

string

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

service_account_file

path

如果选择了 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 network
  gcp_compute_network_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

complex

资源列表

返回： 始终

autoCreateSubnetworks

boolean

当设置为“true”时，网络将在“自动子网模式”下创建，并且它将在 `10.128.0.0/9` 地址范围内为每个区域自动创建一个子网。

当设置为“false”时，网络将在“自定义子网模式”下创建，以便用户可以显式连接子网络资源。

返回： 成功

creationTimestamp

string

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

返回： 成功

description

string

此资源的可选描述。必须重新创建资源才能修改此字段。

返回： 成功

gateway_ipv4

string

用于从网络默认路由输出的网关地址。此值由 GCP 选择。

返回： 成功

id

integer

资源的唯一标识符。

返回： 成功

mtu

integer

最大传输单元（以字节为单位）。此字段的最小值为 1460，最大值为 1500 字节。

返回： 成功

name

string

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

返回： 成功

routingConfig

complex

此网络的网络级路由配置。由 Cloud Router 使用，以确定要强制执行哪种类型的全网络路由行为。

返回： 成功

routingMode

string

要使用的全网络路由模式。如果设置为 `REGIONAL`，则此网络的云路由器将仅通告与路由器位于同一区域的此网络的子网络的路由。如果设置为 `GLOBAL`，则此网络的云路由器将通告此网络的所有子网络的路由，跨区域。

返回： 成功

subnetworks

list / elements=string

此网络中所有子网络的服务器定义的完全限定 URL。

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)