google.cloud.gcp_compute_global_address_info 模块 – 收集 GCP GlobalAddress 信息

注意

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

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

要安装它，请使用： ansible-galaxy collection install google.cloud。要使用此模块，您需要其他要求，有关详细信息，请参阅 需求。

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

注意

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

概要

  • 收集 GCP GlobalAddress 信息

需求

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

  • 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。

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

  • service_account_email 和 service_account_file 选项是互斥的。

示例

- name: get info on a global address
  gcp_compute_global_address_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复杂类型

资源列表

返回：始终

address

字符串

此资源表示的静态外部 IP 地址。

返回：成功

addressType

字符串

要保留的地址类型。

* EXTERNAL 指示公共/外部单个 IP 地址。

* INTERNAL 指示属于某个网络的内部 IP 范围。

返回：成功

creationTimestamp

字符串

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

返回：成功

description

字符串

此资源的可选描述。

返回：成功

id

整数

资源的唯一标识符。此标识符由服务器定义。

返回：成功

ipVersion

字符串

此地址将使用的 IP 版本。默认值为 `IPV4`。

返回：成功

name

字符串

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

返回：成功

网络

字典

用于保留 IP 范围的网络的 URL。IP 范围必须在 RFC1918 空间内。如果存在任何引用它的已保留 IP 范围，则无法删除该网络。

仅在使用内部地址时才应设置此项。

返回：成功

前缀长度

整数

IP 范围的前缀长度。如果不存在，则表示地址字段是单个 IP 地址。

此字段不适用于 addressType=EXTERNAL 的地址，也不适用于 addressType=INTERNAL 且 purpose=PRIVATE_SERVICE_CONNECT 的地址。

返回：成功

用途

字符串

资源的用途。可能的值包括：* VPC_PEERING - 用于对等网络 * PRIVATE_SERVICE_CONNECT - 用于（仅限[Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)）私有服务连接网络。

返回：成功

区域

字符串

区域地址所在的区域的引用。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)