hetzner.hcloud.volume_info module – Gather infos about your Hetzner Cloud Volumes.

Note

This module is part of the hetzner.hcloud collection (version 2.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install hetzner.hcloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hetzner.hcloud.volume_info.

Synopsis

  • Gather infos about your Hetzner Cloud Volumes.

Aliases: hcloud_volume_info

Requirements

The below requirements are needed on the host that executes this module.

  • python-dateutil >= 2.7.5

  • requests >=2.20

Parameters

Parameter

Comments

api_endpoint

aliases: endpoint

string

The API Endpoint for the Hetzner Cloud.

You can also set this option by using the HCLOUD_ENDPOINT environment variable.

Default: "https://api.hetzner.cloud/v1"

api_token

string / required

The API Token for the Hetzner Cloud.

You can also set this option by using the HCLOUD_TOKEN environment variable.

id

integer

The ID of the Volume you want to get.

The module will fail if the provided ID is invalid.

label_selector

string

The label selector for the Volume you want to get.

name

string

The name of the Volume you want to get.

See Also

See also

Documentation for Hetzner Cloud API

Complete reference for the Hetzner Cloud API.

Examples

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

hcloud_volume_info

complex

The Volume infos as list

Returned: always

delete_protection

boolean

added in hetzner.hcloud 0.1.0

True if the Volume is protected for deletion

Returned: always

id

integer

Numeric identifier of the Volume

Returned: always

Sample: 1937415

labels

dictionary

User-defined labels (key-value pairs)

Returned: always

linux_device

string

added in hetzner.hcloud 0.1.0

Path to the device that contains the Volume.

Returned: always

Sample: "/dev/disk/by-id/scsi-0HC_Volume_12345"

location

string

Name of the location where the Volume resides in

Returned: always

Sample: "fsn1"

name

string

Name of the Volume

Returned: always

Sample: "my-volume"

server

string

Name of the server where the Volume is attached to

Returned: always

Sample: "my-server"

size

string

Size of the Volume

Returned: always

Sample: "10"

Authors

  • Lukas Kaemmerling (@LKaemmerling)