модуль hetzner.hcloud.storage_box_subaccount_info — Сбор информации о субаккаунтах Hetzner Storage Box.

Примечание

Этот модуль входит в коллекцию hetzner.hcloud (версия 6.9.0).

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

Для установки используйте: ansible-galaxy collection install hetzner.hcloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: hetzner.hcloud.storage_box_subaccount_info.

Краткое описание
Требования
Параметры
См. также
Примеры
Возвращаемые значения

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

Сбор информации о субаккаунтах Hetzner Storage Box.
Подробнее см. в документации API субаккаунтов Storage Box.

Псевдонимы: hcloud_storage_box_subaccount_info

Требования

На узле, на котором выполняется этот модуль, должны быть установлены следующие компоненты.

python-dateutil >= 2.7.5
requests >=2.20

Параметры

Параметр	Комментарии
api_endpoint псевдонимы: endpoint string	Конечная точка API Hetzner Cloud. Этот параметр также можно задать с помощью переменной среды `HCLOUD_ENDPOINT`. По умолчанию: `"https://api.hetzner.cloud/v1"`
api_endpoint_hetzner string	Конечная точка API Hetzner. Этот параметр также можно задать с помощью переменной среды `HETZNER_ENDPOINT`. По умолчанию: `"https://api.hetzner.com/v1"`
api_token string / обязательный	Токен для API Hetzner Cloud. Этот параметр также можно задать с помощью переменной среды `HCLOUD_TOKEN`.
id integer	ID субаккаунта Storage Box, который нужно получить. Если ID недействителен, выполнение модуля завершится ошибкой.
label_selector string	Селектор меток для фильтрации получаемых субаккаунтов Storage Box.
name string	Имя субаккаунта Storage Box, который нужно получить.
storage_box string / обязательный	ID или имя родительского Storage Box. Предпочтительно использовать ID, чтобы сократить количество запросов к API.

См. также

Документация по API Hetzner: Полный справочник по API Hetzner.

Примеры

- name: Gather all Storage Box Subaccounts
  hetzner.hcloud.storage_box_subaccount_info:
  register: output

- name: Gather Storage Box Subaccounts by label
  hetzner.hcloud.storage_box_subaccount_info:
    label_selector: env=prod
  register: output

- name: Gather a Storage Box Subaccount by name
  hetzner.hcloud.storage_box_subaccount_info:
    name: subaccount1
  register: output

- name: Gather a Storage Box Subaccount by id
  hetzner.hcloud.storage_box_subaccount_info:
    name: 12345
  register: output

- name: Print the gathered infos
  debug:
    var: output.hcloud_storage_box_subaccount_info

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

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

Ключ	Описание
hcloud_storage_box_subaccount_info list / элементы=dictionary	Список субаккаунтов Storage Box. Возвращается: всегда
access_settings dictionary	Настройки доступа субаккаунта Storage Box. Возвращается: всегда
reachable_externally boolean	Разрешён ли доступ извне сети Hetzner. Возвращается: всегда Пример: `false`
readonly boolean	Доступен ли субаккаунт только для чтения. Возвращается: всегда Пример: `false`
samba_enabled boolean	Включена ли подсистема Samba. Возвращается: всегда Пример: `false`
ssh_enabled boolean	Включена ли подсистема SSH. Возвращается: всегда Пример: `true`
webdav_enabled boolean	Включена ли подсистема WebDAV. Возвращается: всегда Пример: `false`
created string	Дата и время создания субаккаунта Storage Box (в формате RFC3339). Возвращается: всегда Пример: `"2025-12-03T13:47:47Z"`
description string	Описание субаккаунта Storage Box. Возвращается: всегда Пример: `"backups from subaccount1"`
home_directory string	Домашний каталог субаккаунта Storage Box. Возвращается: всегда Пример: `"backups/subaccount1"`
id integer	ID субаккаунта Storage Box. Возвращается: всегда Пример: `158045`
labels dictionary	Пользовательские метки (пары «ключ — значение») субаккаунта Storage Box. Возвращается: всегда Пример: `{"env": "prod"}`
name string	Имя субаккаунта Storage Box. Возвращается: всегда Пример: `"subaccount1"`
server string	Полное доменное имя (FQDN) субаккаунта Storage Box. Возвращается: всегда Пример: `"u514605-sub1.your-storagebox.de"`
storage_box integer	ID родительского Storage Box. Возвращается: всегда Пример: `514605`
username string	Имя пользователя субаккаунта Storage Box. Возвращается: всегда Пример: `"u514605-sub1"`

Авторы

Jonas Lammler (@jooola)

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

© 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/hetzner/hcloud/storage_box_subaccount_info_module.html