hetzner.hcloud.hcloud_volume_info – Gather infos about your Hetzner Cloud Volumes.

Note

This plugin is part of the hetzner.hcloud collection.

To install it use: ansible-galaxy collection install hetzner.hcloud.

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

Synopsis

  • Gather infos about your Hetzner Cloud Volumes.

Requirements

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

  • hcloud-python >= 1.0.0

Parameters

Parameter Choices/Defaults Comments
api_token
string / required
This is the API Token for the Hetzner Cloud.
endpoint
string
Default:
"https://api.hetzner.cloud/v1"
This is the API Endpoint for the Hetzner Cloud.
id
integer
The ID of the Volume you want to get.
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
  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 Returned Description
hcloud_volume_info
complex
always
The Volume infos as list

 
delete_protection
boolean
added in 0.1.0
always
True if the Volume is protected for deletion

 
id
integer
always
Numeric identifier of the Volume

Sample:
1937415
 
labels
dictionary
always
User-defined labels (key-value pairs)

 
linux_device
string
added in 0.1.0
always
Path to the device that contains the Volume.

Sample:
/dev/disk/by-id/scsi-0HC_Volume_12345
 
location
string
always
Name of the location where the Volume resides in

Sample:
fsn1
 
name
string
always
Name of the Volume

Sample:
my-volume
 
server
string
always
Name of the server where the Volume is attached to

Sample:
my-server
 
size
string
always
Size of the Volume

Sample:
10


Authors

  • Lukas Kaemmerling (@LKaemmerling)