Interface nodesVzdumpDefaultsDefaults

Returned by GET /nodes/{node}/vzdump/defaults

Hierarchy

  • nodesVzdumpDefaultsDefaults

Indexable

[additionalProperties: string]: any

Properties

all?: boolean

Backup all known guest systems on this host.

bwlimit?: number

Limit I/O bandwidth (KBytes per second).

compress?: string

Compress dump file.

dumpdir?: string

Store resulting files to specified directory.

exclude?: string

Exclude specified guest systems (assumes --all)

exclude-path?: string

Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.

ionice?: number

Set CFQ ionice priority.

lockwait?: number

Maximal time to wait for the global lock (minutes).

mailnotification?: string

Specify when to send an email

mailto?: string

Comma-separated list of email addresses or users that should receive email notifications.

maxfiles?: number

Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system.

mode?: string

Backup mode.

node?: string

Only run if executed on this node.

pigz?: number

Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.

pool?: string

Backup all known guest systems included in the specified pool.

prune-backups?: string

Use these retention options instead of those from the storage configuration.

quiet?: boolean

Be quiet.

remove?: boolean

Prune older backups according to 'prune-backups'.

script?: string

Use specified hook script.

stdexcludes?: boolean

Exclude temporary files and logs.

stop?: boolean

Stop running backup jobs on this host.

stopwait?: number

Maximal time to wait until a guest system is stopped (minutes).

storage?: string

Store resulting file to this storage.

tmpdir?: string

Store temporary files to specified directory.

vmid?: string

The ID of the guest system you want to backup.

zstd?: number

Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count.

Generated using TypeDoc