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

字符串

如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

env_type

字符串

指定您在哪个 Ansible 环境中运行此模块。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 API 请求的用户代理字符串。

filters

列表 / 元素=字符串

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

列表中的每个附加筛选器都将作为 AND 条件添加 (filter1 和 filter2)。

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / 元素=字符串

要使用的作用域数组

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 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

字符串

此组中实例要使用的基本实例名称。该值必须为 1-58 个字符。实例的命名方法是将短横线和一个随机的四个字符的字符串附加到基本实例名称。

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

返回： 成功

creationTimestamp

字符串

此托管实例组的创建时间戳，以 RFC3339 文本格式表示。

返回： 成功

currentActions

复杂类型

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

返回： 成功

abandoning

整数

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

返回： 成功

creating

整数

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

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

返回： 成功

creatingWithoutRetries

整数

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

返回： 成功

正在删除

整数

已安排删除或当前正在删除的托管实例组中的实例数。

返回： 成功

无

整数

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

返回： 成功

正在重新创建

整数

已安排重新创建或当前正在重新创建的托管实例组中的实例数。

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

返回： 成功

正在刷新

整数

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

返回： 成功

正在重启

整数

已安排重启或当前正在重启的托管实例组中的实例数。

返回： 成功

描述

字符串

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

返回： 成功

ID

整数

此资源的唯一标识符。

返回： 成功

实例组

字典

正在管理的实例组。

返回： 成功

实例模板

字典

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

返回： 成功

名称

字符串

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

返回： 成功

命名端口

复杂类型

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

返回： 成功

名称

字符串

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

返回： 成功

端口

整数

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

返回： 成功

区域

字符串

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

返回： 成功

目标池

列表 / 元素=字符串

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

返回： 成功

目标大小

整数

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

返回： 成功

zone

字符串

托管实例组所在的区域。

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)