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 (single line).

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

Maintenance type.

message = <string>

Message describing the reason for the maintenance.

notify[[gc=<enum>] [,sync=<enum>] [,verify=<enum>]]

Datastore notification setting

gc = 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>]]

Datastore tuning options

chunk-order = none|inode

The order to sort chunks by

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.