google.cloud.gcp_compute_reservation_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_reservation_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

列表 / 元素=字符串

过滤器值对的列表。此处列出了可用的过滤器 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 a reservation
  gcp_compute_reservation_info:
    zone: us-central1-a
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

常用的返回值已在 此处 记录，以下是此模块独有的字段

键

描述

resources

复杂

资源列表

返回：始终

commitment

字符串

指向父级承诺的完整或部分URL。此字段显示与承诺关联的预留资源。

返回：成功

creationTimestamp

字符串

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

返回：成功

description

字符串

此资源的可选描述。

返回：成功

id

整数

资源的唯一标识符。

返回：成功

name

字符串

资源名称。创建资源时由客户端提供。名称必须为1-63个字符长，并符合RFC1035。具体来说，名称必须为1-63个字符长，并匹配正则表达式`[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，最后一个字符不能是破折号。

返回：成功

specificReservation

复杂

具有特定机器类型的实例的预留资源。

返回：成功

count

整数

已分配的资源数量。

返回：成功

instanceProperties

复杂

预留资源的实例属性。

返回：成功

guestAccelerators

复杂

访客加速器类型和数量。

返回：成功

acceleratorCount

整数

向此实例公开的访客加速器卡数量。

返回：成功

acceleratorType

字符串

附加到此实例的加速器类型的完整或部分 URL。例如：`projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100` 如果您正在创建实例模板，则只需指定加速器名称。

返回：成功

本地SSD

复杂

为每个实例预留的本地 SSD 容量。这将预留类型为 `local-ssd` 的磁盘。

返回：成功

磁盘大小（GB）

整数

磁盘大小（以 2 的幂次方 GB 为单位）。

返回：成功

接口

字符串

用于附加此磁盘的磁盘接口。

返回：成功

机器类型

字符串

要预留的机器类型名称。

返回：成功

最小 CPU 平台

字符串

预留的最小 CPU 平台。例如，“Intel Skylake”。有关可用 CPU 平台的信息，请参阅 https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones。

返回：成功

正在使用中的实例数

整数

正在使用的实例数量。

返回：成功

是否需要特定预留

布尔值

设置为 true 时，只有按名称定位此预留的虚拟机才能使用此预留。否则，具有任何预留关联性的虚拟机都可以使用它。默认为 false。

返回：成功

状态

字符串

预留的状态。

返回：成功

zone

字符串

预留资源所在的区域。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)