google.cloud.gcp_compute_instance_group_manager_info 模块 – 收集 GCP InstanceGroupManager 的信息

注意

此模块是 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_manager_info。

注意

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

概要

  • 收集 GCP InstanceGroupManager 的信息

要求

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

  • 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 / elements=string

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

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

project

string

要使用的 Google Cloud Platform 项目。

scopes

list / elements=string

要使用的作用域数组

service_account_contents

jsonarg

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

service_account_email

string

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

service_account_file

path

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

zone

string / 必需

托管实例组所在的区域。

注释

注意

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

返回值

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

键

描述

resources

复杂

资源列表

返回： 始终

baseInstanceName

string

用于此组中实例的基本实例名称。该值必须为 1-58 个字符长。实例的命名方式是在基本实例名称后附加一个连字符和一个随机的四字符字符串。

基本实例名称必须符合 RFC1035。

返回： 成功

creationTimestamp

string

此托管实例组在 RFC3339 文本格式中的创建时间戳。

返回： 成功

currentActions

复杂

实例操作列表和此托管实例组中计划用于每个操作的实例数量。

返回： 成功

abandoning

integer

计划放弃的托管实例组中的实例总数。放弃实例会将其从托管实例组中移除，而不会将其删除。

返回： 成功

creating

integer

计划创建或当前正在创建的托管实例组中的实例数量。如果该组未能创建任何这些实例，它将再次尝试，直到成功创建实例。

如果禁用了创建重试，则不会填充此字段；相反，将填充 creatingWithoutRetries 字段。

返回： 成功

creatingWithoutRetries

integer

托管实例组将尝试创建的实例数量。该组仅尝试创建每个实例一次。如果该组未能创建任何这些实例，它将相应地减小组的 targetSize 值。

返回： 成功

deleting

integer

计划删除或当前正在删除的托管实例组中的实例数量。

返回： 成功

none

integer

托管实例组中正在运行且未计划任何操作的实例数量。

返回： 成功

recreating

integer

计划重新创建或当前正在重新创建的托管实例组中的实例数量。

重新创建实例会删除现有根持久磁盘，并从实例模板中定义的映像创建一个新磁盘。

返回： 成功

refreshing

integer

正在使用不需要重新启动或重新创建操作的属性重新配置的托管实例组中的实例数量。例如，为实例设置或删除目标池。

返回： 成功

restarting

integer

计划重新启动或当前正在重新启动的托管实例组中的实例数量。

返回： 成功

description

string

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

返回： 成功

id

integer

此资源的唯一标识符。

返回： 成功

instanceGroup

dictionary

正在管理的实例组。

返回： 成功

instanceTemplate

dictionary

为此托管实例组指定的实例模板。该组使用此模板在托管实例组中创建所有新实例。

返回： 成功

名称

string

托管实例组的名称。名称长度必须为 1-63 个字符，并符合 RFC1035 标准。

返回： 成功

命名端口

复杂

为与此实例组管理器互补的实例组配置的命名端口。

返回： 成功

名称

string

此命名端口的名称。名称长度必须为 1-63 个字符，并符合 RFC1035 标准。

返回： 成功

端口

integer

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

返回： 成功

区域

string

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

返回： 成功

目标池

list / elements=string

将实例添加到 instanceGroup 字段中的 TargetPool 资源。目标池自动应用于托管实例组中的所有实例。

返回： 成功

目标大小

integer

此托管实例组的目标运行实例数。删除或放弃实例会减少此数字。调整组大小会更改此数字。

返回： 成功

zone

string

托管实例组所在的区域。

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)