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

字符串

如果凭据类型为 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 项目。

region

字符串 / 必需

此子网的 GCP 区域。

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。

  • 只有在未设置 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

字符串

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

返回：成功

description

字符串

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

返回：成功

gatewayAddress

字符串

用于默认路由以访问此子网外部的目标地址的网关地址。

返回：成功

id

整数

资源的唯一标识符。

返回：成功

ipCidrRange

字符串

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

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

返回：成功

name

字符串

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

返回：成功

network

字典

此子网所属的网络。

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

返回：成功

privateIpGoogleAccess

布尔值

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

返回：成功

privateIpv6GoogleAccess

字符串

此子网中虚拟机的专用 IPv6 Google 访问类型。

返回：成功

region

字符串

此子网的 GCP 区域。

返回：成功

secondaryIpRanges

复杂

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

返回：成功

ipCidrRange

字符串

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

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

返回：成功

rangeName

字符串

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

返回：成功

作者

  • 谷歌公司 (@googlecloudplatform)