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.

encrypted-only<boolean>

Only synchronize encrypted backup snapshots, exclude others.

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.

run-on-mount<boolean>

Run this job when a relevant datastore is mounted.

schedule<calendar-event>

Run sync job at specified schedule.

sync-directionpull|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

unmount-on-done<boolean>

Unmount involved removable datastore after the sync job finishes. Requires 'run-on-mount' to be enabled.

verified-only<boolean>

Only synchronize verified backup snapshots, exclude 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, ...).