community.hrobot.storagebox_subaccount_info module – Query the subaccounts for a storage box

Note

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

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_subaccount_info.

New in community.hrobot 2.4.0

Synopsis

  • Query the subaccounts for a storage box.

Parameters

Parameter

Comments

hetzner_password

string / required

The password for the Robot web-service user.

hetzner_user

string / required

The username for the Robot web-service user.

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 group: community.hrobot.robot

Use group/community.hrobot.robot 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 subaccounts
  community.hrobot.storagebox_subaccount_info:
    hetzner_user: foo
    hetzner_password: bar
    storage_box_id: 123
  register: result

- name: Output data
  ansible.builtin.debug:
    msg: "Username of the first subaccount: {{ result.subaccounts[0].username }}"

Return Values

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

Key

Description

subaccounts

list / elements=dictionary

The storage box’s info.

All date and time parameters are in UTC.

Returned: success

accountid

string

Username of the main user.

Returned: success

Sample: "u2342"

comment

string

Custom comment for the sub-account.

Returned: success

Sample: "This is a subaccount"

createtime

string

Timestamp when the sub-account was created.

Returned: success

Sample: "2023-08-25T14:23:05Z"

external_reachability

boolean

Status of external reachability.

Returned: success

Sample: false

homedirectory

string

Homedirectory of the sub-account.

Returned: success

Sample: "/home/u2342-sub1"

readonly

boolean

Indicates if the sub-account is in readonly mode.

Returned: success

Sample: false

samba

boolean

Status of Samba support.

Returned: success

Sample: true

server

string

Server on which the sub-account resides.

Returned: success

Sample: "sb1234.your-storagebox.de"

ssh

boolean

Status of SSH support.

Returned: success

Sample: true

username

string

Username of the sub-account.

Returned: success

Sample: "u2342-sub1"

webdav

boolean

Status of WebDAV support.

Returned: success

Sample: true

Authors

  • Victor LEFEBVRE (@vic1707)