hetzner.hcloud.volume 模块 – 在 Hetzner Cloud 上创建和管理块存储卷。

注意

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

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

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

要在剧本中使用它，请指定：hetzner.hcloud.volume。

概要 

在 Hetzner Cloud 上创建、更新和连接/分离块存储卷。

别名：hcloud_volume

要求 

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

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` 环境变量来设置此选项。
automount 布尔值	自动挂载存储卷。选项 `false` ←（默认） `true`
delete_protection 布尔值	保护存储卷不被删除。选项 `false` `true`
format 字符串	在创建时自动格式化存储卷仅在存储卷不存在时可以使用。选项 `"xfs"` `"ext4"`
id 整数	要管理的 Hetzner Cloud 块存储卷的 ID。仅在未给定存储卷名称时需要
labels 字典	用户定义的键值对。
location 字符串	Hetzner Cloud 存储卷的位置。如果未给定服务器且存储卷不存在，则为必需项。
name 字符串	要管理的 Hetzner Cloud 块存储卷的名称。仅在未给定存储卷id或存储卷不存在时需要。
server 字符串	存储卷应分配到的服务器名称。如果未给定位置且存储卷不存在，则为必需项。
size 整数	块存储卷的大小，以 GB 为单位。如果存储卷尚不存在，则为必需项。
state 字符串	存储卷的状态。选项 `"absent"` `"present"` ←（默认）

另请参阅 

另请参阅

Hetzner Cloud API 的文档: Hetzner Cloud API 的完整参考。

示例 

- name: Create a Volume
  hetzner.hcloud.volume:
    name: my-volume
    location: fsn1
    size: 100
    state: present
- name: Create a Volume and format it with ext4
  hetzner.hcloud.volume:
    name: my-volume
    location: fsn
    format: ext4
    size: 100
    state: present
- name: Mount a existing Volume and automount
  hetzner.hcloud.volume:
    name: my-volume
    server: my-server
    automount: true
    state: present
- name: Mount a existing Volume and automount
  hetzner.hcloud.volume:
    name: my-volume
    server: my-server
    automount: true
    state: present
- name: Ensure the Volume is absent (remove if needed)
  hetzner.hcloud.volume:
    name: my-volume
    state: absent

返回值 

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

键	描述
hcloud_volume 复杂	块存储卷返回：始终
delete_protection 布尔值在 hetzner.hcloud 0.1.0 中添加	如果存储卷受到删除保护，则为 True 返回：始终示例： `false`
id 整数	存储卷的 ID 返回：始终示例： `12345`
labels 字典	用户定义的标签（键值对）返回：始终示例： `{"key": "value", "mylabel": 123}`
linux_device 字符串在 hetzner.hcloud 0.1.0 中添加	包含存储卷的设备的路径。返回：始终示例： `"/dev/disk/by-id/scsi-0HC_Volume_12345"`
location 字符串	存储卷所在位置的名称返回：始终示例： `"fsn1"`
name 字符串	存储卷的名称返回：始终示例： `"my-volume"`
server 字符串	存储卷附加到的服务器名称返回：始终示例： `"my-server"`
size 整数	存储卷的大小，以 GB 为单位返回：始终示例： `1337`

作者

Christopher Schmitt (@cschmitt-hcloud)