4 .. _storage_disk_management:
9 .. image:: images/screenshots/pbs-gui-disks.png
13 Proxmox Backup Server comes with a set of disk utilities, which are
14 accessed using the ``disk`` subcommand. This subcommand allows you to initialize
15 disks, create various filesystems, and get information about the disks.
17 To view the disks connected to the system, navigate to **Administration ->
18 Disks** in the web interface or use the ``list`` subcommand of
21 .. code-block:: console
23 # proxmox-backup-manager disk list
24 ┌──────┬────────┬─────┬───────────┬─────────────┬───────────────┬─────────┬────────┐
25 │ name │ used │ gpt │ disk-type │ size │ model │ wearout │ status │
26 ╞══════╪════════╪═════╪═══════════╪═════════════╪═══════════════╪═════════╪════════╡
27 │ sda │ lvm │ 1 │ hdd │ 34359738368 │ QEMU_HARDDISK │ - │ passed │
28 ├──────┼────────┼─────┼───────────┼─────────────┼───────────────┼─────────┼────────┤
29 │ sdb │ unused │ 1 │ hdd │ 68719476736 │ QEMU_HARDDISK │ - │ passed │
30 ├──────┼────────┼─────┼───────────┼─────────────┼───────────────┼─────────┼────────┤
31 │ sdc │ unused │ 1 │ hdd │ 68719476736 │ QEMU_HARDDISK │ - │ passed │
32 └──────┴────────┴─────┴───────────┴─────────────┴───────────────┴─────────┴────────┘
34 To initialize a disk with a new GPT, use the ``initialize`` subcommand:
36 .. code-block:: console
38 # proxmox-backup-manager disk initialize sdX
40 .. image:: images/screenshots/pbs-gui-disks-dir-create.png
42 :alt: Create a directory
44 You can create an ``ext4`` or ``xfs`` filesystem on a disk using ``fs
45 create``, or by navigating to **Administration -> Disks -> Directory** in the
46 web interface and creating one from there. The following command creates an
47 ``ext4`` filesystem and passes the ``--add-datastore`` parameter, in order to
48 automatically create a datastore on the disk (in this case ``sdd``). This will
49 create a datastore at the location ``/mnt/datastore/store1``:
51 .. code-block:: console
53 # proxmox-backup-manager disk fs create store1 --disk sdd --filesystem ext4 --add-datastore true
55 .. image:: images/screenshots/pbs-gui-disks-zfs-create.png
59 You can also create a ``zpool`` with various raid levels from **Administration
60 -> Disks -> Zpool** in the web interface, or by using ``zpool create``. The command
61 below creates a mirrored ``zpool`` using two disks (``sdb`` & ``sdc``) and
62 mounts it under ``/mnt/datastore/zpool1``:
64 .. code-block:: console
66 # proxmox-backup-manager disk zpool create zpool1 --devices sdb,sdc --raidlevel mirror
68 .. note:: You can also pass the ``--add-datastore`` parameter here, to automatically
69 create a datastore from the disk.
71 You can use ``disk fs list`` and ``disk zpool list`` to keep track of your
72 filesystems and zpools respectively.
74 Proxmox Backup Server uses the package smartmontools. This is a set of tools
75 used to monitor and control the S.M.A.R.T. system for local hard disks. If a
76 disk supports S.M.A.R.T. capability, and you have this enabled, you can
77 display S.M.A.R.T. attributes from the web interface or by using the command:
79 .. code-block:: console
81 # proxmox-backup-manager disk smart-attributes sdX
83 .. note:: This functionality may also be accessed directly through the use of
84 the ``smartctl`` command, which comes as part of the smartmontools package
85 (see ``man smartctl`` for more details).
93 A datastore refers to a location at which backups are stored. The current
94 implementation uses a directory inside a standard Unix file system (``ext4``,
95 ``xfs`` or ``zfs``) to store the backup data.
97 Datastores are identified by a simple *ID*. You can configure this
98 when setting up the datastore. The configuration information for datastores
99 is stored in the file ``/etc/proxmox-backup/datastore.cfg``.
101 .. note:: The `File Layout`_ requires the file system to support at least *65538*
102 subdirectories per directory. That number comes from the 2\ :sup:`16`
103 pre-created chunk namespace directories, and the ``.`` and ``..`` default
104 directory entries. This requirement excludes certain filesystems and
105 filesystem configuration from being supported for a datastore. For example,
106 ``ext3`` as a whole or ``ext4`` with the ``dir_nlink`` feature manually disabled.
109 Datastore Configuration
110 ~~~~~~~~~~~~~~~~~~~~~~~
112 .. image:: images/screenshots/pbs-gui-datastore-content.png
114 :alt: Datastore Overview
116 You can configure multiple datastores. Minimum one datastore needs to be
117 configured. The datastore is identified by a simple *name* and points to a
118 directory on the filesystem. Each datastore also has associated retention
119 settings of how many backup snapshots for each interval of ``hourly``,
120 ``daily``, ``weekly``, ``monthly``, ``yearly`` as well as a time-independent
121 number of backups to keep in that store. :ref:`backup-pruning` and
122 :ref:`garbage collection <client_garbage-collection>` can also be configured to run
123 periodically based on a configured schedule (see :ref:`calendar-event-scheduling`) per datastore.
126 .. _storage_datastore_create:
130 .. image:: images/screenshots/pbs-gui-datastore-create-general.png
132 :alt: Create a datastore
134 You can create a new datastore from the web interface, by clicking **Add
135 Datastore** in the side menu, under the **Datastore** section. In the setup
138 * *Name* refers to the name of the datastore
139 * *Backing Path* is the path to the directory upon which you want to create the
141 * *GC Schedule* refers to the time and intervals at which garbage collection
143 * *Prune Schedule* refers to the frequency at which pruning takes place
144 * *Prune Options* set the amount of backups which you would like to keep (see
145 :ref:`backup-pruning`).
146 * *Comment* can be used to add some contextual information to the datastore.
148 Alternatively you can create a new datastore from the command line. The
149 following command creates a new datastore called ``store1`` on :file:`/backup/disk1/store1`
151 .. code-block:: console
153 # proxmox-backup-manager datastore create store1 /backup/disk1/store1
159 To list existing datastores from the command line run:
161 .. code-block:: console
163 # proxmox-backup-manager datastore list
164 ┌────────┬──────────────────────┬─────────────────────────────┐
165 │ name │ path │ comment │
166 ╞════════╪══════════════════════╪═════════════════════════════╡
167 │ store1 │ /backup/disk1/store1 │ This is my default storage. │
168 └────────┴──────────────────────┴─────────────────────────────┘
170 You can change the garbage collection and prune settings of a datastore, by
171 editing the datastore from the GUI or by using the ``update`` subcommand. For
172 example, the below command changes the garbage collection schedule using the
173 ``update`` subcommand and prints the properties of the datastore with the
176 .. code-block:: console
178 # proxmox-backup-manager datastore update store1 --gc-schedule 'Tue 04:27'
179 # proxmox-backup-manager datastore show store1
180 ┌────────────────┬─────────────────────────────┐
182 ╞════════════════╪═════════════════════════════╡
184 ├────────────────┼─────────────────────────────┤
185 │ path │ /backup/disk1/store1 │
186 ├────────────────┼─────────────────────────────┤
187 │ comment │ This is my default storage. │
188 ├────────────────┼─────────────────────────────┤
189 │ gc-schedule │ Tue 04:27 │
190 ├────────────────┼─────────────────────────────┤
192 ├────────────────┼─────────────────────────────┤
193 │ prune-schedule │ daily │
194 └────────────────┴─────────────────────────────┘
196 Finally, it is possible to remove the datastore configuration:
198 .. code-block:: console
200 # proxmox-backup-manager datastore remove store1
202 .. note:: The above command removes only the datastore configuration. It does
203 not delete any data from the underlying directory.
209 After creating a datastore, the following default layout will appear:
211 .. code-block:: console
213 # ls -arilh /backup/disk1/store1
214 276493 -rw-r--r-- 1 backup backup 0 Jul 8 12:35 .lock
215 276490 drwxr-x--- 1 backup backup 1064960 Jul 8 12:35 .chunks
217 `.lock` is an empty file used for process locking.
219 The `.chunks` directory contains folders, starting from `0000` and taking hexadecimal values until `ffff`. These
220 directories will store the chunked data after a backup operation has been executed.
222 .. code-block:: console
224 # ls -arilh /backup/disk1/store1/.chunks
225 545824 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 ffff
226 545823 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 fffe
227 415621 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 fffd
228 415620 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 fffc
229 353187 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 fffb
230 344995 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 fffa
231 144079 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 fff9
232 144078 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 fff8
233 144077 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 fff7
235 403180 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 000c
236 403179 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 000b
237 403177 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 000a
238 402530 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 0009
239 402513 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 0008
240 402509 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 0007
241 276509 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 0006
242 276508 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 0005
243 276507 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 0004
244 276501 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 0003
245 276499 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 0002
246 276498 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 0001
247 276494 drwxr-x--- 2 backup backup 4.0K Jul 8 12:35 0000
248 276489 drwxr-xr-x 3 backup backup 4.0K Jul 8 12:35 ..
249 276490 drwxr-x--- 1 backup backup 1.1M Jul 8 12:35 .