community.hrobot.storagebox_snapshot_info module – Query the snapshots for a storage box

Note

This module is part of the community.hrobot 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 community.hrobot.

To use it in a playbook, specify: community.hrobot.storagebox_snapshot_info.

New in community.hrobot 2.4.0

Synopsis
Parameters
Attributes
Examples
Return Values

Synopsis

Query the snapshots for a storage box.

Parameters

Parameter	Comments
hetzner_password string	The password for the Robot web-service user. If `hetzner_password` is specified, `hetzner_user` must also be specified, and `hetzner_token` must not be specified.
hetzner_token string added in community.hrobot 2.5.0	The API token for the Robot web-service user. One of `hetzner_token` and `hetzner_user` must be specified.
hetzner_user string	The username for the Robot web-service user. One of `hetzner_token` and `hetzner_user` must be specified. If `hetzner_user` is specified, `hetzner_password` must also be specified, and `hetzner_token` must not be specified.
rate_limit_retry_timeout integer added in community.hrobot 2.1.0	Timeout (in seconds) for waiting when rate limit exceeded errors are returned. Set to `0` to not retry. Set to a negative value like `-1` to retry forever. Default: `-1`
storagebox_id integer / required	The ID of the storage box to query.

Attributes

Attribute	Support	Description
action_group	Action groups: community.hrobot.api, community.hrobot.robot	Use `group/community.hrobot.robot` or `group/community.hrobot.api` in `module_defaults` to set defaults for this module.
check_mode	Support: full This action does not modify state.	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: N/A This action does not modify state.	Will return details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.
idempotent	Support: full This action does not modify state.	When run twice in a row outside check mode, with the same arguments, the second invocation indicates no change. This assumes that the system controlled/queried by the module has not changed in a relevant way.

Examples

---
- name: Query the snapshots
  community.hrobot.storagebox_snapshot_info:
    hetzner_user: foo
    hetzner_password: bar
    id: 123
  register: result

- name: Output data
  ansible.builtin.debug:
    msg: "Timestamp of the first snapshot : {{ result.snapshots[0].timestamp }}"

Return Values

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

Key	Description
snapshots list / elements=dictionary	The storage box’s info. All date and time parameters are in UTC. Returned: success
automatic boolean	Whether the snapshot was created automatically. Note that this is computed from `snapshots[].is_automatic` in case `hetzner_token` is specified. Returned: success Sample: `false`
comment string	The comment for the snapshot. Note that this is copied from `snapshots[].description` in case `hetzner_token` is specified. Returned: success Sample: `"This is a snapshot"`
created integer added in community.hrobot 2.5.0	The creation timestamp of snapshot in UTC, in ISO-8601 format. Returned: success and `hetzner_token` is specified Sample: `"2016-01-30T23:55:00+00:00"`
description integer added in community.hrobot 2.5.0	The snapshot’s description (used to be called comment in the Robot API). Returned: success and `hetzner_token` is specified Sample: `"my-description"`
filesystem_size integer	The size of the Storage Box at creation time of the snapshot in MB. Note that this is computed from `snapshots[].stats.size_filesystem` in case `hetzner_token` is specified. Returned: success Sample: `12345`
id integer added in community.hrobot 2.5.0	The snapshot’s ID. Returned: success and `hetzner_token` is specified Sample: `1`
is_automatic boolean added in community.hrobot 2.5.0	Whether the snapshot was created automatically. Returned: success and `hetzner_token` is specified Sample: `true`
labels dictionary added in community.hrobot 2.5.0	User-defined labels for the snapshot. Returned: success and `hetzner_token` is specified
name string	The snapshot name. Returned: success Sample: `"2025-01-21T12-40-38"`
size integer	The Snapshot size in MB. Note that this is copied from `snapshots[].stats.size` in case `hetzner_token` is specified. Returned: success Sample: `400`
stats dictionary added in community.hrobot 2.5.0	Statistics about the snapshot. Returned: success and `hetzner_token` is specified
size integer	Total size of the snapshot in bytes. Returned: success Sample: `2097152`
size_filesystem integer	Actual size of the snapshot on the filesystem in bytes (after deduplication). Returned: success Sample: `1048576`
storage_box integer added in community.hrobot 2.5.0	ID of the associated storage box. Returned: success and `hetzner_token` is specified Sample: `42`
timestamp string	The timestamp of snapshot in UTC. Note that this is copied from `snapshots[].created` in case `hetzner_token` is specified. Returned: success Sample: `"2025-01-21T13:40:38+00:00"`

Authors

Matthias Hurdebise (@matthiashurdebise)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/hrobot/storagebox_snapshot_info_module.html