Модуль community.hrobot.storagebox_subaccount_info — получение списка субаккаунтов для хранилища

Примечание

Этот модуль входит в коллекцию community.hrobot (версия 2.7.2).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.hrobot.

Чтобы использовать её в плейбуке, укажите: community.hrobot.storagebox_subaccount_info.

Добавлено в community.hrobot 2.4.0

Краткое описание
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Получение списка субаккаунтов для хранилища.

Параметры

Параметр	Комментарии
hetzner_password строка	Пароль пользователя веб-службы Robot. Если указан `hetzner_password`, также необходимо указать `hetzner_user`, а `hetzner_token` указывать нельзя. Этот параметр устарел для данного модуля; его поддержка будет удалена в community.hrobot 3.0.0.
hetzner_token строка добавлено в community.hrobot 2.5.0	Токен API пользователя веб-службы Robot. Необходимо указать один из параметров: `hetzner_token` или `hetzner_user`. Этот параметр станет обязательным начиная с community.hrobot 3.0.0.
hetzner_user строка	Имя пользователя веб-службы Robot. Необходимо указать один из параметров: `hetzner_token` или `hetzner_user`. Если указан `hetzner_user`, также необходимо указать `hetzner_password`, а `hetzner_token` указывать нельзя. Этот параметр устарел для данного модуля; его поддержка будет удалена в community.hrobot 3.0.0.
rate_limit_retry_timeout целое число добавлено в community.hrobot 2.1.0	Время ожидания (в секундах) при получении ошибок превышения ограничения частоты запросов. Укажите `0`, чтобы отключить повторные попытки. Укажите отрицательное значение, например `-1`, чтобы повторять попытки бесконечно. По умолчанию: `-1`
storagebox_id целое число / обязательный	Идентификатор хранилища, для которого нужно получить данные.

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группы действий: community.hrobot.api, community.hrobot.robot	Используйте `group/community.hrobot.robot` или `group/community.hrobot.api` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля. Группа `group/community.hrobot.robot` для этого модуля устарела; модуль будет удалён из группы в community.hrobot 3.0.0.
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в `check_mode` и возвращать прогноз статуса изменений, не изменяя целевую систему.
diff_mode	Поддержка: не применимо Это действие не изменяет состояние.	В режиме diff возвращает сведения о том, что изменилось (или, возможно, должно измениться в `check_mode`).
idempotent	Поддержка: полная Это действие не изменяет состояние.	При повторном запуске подряд вне режима проверки с теми же аргументами второй вызов сообщает об отсутствии изменений. Предполагается, что система, которой управляет модуль или сведения о которой он запрашивает, не изменилась существенным образом.

Примеры

