hetzner.hcloud.storage_box_type_info module – Gather infos about Hetzner Storage Box Types.

Note

This module is part of the hetzner.hcloud collection (version 6.10.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.storage_box_type_info.

Synopsis

Aliases: hcloud_storage_box_type_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 endpoint for the Hetzner Cloud API.

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

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

api_endpoint_hetzner

string

The endpoint for the Hetzner API.

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

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

api_token

string / required

The token for the Hetzner Cloud API.

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

id

integer

ID of the Storage Box Type to get.

If the ID is invalid, the module will fail.

name

string

Name of the Storage Box Type to get.

See Also

See also

Documentation for Hetzner APIs

Complete reference for the Hetzner APIs.

Examples

- name: Gather Storage Box Types infos
  hetzner.hcloud.storage_box_type_info:
  register: output

- name: Print the gathered infos
  debug:
    var: output.hcloud_storage_box_type_info

Return Values

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

Key

Description

hcloud_storage_box_type_info

list / elements=string

List of Storage Box Types.

Returned: always

automatic_snapshot_limit

integer

Maximum number of snapshots created automatically by a snapshot plan.

Returned: success

Sample: 10

deprecation

dictionary

Deprecation details about the Storage Box Type.

Returned: when deprecated

announced

string

Date when the deprecation was announced.

Returned: success

Sample: "2025-06-02T00:00:00Z"

unavailable_after

string

Date when the resource will stop being available. The resource will be removed from the list endpoint, but details about the resource can be fetched using its ID.

Returned: success

Sample: "2025-09-02T00:00:00Z"

description

string

Description of the Storage Box Type.

Returned: success

Sample: "BX21"

id

integer

ID of the Storage Box Type.

Returned: success

Sample: 1937415

name

string

Name of the Storage Box Type.

Returned: success

Sample: "bx21"

size

integer

Available storage in bytes.

Returned: success

Sample: 1099511627776

snapshot_limit

integer

Maximum number of allowed manual snapshots.

Returned: success

Sample: 10

subaccounts_limit

integer

Maximum number of subaccounts.

Returned: success

Sample: 200

Authors

  • Jonas Lammler (@jooola)