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 请求的 User Agent 字符串。

filters

列表 / elements=字符串

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

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

project

字符串

要使用的 Google Cloud Platform 项目。

region

字符串 / 必需

托管实例组所在的区域。

scopes

列表 / elements=字符串

要使用的范围数组

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"

返回值

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

键

描述

resources

复杂

资源列表

返回：始终

autoHealingPolicies

复杂

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

返回：成功

healthCheck

字符串

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

返回：成功

initialDelaySec

整数

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

返回：成功

baseInstanceName

字符串

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

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

返回：成功

creationTimestamp

字符串

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

返回：成功

currentActions

复杂

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

返回：成功

abandoning

整数

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

返回：成功

creating

整数

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

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

返回：成功

creatingWithoutRetries

整数

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

返回：成功

deleting

整数

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

返回：成功

none

整数

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

返回：成功

recreating

整数

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

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

返回：成功

refreshing

整数

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

返回：成功

restarting

整数

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

返回：成功

description

字符串

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

返回：成功

id

整数

此资源的唯一标识符。

返回：成功

instanceGroup

字典

正在管理的实例组。

返回：成功

instanceTemplate

字典

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

返回：成功

name

字符串

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

返回：成功

namedPorts

复杂

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

返回：成功

name

字符串

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

返回：成功

port

整数

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

返回：成功

region

字符串

托管实例组所在的区域。

返回：成功

targetPools

列表 / elements=字符串

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

返回：成功

targetSize

整数

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

返回：成功

作者

  • Google Inc. (@googlecloudplatform)