---
- 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 }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
subaccounts список / элементы=словарь	Сведения о хранилище. Все параметры даты и времени указаны в формате UTC. Возвращается: при успешном выполнении
access_settings словарь добавлено в community.hrobot 2.5.0	Параметры доступа субаккаунта. Возвращается: при успешном выполнении
reachable_externally логическое значение	Указывает, доступен ли субаккаунт извне сети Hetzner. Возвращается: при успешном выполнении Пример: `true`
readonly логическое значение	Указывает, доступен ли субаккаунт только для чтения. Возвращается: при успешном выполнении Пример: `false`
samba_enabled логическое значение	Указывает, можно ли обращаться к субаккаунту через SAMBA. Возвращается: при успешном выполнении Пример: `false`
ssh_enabled логическое значение	Указывает, можно ли обращаться к субаккаунту через SSH. Возвращается: при успешном выполнении Пример: `true`
webdav_enabled логическое значение	Указывает, можно ли обращаться к субаккаунту через WebDAV. Возвращается: при успешном выполнении Пример: `false`
accountid строка	Имя пользователя основного аккаунта. Не поддерживается новым API Hetzner. Это возвращаемое значение устарело и будет удалено из community.hrobot 3.0.0. При использовании ansible-core 2.19 или новее при использовании этого возвращаемого значения с `hetzner_token` появится сообщение об устаревании. Возвращается: при успешном выполнении и если не указан `hetzner_token` Пример: `"u2342"`
comment строка	Пользовательский комментарий к субаккаунту. Обратите внимание: если указан `hetzner_token`, это значение копируется из `subaccounts[].description`. Это возвращаемое значение устарело и будет удалено из community.hrobot 3.0.0. При использовании ansible-core 2.19 или новее при использовании этого возвращаемого значения с `hetzner_token` появится сообщение об устаревании. Возвращается: при успешном выполнении Пример: `"This is a subaccount"`
created строка добавлено в community.hrobot 2.5.0	Метка времени создания в формате ISO-8601. Возвращается: при успешном выполнении Пример: `"2025-02-22:00:02.000Z"`
createtime строка	Метка времени создания субаккаунта. Обратите внимание: если указан `hetzner_token`, это значение копируется из `subaccounts[].created`. Это возвращаемое значение устарело и будет удалено из community.hrobot 3.0.0. При использовании ansible-core 2.19 или новее при использовании этого возвращаемого значения с `hetzner_token` появится сообщение об устаревании. Возвращается: при успешном выполнении Пример: `"2023-08-25T14:23:05Z"`
description строка добавлено в community.hrobot 2.5.0	Описание субаккаунта, заданное пользователем. Возвращается: при успешном выполнении Пример: `"host01 backup"`
external_reachability логическое значение	Статус доступности извне. Обратите внимание: если указан `hetzner_token`, это значение копируется из `subaccounts[].access_settings.reachable_externally`. Это возвращаемое значение устарело и будет удалено из community.hrobot 3.0.0. При использовании ansible-core 2.19 или новее при использовании этого возвращаемого значения с `hetzner_token` появится сообщение об устаревании. Возвращается: при успешном выполнении Пример: `false`
home_directory строка добавлено в community.hrobot 2.5.0	Домашний каталог субаккаунта. Возвращается: при успешном выполнении Пример: `"my_backups/host01.my.company"`
homedirectory строка	Домашний каталог субаккаунта. Обратите внимание: если указан `hetzner_token`, это значение копируется из `subaccounts[].home_directory`. Это возвращаемое значение устарело и будет удалено из community.hrobot 3.0.0. При использовании ansible-core 2.19 или новее при использовании этого возвращаемого значения с `hetzner_token` появится сообщение об устаревании. Возвращается: при успешном выполнении Пример: `"/home/u2342-sub1"`
id целое число добавлено в community.hrobot 2.5.0	Идентификатор субаккаунта. Возвращается: при успешном выполнении Пример: `42`
labels словарь добавлено в community.hrobot 2.5.0	Метки субаккаунта, заданные пользователем. Возвращается: при успешном выполнении
readonly логическое значение	Указывает, находится ли субаккаунт в режиме только для чтения. Обратите внимание: если указан `hetzner_token`, это значение копируется из `subaccounts[].access_settings.readonly`. Это возвращаемое значение устарело и будет удалено из community.hrobot 3.0.0. При использовании ansible-core 2.19 или новее при использовании этого возвращаемого значения с `hetzner_token` появится сообщение об устаревании. Возвращается: при успешном выполнении Пример: `false`
samba логическое значение	Статус поддержки Samba. Обратите внимание: если указан `hetzner_token`, это значение копируется из `subaccounts[].access_settings.samba_enabled`. Это возвращаемое значение устарело и будет удалено из community.hrobot 3.0.0. При использовании ansible-core 2.19 или новее при использовании этого возвращаемого значения с `hetzner_token` появится сообщение об устаревании. Возвращается: при успешном выполнении Пример: `true`
server строка	Сервер, на котором находится субаккаунт. Возвращается: при успешном выполнении Пример: `"sb1234.your-storagebox.de"`
ssh логическое значение	Статус поддержки SSH. Обратите внимание: если указан `hetzner_token`, это значение копируется из `subaccounts[].access_settings.ssh_enabled`. Это возвращаемое значение устарело и будет удалено из community.hrobot 3.0.0. При использовании ansible-core 2.19 или новее при использовании этого возвращаемого значения с `hetzner_token` появится сообщение об устаревании. Возвращается: при успешном выполнении Пример: `true`
storage_box целое число добавлено в community.hrobot 2.5.0	Идентификатор связанного хранилища. Возвращается: при успешном выполнении Пример: `42`
username строка	Имя пользователя субаккаунта. Возвращается: при успешном выполнении Пример: `"u2342-sub1"`
webdav логическое значение	Статус поддержки WebDAV. Обратите внимание: если указан `hetzner_token`, это значение копируется из `subaccounts[].access_settings.webdav_enabled`. Это возвращаемое значение устарело и будет удалено из community.hrobot 3.0.0. При использовании ansible-core 2.19 или новее при использовании этого возвращаемого значения с `hetzner_token` появится сообщение об устаревании. Возвращается: при успешном выполнении Пример: `true`

Авторы

Victor LEFEBVRE (@vic1707)

Ссылки на коллекцию

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