google.cloud.gcp_compute_instance_group_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_instance_group_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 项目。

scopes

列表 / elements=string

要使用的作用域数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。

service_account_email

字符串

如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。

service_account_file

路径

如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

zone

字符串 / 必需

对实例组所在区域的引用。

说明

注意

  • 对于身份验证，您可以使用 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 instance group
  gcp_compute_instance_group_info:
    zone: us-central1-a
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

资源

复杂

资源列表

返回：始终

creationTimestamp

字符串

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

返回：成功

description

字符串

此资源的可选描述。创建资源时提供此属性。

返回：成功

id

整数

此实例组的唯一标识符。

返回：成功

instances

列表 / elements=string

与此实例组关联的实例列表。

所有实例必须先创建，然后才能添加到实例组。

不在该列表中的所有实例将从实例组中删除，并且不会被删除。

只会返回实例的完整标识符。

返回：成功

name

字符串

实例组的名称。

名称长度必须为 1-63 个字符，并且符合 RFC1035。

返回：成功

namedPorts

复杂

将名称分配给端口号。

例如：{name: “http”, port: 80}。

这允许系统通过分配的名称而不是端口号来引用端口。命名端口还可以包含多个端口。

例如：[{name: “http”, port: 80},{name: “http”, port: 8080}] 命名端口适用于此实例组中的所有实例。

返回：成功

name

字符串

此命名端口的名称。

名称长度必须为 1-63 个字符，并且符合 RFC1035。

返回：成功

port

整数

端口号，可以是 1 到 65535 之间的值。

返回：成功

network

字典

实例组中所有实例所属的网络。

返回：成功

region

字符串

实例组所在的区域（对于区域资源）。

返回：成功

subnetwork

字典

实例组中所有实例所属的子网。

返回：成功

zone

字符串

对实例组所在区域的引用。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)