google.cloud.gcp_compute_address_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_address_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

列表 / elements=string

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

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

project

字符串

要使用的 Google Cloud Platform 项目。

region

字符串 / 必填

区域地址所在的区域的 URL。

此字段不适用于全局地址。

scopes

列表 / elements=string

要使用的范围数组

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 an address
  gcp_compute_address_info:
    region: us-west1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复杂

资源列表

返回： 始终

address

字符串

此资源表示的静态外部 IP 地址。仅支持 IPv4。只能为 INTERNAL 地址类型指定地址。如果存在任何指定的子网，则 IP 地址必须在该子网内。

返回： 成功

addressType

字符串

要保留的地址类型。

返回： 成功

creationTimestamp

字符串

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

返回： 成功

description

字符串

此资源的可选描述。

返回： 成功

id

整数

资源的唯一标识符。

返回： 成功

name

字符串

资源名称。该名称必须为 1-63 个字符长，并且符合 RFC1035。具体而言，该名称必须为 1-63 个字符长，并且与正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?` 匹配，这意味着第一个字符必须是小写字母，并且所有后续字符必须是破折号、小写字母或数字，但最后一个字符不能是破折号。

返回： 成功

network

字典

在其中保留地址的网络 URL。此字段只能与具有 VPC_PEERING 和 IPSEC_INTERCONNECT 用途的 INTERNAL 类型一起使用。

返回： 成功

networkTier

字符串

用于配置此地址的网络层。如果未指定此字段，则假定为 PREMIUM。

返回： 成功

prefixLength

整数

如果资源表示 IP 范围，则为前缀长度。

返回： 成功

purpose

字符串

此资源的目的，它可以是以下值之一：* GCE_ENDPOINT，用于 VM 实例、别名 IP 范围、内部负载均衡器和类似资源使用的地址。

* SHARED_LOADBALANCER_VIP，用于可以由多个内部负载均衡器使用的地址。

* VPC_PEERING，用于为 VPC 对等网络保留的地址。

* IPSEC_INTERCONNECT，用于从为 IPsec 加密 Cloud Interconnect 配置中的 VLAN 连接保留的专用 IP 范围创建的地址。这些地址是区域资源。

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

返回： 成功

region

字符串

区域地址所在的区域的 URL。

此字段不适用于全局地址。

返回： 成功

status

字符串

地址的状态，可以是 RESERVING、RESERVED 或 IN_USE 之一。

处于 RESERVING 状态的地址当前正在被保留的过程中。

处于 RESERVED 状态的地址当前已被保留并且可以使用。处于 IN_USE 状态的地址当前正被另一个资源使用，并且不可用。

返回： 成功

subnetwork

字典

用于保留地址的子网的 URL。 如果指定了 IP 地址，则该地址必须在子网的 IP 地址范围内。

此字段只能与具有 GCE_ENDPOINT/DNS_RESOLVER 用途的 INTERNAL 类型一起使用。

返回： 成功

用户

列表 / elements=string

正在使用此地址的资源的 URL。

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)