Модуль hetzner.hcloud.storage_box_subaccount — создание и управление субаккаунтами Storage Box в Hetzner.

Примечание

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

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

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

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

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

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

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

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

Требования

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

python-dateutil >= 2.7.5
requests >=2.20

Параметры

Параметр	Комментарии
access_settings словарь	Параметры доступа субаккаунта Storage Box.
reachable_externally логический	Разрешён ли доступ из-за пределов сети Hetzner. Варианты: `false` ← (по умолчанию) `true`
readonly логический	Доступ к субаккаунту только для чтения. Варианты: `false` ← (по умолчанию) `true`
samba_enabled логический	Включена ли подсистема Samba. Варианты: `false` ← (по умолчанию) `true`
ssh_enabled логический	Включена ли подсистема SSH. Варианты: `false` ← (по умолчанию) `true`
webdav_enabled логический	Включена ли подсистема WebDAV. Варианты: `false` ← (по умолчанию) `true`
api_endpoint псевдонимы: endpoint строка	Конечная точка API Hetzner Cloud. Это значение также можно задать с помощью переменной окружения `HCLOUD_ENDPOINT`. По умолчанию: `"https://api.hetzner.cloud/v1"`
api_endpoint_hetzner строка	Конечная точка API Hetzner. Это значение также можно задать с помощью переменной окружения `HETZNER_ENDPOINT`. По умолчанию: `"https://api.hetzner.com/v1"`
api_token строка / обязательный	Токен для API Hetzner Cloud. Это значение также можно задать с помощью переменной окружения `HCLOUD_TOKEN`.
description строка	Описание субаккаунта Storage Box.
home_directory строка	Домашний каталог субаккаунта Storage Box. Обязательный параметр, если субаккаунт Storage Box не существует.
id целое число	Идентификатор субаккаунта Storage Box, которым нужно управлять. Обязателен, если не указан `name` субаккаунта Storage Box. Если идентификатор недействителен, выполнение модуля завершится с ошибкой.
labels словарь	Пользовательские метки (пары ключ-значение) для субаккаунта Storage Box.
name строка	Имя субаккаунта Storage Box, которым нужно управлять. Обязательно, если не указан `id` субаккаунта Storage Box. Обязательно, если субаккаунт Storage Box не существует.
password строка	Пароль субаккаунта Storage Box. Обязателен, если субаккаунт Storage Box не существует или если выполняется `state=reset_password`.
state строка	Состояние субаккаунта Storage Box. `reset_password` не обеспечивает идемпотентность. Варианты: `"absent"` `"present"` ← (по умолчанию) `"reset_password"`
storage_box строка / обязательный	Идентификатор или имя родительского Storage Box. Рекомендуется использовать идентификатор, чтобы сократить количество запросов к API.

См. также

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

Примеры

- name: Create a Storage Box Subaccount
  hetzner.hcloud.storage_box_subaccount:
    storage_box: my-storage-box
    name: subaccount1
    home_directory: backups/subaccount1
    password: secret
    access_settings:
      reachable_externally: false
      ssh_enabled: true
      samba_enabled: false
      webdav_enabled: false
      readonly: false
    labels:
      env: prod
    state: present

- name: Reset a Storage Box Subaccount password
  hetzner.hcloud.storage_box_subaccount:
    storage_box: my-storage-box
    name: subaccount1
    password: secret
    state: reset_password

- name: Delete a Storage Box Subaccount by name
  hetzner.hcloud.storage_box_subaccount:
    storage_box: my-storage-box
    name: subaccount1
    state: absent

- name: Delete a Storage Box Subaccount by id
  hetzner.hcloud.storage_box_subaccount:
    storage_box: 497436
    id: 158045
    state: absent

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

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

Ключ	Описание
hcloud_storage_box_subaccount словарь	Сведения о субаккаунте Storage Box. Возвращается: всегда
access_settings словарь	Параметры доступа субаккаунта Storage Box. Возвращается: всегда
reachable_externally логический	Разрешён ли доступ из-за пределов сети Hetzner. Возвращается: всегда Пример: `false`
readonly логический	Доступ к субаккаунту только для чтения. Возвращается: всегда Пример: `false`
samba_enabled логический	Включена ли подсистема Samba. Возвращается: всегда Пример: `false`
ssh_enabled логический	Включена ли подсистема SSH. Возвращается: всегда Пример: `true`
webdav_enabled логический	Включена ли подсистема WebDAV. Возвращается: всегда Пример: `false`
created строка	Время создания субаккаунта Storage Box (в формате RFC3339). Возвращается: всегда Пример: `"2025-12-03T13:47:47Z"`
description строка	Описание субаккаунта Storage Box. Возвращается: всегда Пример: `"backups from subaccount1"`
home_directory строка	Домашний каталог субаккаунта Storage Box. Возвращается: всегда Пример: `"backups/subaccount1"`
id целое число	Идентификатор субаккаунта Storage Box. Возвращается: всегда Пример: `158045`
labels словарь	Пользовательские метки (пары ключ-значение) субаккаунта Storage Box. Возвращается: всегда Пример: `{"env": "prod"}`
name строка	Имя субаккаунта Storage Box. Возвращается: всегда Пример: `"subaccount1"`
server строка	Полное доменное имя субаккаунта Storage Box (FQDN). Возвращается: всегда Пример: `"u514605-sub1.your-storagebox.de"`
storage_box целое число	Идентификатор родительского Storage Box. Возвращается: всегда Пример: `497436`
username строка	Имя пользователя субаккаунта 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_module.html