community.hrobot.storagebox module – Modify a storage box’s basic configuration

Note

This module is part of the community.hrobot collection (version 2.3.0).

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.

New in community.hrobot 2.1.0

Synopsis 

Modify a storage box’s basic configuration.

Parameters 

Parameter	Comments
external_reachability boolean	Whether the storage box is externally reachable. Choices: `false` `true`
hetzner_password string / required	The password for the Robot web-service user.
hetzner_user string / required	The username for the Robot web-service user.
id integer / required	The ID of the storage box to modify.
name string	The name of the storage box.
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`
samba boolean	Whether the storage box is accessible through SAMBA. Choices: `false` `true`
ssh boolean	Whether the storage box is accessible through SSH. Choices: `false` `true`
webdav boolean	Whether the storage box is accessible through WebDAV. Choices: `false` `true`
zfs boolean	Whether the ZFS directory is visible. Choices: `false` `true`

Attributes 

Attribute	Support	Description
action_group	Action group: community.hrobot.robot	Use `group/community.hrobot.robot` in `module_defaults` to set defaults for this module.
check_mode	Support: full	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: full	Will return details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.
idempotent	Support: full	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: Setup storagebox
  community.hrobot.storagebox:
    hetzner_user: foo
    hetzner_password: bar
    name: "My storage box"
    ssh: true
    samba: false
    webdav: false
    external_reachability: false
    zfs: false

Return Values 

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

Key	Description
external_reachability boolean	Whether the storage box is reachable externally. Returned: success Sample: `true`
name string	The storage box’s name. Returned: success Sample: `"Backup Server 1"`
samba boolean	Whether SAMBA is active. Returned: success Sample: `true`
ssh boolean	Whether SSH is active. Returned: success Sample: `true`
webdav boolean	Whether WebDAV is active. Returned: success Sample: `true`
zfs boolean	Shows whether the ZFS directory is visible. Returned: success Sample: `false`

Authors

Felix Fontein (@felixfontein)

community.hrobot.storagebox module – Modify a storage box’s basic configuration

Synopsis

Parameters

Attributes

Examples

Return Values