hetzner.hcloud.storage_box_subaccount_info module – Gather infos about Hetzner Storage Box Subaccounts.

Note

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

Synopsis

Aliases: hcloud_storage_box_subaccount_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 Subaccount to get.

If the ID is invalid, the module will fail.

label_selector

string

Label selector to filter the Storage Box Subaccounts to get.

name

string

Name of the Storage Box Subaccount to get.

storage_box

string / required

ID or Name of the parent Storage Box.

Using the ID is preferred, to reduce the amount of API requests.

See Also

See also

Documentation for Hetzner APIs

Complete reference for the Hetzner APIs.

Examples

- name: Gather all Storage Box Subaccounts
  hetzner.hcloud.storage_box_subaccount_info:
  register: output

- name: Gather Storage Box Subaccounts by label
  hetzner.hcloud.storage_box_subaccount_info:
    label_selector: env=prod
  register: output

- name: Gather a Storage Box Subaccount by name
  hetzner.hcloud.storage_box_subaccount_info:
    name: subaccount1
  register: output

- name: Gather a Storage Box Subaccount by id
  hetzner.hcloud.storage_box_subaccount_info:
    name: 12345
  register: output

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

Return Values

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

Key

Description

hcloud_storage_box_subaccount_info

list / elements=dictionary

List of Storage Box Subaccounts.

Returned: always

access_settings

dictionary

Access settings of the Storage Box Subaccount.

Returned: always

reachable_externally

boolean

Whether access from outside the Hetzner network is allowed.

Returned: always

Sample: false

readonly

boolean

Whether the Subaccount is read-only.

Returned: always

Sample: false

samba_enabled

boolean

Whether the Samba subsystem is enabled.

Returned: always

Sample: false

ssh_enabled

boolean

Whether the SSH subsystem is enabled.

Returned: always

Sample: true

webdav_enabled

boolean

Whether the WebDAV subsystem is enabled.

Returned: always

Sample: false

created

string

Point in time when the Storage Box Subaccount was created (in RFC3339 format).

Returned: always

Sample: "2025-12-03T13:47:47Z"

description

string

Description of the Storage Box Subaccount.

Returned: always

Sample: "backups from subaccount1"

home_directory

string

Home directory of the Storage Box Subaccount.

Returned: always

Sample: "backups/subaccount1"

id

integer

ID of the Storage Box Subaccount.

Returned: always

Sample: 158045

labels

dictionary

User-defined labels (key-value pairs) of the Storage Box Subaccount.

Returned: always

Sample: {"env": "prod"}

name

string

Name of the Storage Box Subaccount.

Returned: always

Sample: "subaccount1"

server

string

FQDN of the Storage Box Subaccount.

Returned: always

Sample: "u514605-sub1.your-storagebox.de"

storage_box

integer

ID of the parent Storage Box.

Returned: always

Sample: 514605

username

string

Username of the Storage Box Subaccount.

Returned: always

Sample: "u514605-sub1"

Authors

  • Jonas Lammler (@jooola)