hetzner.hcloud.volume_info 模块 – 收集关于您的 Hetzner Cloud 卷的信息。

注意

此模块是 hetzner.hcloud 集合 (版本 4.2.2) 的一部分。

如果您使用的是 ansible 包,则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用: ansible-galaxy collection install hetzner.hcloud。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。

要在剧本中使用它,请指定: hetzner.hcloud.volume_info

概要

  • 收集关于您的 Hetzner Cloud 卷的信息。

别名:hcloud_volume_info

要求

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

  • python-dateutil >= 2.7.5

  • requests >=2.20

参数

参数

注释

api_endpoint

别名:endpoint

字符串

Hetzner Cloud 的 API 端点。

您也可以使用 HCLOUD_ENDPOINT 环境变量来设置此选项。

默认值: "https://api.hetzner.cloud/v1"

api_token

字符串 / 必需

Hetzner Cloud 的 API 令牌。

您也可以使用 HCLOUD_TOKEN 环境变量来设置此选项。

id

整数

要获取的卷的 ID。

如果提供的 ID 无效,模块将失败。

label_selector

字符串

要获取的卷的标签选择器。

name

字符串

要获取的卷的名称。

另请参阅

另请参阅

Hetzner Cloud API 文档

Hetzner Cloud API 的完整参考。

示例

- name: Gather hcloud Volume infos
  hetzner.hcloud.volume_info:
  register: output
- name: Print the gathered infos
  debug:
    var: output.hcloud_volume_info

返回值

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

描述

hcloud_volume_info

复杂类型

卷信息列表

返回:始终

delete_protection

布尔值

在 hetzner.hcloud 0.1.0 中添加

如果卷受保护以防止删除,则为 True

返回:始终

id

整数

卷的数字标识符

返回:始终

示例: 1937415

labels

字典

用户定义的标签(键值对)

返回:始终

linux_device

字符串

在 hetzner.hcloud 0.1.0 中添加

包含卷的设备的路径。

返回:始终

示例: "/dev/disk/by-id/scsi-0HC_Volume_12345"

location

字符串

卷所在的地理位置名称

返回:始终

示例: "fsn1"

name

字符串

卷的名称

返回:始终

示例: "my-volume"

server

字符串

附加卷的服务器名称

返回:始终

示例: "my-server"

size

字符串

卷的大小

返回:始终

示例: "10"

作者

  • Lukas Kaemmerling (@LKaemmerling)