sync.cfg¶
Description¶
The file /etc/proxmox-backup/sync.cfg is a configuration file for Proxmox Backup Server. It contains the synchronization job configuration.
File Format¶
Each entry starts with the header sync: <name>
, followed by the
job configuration options.
sync: job1
store store1
remote-store store1
remote lina
sync: ...
You can use the proxmox-backup-manager sync-job
command to manipulate
this file.
Options¶
Required properties:
remote-store
<string>
Datastore name.
store
<string>
Datastore name.
Optional properties:
comment
<string>
Comment.
group-filter
[<exclude:|include:>]<type:<vm|ct|host>|group:GROUP|regex:RE>
List of group filters. Can be specified more than once.
max-depth
<integer> (0 - 7)
How many levels of namespaces should be operated on (0 == no recursion, empty == automatic full recursion, namespace depths reduce maximum allowed value)
ns
<string>
Namespace.
owner
<string>
Authentication ID
remote
<string>
Remote ID.
remote-ns
<string>
Namespace.
remove-vanished
<boolean> (default=false)
Delete vanished backups. This remove the local copy if the remote backup was deleted.
resync-corrupt
<boolean>
If the verification failed for a local snapshot, try to pull it again.
schedule
<calendar-event>
Run sync job at specified schedule.
sync-direction
pull|push (default=pull)
Direction of the sync job, push or pull
transfer-last
<integer> (1 - N)
Limit transfer to last N snapshots (per group), skipping others
burst-in
<string>
Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
burst-out
<string>
Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
rate-in
<string>
Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
rate-out
<string>
Byte size with optional unit (B, KB (base 10), MB, GB, ..., KiB (base 2), MiB, Gib, ...).
Copyright and Disclaimer¶
Copyright (C) 2019-2024, 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/