google.cloud.gcp_compute_region_instance_group_manager_info 模块 – 收集 GCP RegionInstanceGroupManager 的信息

注意

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

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

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

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

注意

由于违反 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合有未解决的健全性测试失败。有关详细信息，请参阅讨论主题。

概要

  • 收集 GCP RegionInstanceGroupManager 的信息

要求

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

  • 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 条件添加（filter1 和 filter2）。

project

字符串

要使用的 Google Cloud Platform 项目。

region

字符串 / 必需

托管实例组所在的区域。

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 a region instance group manager
  gcp_compute_region_instance_group_manager_info:
    region: us-central1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

资源

复杂

资源列表

返回：始终

autoHealingPolicies

复杂

此托管实例组的自动修复策略。

返回：成功

healthCheck

字符串

用于指示自动修复的运行状况检查的 URL。

返回：成功

initialDelaySec

整数

托管实例组在将自动修复策略应用于新实例或最近重新创建的实例之前等待的秒数。

返回：成功

baseInstanceName

字符串

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

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

返回：成功

creationTimestamp

字符串

此托管实例组的创建时间戳，采用 RFC3339 文本格式。

返回：成功

currentActions

复杂

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

返回：成功

abandoning

整数

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

返回：成功

creating

整数

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

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

返回：成功

creatingWithoutRetries

整数

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

返回：成功

正在删除

整数

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

返回：成功

无

整数

托管实例组中正在运行且没有计划操作的实例数量。

返回：成功

正在重建

整数

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

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

返回：成功

正在刷新

整数

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

返回：成功

正在重启

整数

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

返回：成功

描述

字符串

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

返回：成功

ID

整数

此资源的唯一标识符。

返回：成功

实例组

字典

正在管理的实例组。

返回：成功

实例模板

字典

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

返回：成功

名称

字符串

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

返回：成功

命名端口

复杂

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

返回：成功

名称

字符串

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

返回：成功

端口

整数

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

返回：成功

region

字符串

托管实例组所在的区域。

返回：成功

目标池

列表 / elements=string

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

返回：成功

目标大小

整数

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

返回：成功

作者

  • Google Inc. (@googlecloudplatform)