Spec-Zone.ru › Ansible

Модуль hetzner.hcloud.storage_box — создание и управление 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.

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

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

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

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

Требования

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

  • python-dateutil >= 2.7.5
  • requests >=2.20

Параметры

Параметр

Комментарии

access_settings

dictionary

Параметры доступа к Storage Box.

reachable_externally

boolean

Разрешен ли доступ извне сети Hetzner.

Варианты:

  • false ← (по умолчанию)
  • true

samba_enabled

boolean

Включена ли подсистема Samba.

Варианты:

  • false ← (по умолчанию)
  • true

ssh_enabled

boolean

Включена ли подсистема SSH.

Варианты:

  • false ← (по умолчанию)
  • true

webdav_enabled

boolean

Включена ли подсистема WebDAV.

Варианты:

  • false ← (по умолчанию)
  • true

zfs_enabled

boolean

Отображается ли папка снимков ZFS.

Варианты:

  • false ← (по умолчанию)
  • true

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.

delete_protection

boolean

Защитить Storage Box от удаления.

Варианты:

  • false
  • true

id

integer

ID Storage Box, которым нужно управлять.

Обязателен, если не указано name Storage Box.

Если указан неверный ID, модуль завершится с ошибкой.

labels

dictionary

Пользовательские метки (пары ключ-значение) для Storage Box.

location

string

Название или ID местоположения Storage Box.

Обязательно, если Storage Box не существует.

name

string

Название Storage Box, которым нужно управлять.

Обязательно, если не указано id Storage Box.

Обязательно, если Storage Box не существует.

password

string

Пароль для Storage Box.

Обязательно, если Storage Box не существует.

snapshot

string

ID или название снимка, к которому нужно выполнить откат.

Используется только при state=rollback_snapshot

snapshot_plan

dictionary

План создания снимков для Storage Box.

Укажите null, чтобы отключить план создания снимков.

day_of_month

integer

День месяца, в который выполняется план создания снимков.

Значение null означает каждый день.

day_of_week

integer

День недели, в который выполняется план создания снимков.

От 1 для понедельника до 7 для воскресенья.

Значение null означает каждый день.

hour

integer / обязательный

Час выполнения плана создания снимков (UTC).

max_snapshots

integer / обязательный

Максимальное количество снимков, создаваемых этим планом.

Старые снимки будут удалены.

minute

integer / обязательный

Минута выполнения плана создания снимков (UTC).

ssh_keys

list / elements=string

Открытые ключи SSH в формате OpenSSH для добавления в Storage Box.

state

string

Состояние Storage Box.

reset_password и rollback_snapshot не являются идемпотентными.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "reset_password"
  • "rollback_snapshot"

storage_box_type

псевдонимы: type

string

Название или ID типа Storage Box.

Обязательно, если Storage Box не существует.

См. также

См. также

Документация по API Hetzner

Полный справочник по API Hetzner.

Примеры

- name: Create a Storage Box
  hetzner.hcloud.storage_box:
    name: my-storage-box
    storage_box_type: bx11
    location: fsn1
    password: my-secret
    labels:
      env: prod
    state: present

- name: Create a Storage Box with access settings
  hetzner.hcloud.storage_box:
    name: my-storage-box
    storage_box_type: bx11
    location: fsn1
    password: my-secret
    access_settings:
      reachable_externally: true
      ssh_enabled: true
      samba_enabled: false
      webdav_enabled: false
      zfs_enabled: false
    state: present

- name: Create a Storage Box with snapshot plan
  hetzner.hcloud.storage_box:
    name: my-storage-box
    storage_box_type: bx11
    location: fsn1
    password: my-secret
    snapshot_plan:
      max_snapshots: 10
      hour: 3
      minute: 30
    state: present

- name: Disable a Storage Box snapshot plan
  hetzner.hcloud.storage_box:
    name: my-storage-box
    snapshot_plan: null
    state: present

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

- name: Rollback a Storage Box to a Snapshot
  hetzner.hcloud.storage_box:
    name: my-storage-box
    snapshot: 2025-12-03T13-47-47
    state: rollback_snapshot

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

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

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

Ключ

Описание

hcloud_storage_box

dictionary

Сведения о Storage Box.

Возвращается: всегда

access_settings

dictionary

Параметры доступа к Storage Box.

Возвращается: всегда

reachable_externally

boolean

Разрешён ли доступ извне сети Hetzner.

Возвращается: всегда

Пример: false

samba_enabled

boolean

Включена ли подсистема Samba.

Возвращается: всегда

Пример: false

ssh_enabled

boolean

Включена ли подсистема SSH.

Возвращается: всегда

Пример: true

webdav_enabled

boolean

Включена ли подсистема WebDAV.

Возвращается: всегда

Пример: false

zfs_enabled

boolean

Отображается ли папка снимков ZFS.

Возвращается: всегда

Пример: false

delete_protection

boolean

Защищает Storage Box от удаления.

Возвращается: всегда

Пример: false

id

integer

Идентификатор Storage Box.

Возвращается: всегда

Пример: 1937415

labels

dictionary

Метки Storage Box, заданные пользователем (пары «ключ — значение»).

Возвращается: всегда

Пример: {"env": "prod"}

location

string

Название местоположения Storage Box.

Возвращается: всегда

Пример: "fsn1"

name

string

Название Storage Box.

Возвращается: всегда

Пример: "my-storage-box"

server

string

Полное доменное имя Storage Box (FQDN).

Возвращается: всегда

Пример: "u505337.your-storagebox.de"

snapshot_plan

dictionary

План создания снимков Storage Box.

Возвращается: если включён

day_of_month

integer

День месяца, в который выполняется план создания снимков. Значение Null означает каждый день.

Возвращается: всегда

Пример: 30

day_of_week

integer

День недели, в который выполняется план создания снимков. Значение Null означает каждый день.

Возвращается: всегда

Пример: 1

hour

integer

Час выполнения плана создания снимков (UTC).

Возвращается: всегда

Пример: 3

max_snapshots

integer

Максимальное количество снимков, создаваемых этим планом.

Возвращается: всегда

Пример: 10

minute

integer

Минута выполнения плана создания снимков (UTC).

Возвращается: всегда

Пример: 30

stats

dictionary

Статистика Storage Box.

Возвращается: всегда

size

integer

Текущее использование диска в байтах.

Возвращается: всегда

Пример: 10485760

size_data

integer

Текущее использование диска данными в байтах.

Возвращается: всегда

Пример: 10485760

size_snapshots

integer

Текущее использование диска снимками в байтах.

Возвращается: всегда

Пример: 10485760

status

string

Статус Storage Box.

Возвращается: всегда

Пример: "active"

storage_box_type

string

Название типа Storage Box.

Возвращается: всегда

Пример: "bx11"

system

string

Хост-система Storage Box.

Возвращается: всегда

Пример: "HEL1-BX136"

username

string

Имя пользователя Storage Box.

Возвращается: всегда

Пример: "u505337"

Авторы

  • Jonas Lammler (@jooola)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Справочник по API Hetzner Cloud
  • Журнал изменений API Hetzner Cloud

© 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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API