]> git.proxmox.com Git - pmg-docs.git/blobdiff - pmgbackup.1-synopsis.adoc
buildsys: drop bogus and unused NOVIEW variable
[pmg-docs.git] / pmgbackup.1-synopsis.adoc
index e435f7125d969d01b7725eb181b39c48b7fd80d0..a00499587bfa21dfbcfaa7bc837a83dfe9f36ba0 100644 (file)
@@ -4,6 +4,10 @@
 
 Backup the system configuration.
 
+`--notify` `<always | error | never>` ('default =' `never`)::
+
+Specify when to notify via e-mail
+
 `--statistic` `<boolean>` ('default =' `1`)::
 
 Backup statistic databases.
@@ -24,6 +28,262 @@ Verbose output format.
 
 List all stored backups (files named proxmox-backup_{DATE}.tgz).
 
+*pmgbackup proxmox-backup backup* `<remote>` `[OPTIONS]`
+
+Create a new backup and prune the backup group afterwards, if configured.
+
+`<remote>`: `<string>` ::
+
+Proxmox Backup Server ID.
+
+`--notify` `<always | error | never>` ('default =' `never`)::
+
+Specify when to notify via e-mail
+
+`--statistic` `<boolean>` ('default =' `1`)::
+
+Backup statistic databases.
+
+*pmgbackup proxmox-backup forget* `<remote> <backup-id> <backup-time>`
+
+Forget a snapshot
+
+`<remote>`: `<string>` ::
+
+Proxmox Backup Server ID.
+
+`<backup-id>`: `<string>` ::
+
+ID (hostname) of backup snapshot
+
+`<backup-time>`: `<string>` ::
+
+Backup time in RFC 3339 format
+
+*pmgbackup proxmox-backup job create* `<remote>` `[OPTIONS]`
+
+Create backup schedule
+
+`<remote>`: `<string>` ::
+
+Proxmox Backup Server ID.
+
+`--delay` `[0-9a-zA-Z. ]+` ('default =' `5min`)::
+
+Randomized delay to add to the starttime (RandomizedDelaySec setting of the systemd.timer)
+
+`--schedule` `[0-9a-zA-Z*.:,\-/ ]+` ('default =' `daily`)::
+
+Schedule for the backup (OnCalendar setting of the systemd.timer)
+
+*pmgbackup proxmox-backup job delete* `<remote>`
+
+Delete backup schedule
+
+`<remote>`: `<string>` ::
+
+Proxmox Backup Server ID.
+
+*pmgbackup proxmox-backup job show* `<remote>` `[FORMAT_OPTIONS]`
+
+Get timer specification
+
+`<remote>`: `<string>` ::
+
+Proxmox Backup Server ID.
+
+*pmgbackup proxmox-backup list* `<remote>` `[FORMAT_OPTIONS]`
+
+Get snapshots stored on remote.
+
+`<remote>`: `<string>` ::
+
+Proxmox Backup Server ID.
+
+*pmgbackup proxmox-backup remote add* `<remote> --datastore <string> --server <string>` `[OPTIONS]`
+
+Add Proxmox Backup Server remote instance.
+
+`<remote>`: `<string>` ::
+
+Proxmox Backup Server ID.
+
+`--datastore` `(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)` ::
+
+Proxmox Backup Server datastore name.
+
+`--disable` `<boolean>` ::
+
+Flag to disable (deactivate) the entry.
+
+`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
+
+Certificate SHA 256 fingerprint.
+
+`--include-statistics` `<boolean>` ::
+
+Include statistics in scheduled backups
+
+`--keep-daily` `<N>` ::
+
+Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept.
+
+`--keep-hourly` `<N>` ::
+
+Keep backups for the last <N> different hours. If there is more than one backup for a single hour, only the latest one is kept.
+
+`--keep-last` `<N>` ::
+
+Keep the last <N> backups.
+
+`--keep-monthly` `<N>` ::
+
+Keep backups for the last <N> different months. If there is more than one backup for a single month, only the latest one is kept.
+
+`--keep-weekly` `<N>` ::
+
+Keep backups for the last <N> different weeks. If there ismore than one backup for a single week, only the latest one is kept.
+
+`--keep-yearly` `<N>` ::
+
+Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.
+
+`--namespace` `(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*))?` ::
+
+Proxmox Backup Server namespace in the datastore, defaults to the root NS.
+
+`--notify` `<always | error | never>` ::
+
+Specify when to notify via e-mail
+
+`--password` `<password>` ::
+
+Password or API token secret for the user on the Proxmox Backup Server.
+
+`--server` `<string>` ::
+
+Proxmox Backup Server address.
+
+`--username` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::
+
+Username or API token ID on the Proxmox Backup Server
+
+*pmgbackup proxmox-backup remote list* `[FORMAT_OPTIONS]`
+
+List all configured Proxmox Backup Server instances.
+
+*pmgbackup proxmox-backup remote remove* `<remote>`
+
+Delete an PBS remote
+
+`<remote>`: `<string>` ::
+
+Profile ID.
+
+*pmgbackup proxmox-backup remote set* `<remote>` `[OPTIONS]`
+
+Update PBS remote settings.
+
+`<remote>`: `<string>` ::
+
+Proxmox Backup Server ID.
+
+`--datastore` `(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)` ::
+
+Proxmox Backup Server datastore name.
+
+`--delete` `<string>` ::
+
+A list of settings you want to delete.
+
+`--digest` `<string>` ::
+
+Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
+
+`--disable` `<boolean>` ::
+
+Flag to disable (deactivate) the entry.
+
+`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
+
+Certificate SHA 256 fingerprint.
+
+`--include-statistics` `<boolean>` ::
+
+Include statistics in scheduled backups
+
+`--keep-daily` `<N>` ::
+
+Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept.
+
+`--keep-hourly` `<N>` ::
+
+Keep backups for the last <N> different hours. If there is more than one backup for a single hour, only the latest one is kept.
+
+`--keep-last` `<N>` ::
+
+Keep the last <N> backups.
+
+`--keep-monthly` `<N>` ::
+
+Keep backups for the last <N> different months. If there is more than one backup for a single month, only the latest one is kept.
+
+`--keep-weekly` `<N>` ::
+
+Keep backups for the last <N> different weeks. If there ismore than one backup for a single week, only the latest one is kept.
+
+`--keep-yearly` `<N>` ::
+
+Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.
+
+`--namespace` `(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*)/){0,7}(?:(?:[A-Za-z0-9_][A-Za-z0-9._\-]*))?` ::
+
+Proxmox Backup Server namespace in the datastore, defaults to the root NS.
+
+`--notify` `<always | error | never>` ::
+
+Specify when to notify via e-mail
+
+`--password` `<password>` ::
+
+Password or API token secret for the user on the Proxmox Backup Server.
+
+`--server` `<string>` ::
+
+Proxmox Backup Server address.
+
+`--username` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::
+
+Username or API token ID on the Proxmox Backup Server
+
+*pmgbackup proxmox-backup restore* `<remote> <backup-id> <backup-time>` `[OPTIONS]`
+
+Restore the system configuration.
+
+`<remote>`: `<string>` ::
+
+Proxmox Backup Server ID.
+
+`<backup-id>`: `<string>` ::
+
+backup-id (hostname) of backup snapshot
+
+`<backup-time>`: `<string>` ::
+
+backup-time to restore
+
+`--config` `<boolean>` ('default =' `0`)::
+
+Restore system configuration.
+
+`--database` `<boolean>` ('default =' `1`)::
+
+Restore the rule database. This is the default.
+
+`--statistic` `<boolean>` ('default =' `0`)::
+
+Restore statistic databases. Only considered when you restore the 'database'.
+
 *pmgbackup restore* `--filename <string>` `[OPTIONS]`
 
 Restore the system configuration.