google.cloud.gcp_compute_reservation 模块 – 创建一个 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。

注意

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

概要

• 表示预留资源。预留确保即使预留的虚拟机未运行，容量也会保留在特定区域中。

• 预留仅适用于 Compute Engine、Cloud Dataproc 和 Google Kubernetes Engine 虚拟机使用。预留不适用于 `f1-micro` 或 `g1-small` 机器类型、抢占式虚拟机、单租户节点或上面未列出的其他服务，如 Cloud SQL 和 Dataflow。

要求

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

• python >= 2.6

• requests >= 2.18.4

• google-auth >= 1.3.0

参数

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必填	使用的凭据类型。 选项 "application" "machineaccount" "serviceaccount" "accesstoken"
description 字符串	此资源的可选描述。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的 User Agent 字符串。
name 字符串 / 必填	资源名称。客户端在创建资源时提供。名称必须为 1-63 个字符长，并符合 RFC1035。具体来说，名称必须为 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，除了最后一个字符，它不能是破折号。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / elements=string	要使用的作用域数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典形式或表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
specific_reservation 字典 / 必填	具有特定机器形状的实例的预留。
count 整数 / 必填	分配的资源数量。
instance_properties 字典 / 必填	预留的实例属性。
guest_accelerators 列表 / elements=dictionary	来宾加速器类型和计数。
accelerator_count 整数 / 必填	暴露给此实例的来宾加速器卡的数量。
accelerator_type 字符串 / 必填	要附加到此实例的加速器类型的完整或部分 URL。例如：`projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100`。如果要创建实例模板，请仅指定加速器名称。
local_ssds 列表 / elements=dictionary	要为每个实例预留的本地 ssd 量。这会预留 `local-ssd` 类型的磁盘。
disk_size_gb 整数 / 必填	磁盘的大小（以 2 为底的 GB 为单位）。
interface 字符串	用于连接此磁盘的磁盘接口。 一些有效的选项包括：“SCSI”、“NVME” 默认值： "SCSI"
machine_type 字符串 / 必填	要预留的机器类型名称。
min_cpu_platform 字符串	预留的最小 CPU 平台。例如，`”Intel Skylake”`。有关可用 CPU 平台的信息，请参阅https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones。
specific_reservation_required 布尔值	设置为 true 时，只有通过名称定位此预留的虚拟机才能使用此预留。否则，具有任何预留亲和力的虚拟机都可以使用它。默认为 false。 选项 false ←（默认） true
state 字符串	给定对象是否应存在于 GCP 中 选项 "present" ←（默认） "absent"
zone 字符串 / 必填	进行预留的区域。

注释

注意

• API 参考：https://cloud.google.com/compute/docs/reference/rest/v1/reservations

• 预留区域资源：https://cloud.google.com/compute/docs/instances/reserving-zonal-resources

• 对于身份验证，您可以使用 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 环境变量设置作用域。

• 仅当 playbook 值未设置时，才会使用环境变量值。

• service_account_email 和 service_account_file 选项是互斥的。

示例

- name: create a reservation
  google.cloud.gcp_compute_reservation:
    name: test_object
    zone: us-central1-a
    specific_reservation:
      count: 1
      instance_properties:
        min_cpu_platform: Intel Cascade Lake
        machine_type: n2-standard-2
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

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

键	描述
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 布尔值	设置为 true 时，只有通过名称定位此预留的虚拟机才能使用此预留。否则，具有任何预留亲和力的虚拟机都可以使用它。默认为 false。 返回: 成功
status 字符串	预留的状态。 返回: 成功
zone 字符串	进行预留的区域。 返回: 成功

作者

• Google Inc. (@googlecloudplatform)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）