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.5.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_subaccount_info.
New in community.hrobot 2.4.0
Synopsis
Query the subaccounts for a storage box.
Parameters
Parameter |
Comments |
|---|---|
The password for the Robot web-service user. If This option is deprecated for this module, and support will be removed in community.hrobot 3.0.0. |
|
The API token for the Robot web-service user. One of This option will be required from community.hrobot 3.0.0 on. |
|
The username for the Robot web-service user. One of If This option is deprecated for this module, and support will be removed in community.hrobot 3.0.0. |
|
Timeout (in seconds) for waiting when rate limit exceeded errors are returned. Set to Set to a negative value like Default: |
|
The ID of the storage box to query. |
Attributes
Attribute |
Support |
Description |
|---|---|---|
Action groups: community.hrobot.api, community.hrobot.robot |
Use The |
|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
|
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 |
|---|---|
The storage box’s info. All date and time parameters are in UTC. Returned: success |
|
Access settings of the subaccount. Returned: success |
|
Whether the subaccount is reachable from outside Hetzner’s network. Returned: success Sample: |
|
Whether the subaccount is read-only. Returned: success Sample: |
|
Whether the subaccount can be accessed through SAMBA. Returned: success Sample: |
|
Whether the subaccount can be accessed through SSH. Returned: success Sample: |
|
Whether the subaccount can be accessed through WebDAV. Returned: success Sample: |
|
Username of the main user. Not supported by the new Hetzner API. This return value is deprecated and will be removed from community.hrobot 3.0.0. If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value. Returned: success and if Sample: |
|
Custom comment for the sub-account. Note that this is copied from This return value is deprecated and will be removed from community.hrobot 3.0.0. If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value. Returned: success Sample: |
|
Creation timestamp in ISO-8601 format. Returned: success Sample: |
|
Timestamp when the sub-account was created. Note that this is copied from This return value is deprecated and will be removed from community.hrobot 3.0.0. If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value. Returned: success Sample: |
|
A user-defined description for the subaccount. Returned: success Sample: |
|
Status of external reachability. Note that this is copied from This return value is deprecated and will be removed from community.hrobot 3.0.0. If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value. Returned: success Sample: |
|
Home directory of the subaccount. Returned: success Sample: |
|
Homedirectory of the sub-account. Note that this is copied from This return value is deprecated and will be removed from community.hrobot 3.0.0. If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value. Returned: success Sample: |
|
The subaccount’s ID. Returned: success Sample: |
|
User-defined labels for the subaccount. Returned: success |
|
Indicates if the sub-account is in readonly mode. Note that this is copied from This return value is deprecated and will be removed from community.hrobot 3.0.0. If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value. Returned: success Sample: |
|
Status of Samba support. Note that this is copied from This return value is deprecated and will be removed from community.hrobot 3.0.0. If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value. Returned: success Sample: |
|
Server on which the sub-account resides. Returned: success Sample: |
|
Status of SSH support. Note that this is copied from This return value is deprecated and will be removed from community.hrobot 3.0.0. If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value. Returned: success Sample: |
|
The associated storage box’s ID. Returned: success Sample: |
|
Username of the sub-account. Returned: success Sample: |
|
Status of WebDAV support. Note that this is copied from This return value is deprecated and will be removed from community.hrobot 3.0.0. If you are using ansible-core 2.19 or newer, you will see a deprecation message when using this return value. Returned: success Sample: |