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

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`。如果您正在创建实例模板，则仅指定加速器名称。

返回： 成功

localSsds

复杂

每个实例要预留的本地 ssd 的大小。这将预留类型为 `local-ssd` 的磁盘。

返回： 成功

diskSizeGb

整数

磁盘的大小（以 2 为底的 GB 为单位）。

返回： 成功

interface

字符串

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

返回： 成功

machineType

字符串

要预留的机器类型名称。

返回： 成功

minCpuPlatform

字符串

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

返回： 成功

inUseCount

整数

正在使用的实例数量。

返回： 成功

specificReservationRequired

boolean

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

返回： 成功

status

字符串

预留的状态。

返回： 成功

zone

字符串

进行预留的区域。

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)