datastore.cfg¶
Description¶
The file /etc/proxmox-backup/datastore.cfg is a configuration file for Proxmox Backup Server. It contains the Datastore configuration.
File Format¶
This file contains a list of datastore configuration sections. Each
section starts with the header datastore: <name>
, followed by the
datastore configuration options.
datastore: <name1>
path <path1>
<option1> <value1>
...
datastore: <name2>
path <path2>
...
You can use the proxmox-backup-manager datastore
command to manipulate
this file.
Options¶
Required properties:
path
<string>
Directory name
Optional properties:
comment
<string>
Comment.
gc-schedule
<calendar-event>
Run garbage collection job at specified schedule.
maintenance-mode
[type=<enum> [,message=<string>]]
Maintenance mode, type is either 'offline' or 'read-only', message should be enclosed in "
type
=read-only|offline|delete
Maintenance type.
message
=<string>
Message describing the reason for the maintenance.
notification-mode
legacy-sendmail|notification-system (default=legacy-sendmail)
Configure how notifications for this datastore should be sent. legacy- sendmail sends email notifications to the user configured in notify-user via the system's sendmail executable. notification-system emits matchable notification events to the notification system.
notify
[[gc=<enum>] [,prune=<enum>] [,sync=<enum>] [,verify=<enum>]]
Datastore notification setting, enum can be one of 'always', 'never', or 'error'.
gc
=never|always|error
When do we send notifications
prune
=never|always|error
When do we send notifications
sync
=never|always|error
When do we send notifications
verify
=never|always|error
When do we send notifications
notify-user
<string>
User ID
prune-schedule
<calendar-event>
Run prune job at specified schedule.
tuning
[[chunk-order=<enum>] [,sync-level=<enum>]]
- Datastore tuning options
chunk-order
=none|inode (default=inode)
The order to sort chunks by
sync-level
=none|file|filesystem (default=filesystem)
The level of syncing that is done when writing into a datastore.
- Datastore tuning options
verify-new
<boolean>
If enabled, all new backups will be verified right after completion.
keep-daily
<integer> (1 - N)
Number of daily backups to keep.
keep-hourly
<integer> (1 - N)
Number of hourly backups to keep.
keep-last
<integer> (1 - N)
Number of backups to keep.
keep-monthly
<integer> (1 - N)
Number of monthly backups to keep.
keep-weekly
<integer> (1 - N)
Number of weekly backups to keep.
keep-yearly
<integer> (1 - N)
Number of yearly backups to keep.
Copyright and Disclaimer¶
Copyright (C) 2019-2023, Proxmox Server Solutions GmbH
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/