google.cloud.gcp_compute_subnetwork_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_subnetwork_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 请求的用户代理字符串。

filters

list / 元素=string

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

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

project

string

要使用的 Google Cloud Platform 项目。

region

string / 必填

此子网的 GCP 区域。

scopes

list / 元素=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 subnetwork
  gcp_compute_subnetwork_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复杂

资源列表

返回： 总是

creationTimestamp

string

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

返回： 成功

description

string

此资源的可选描述。创建资源时提供此属性。此字段只能在资源创建时设置。

返回： 成功

gatewayAddress

string

默认路由用于到达此子网之外的目标地址的网关地址。

返回： 成功

id

integer

资源的唯一标识符。

返回： 成功

ipCidrRange

string

此子网拥有的内部地址范围。

创建子网时请提供此属性。例如，10.0.0.0/8 或 192.168.0.0/16。范围在一个网络内必须是唯一的且不重叠。仅支持 IPv4。

返回： 成功

name

string

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

返回： 成功

network

字典

此子网所属的网络。

只有处于分布式模式的网络才能拥有子网。

返回： 成功

privateIpGoogleAccess

布尔值

启用后，此子网中没有外部 IP 地址的虚拟机可以使用私有 Google 访问来访问 Google API 和服务。

返回： 成功

privateIpv6GoogleAccess

string

此子网中虚拟机的私有 IPv6 Google 访问类型。

返回： 成功

region

string

此子网的 GCP 区域。

返回： 成功

secondaryIpRanges

复杂

此子网中包含的虚拟机实例的辅助 IP 范围的配置数组。此类虚拟机的主 IP 必须属于子网的主 ipCidrRange。别名 IP 可以属于主范围或辅助范围。

返回： 成功

ipCidrRange

string

属于此子网辅助范围的 IP 地址范围。创建子网时请提供此属性。

范围在一个网络内的所有主要和辅助 IP 范围内必须是唯一的且不重叠。仅支持 IPv4。

返回： 成功

rangeName

string

与此子网辅助范围关联的名称，在向虚拟机实例添加别名 IP 范围时使用。名称长度必须为 1-63 个字符，并符合 RFC1035。该名称在子网内必须是唯一的。

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)