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。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在剧本中使用它，请指定：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

字符串

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

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

env_type

字符串

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

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

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

filters

列表 / 元素=字符串

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

列表中的每个附加筛选器都将作为 AND 条件添加 (filter1 和 filter2)。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的作用域数组

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。

  • 只有在未设置剧本值时，才会使用环境变量值。

  • 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

复杂

资源列表

返回：始终

autoCreateSubnetworks

布尔值

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

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

返回：成功

creationTimestamp

字符串

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

返回：成功

description

字符串

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

返回：成功

gateway_ipv4

字符串

网络默认路由的网关地址。此值由 GCP 选择。

返回：成功

id

整数

资源的唯一标识符。

返回：成功

mtu

整数

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

返回：成功

name

字符串

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

返回：成功

routingConfig

复杂

此网络的网络级路由配置。Cloud Router 使用它来确定要强制执行哪种类型的网络范围路由行为。

返回：成功

routingMode

字符串

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

返回：成功

subnetworks

列表 / 元素=字符串

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

返回：成功

作者

  • 谷歌公司 (@googlecloudplatform)