`--datastore` `<string>` ::
-Proxmox backup server datastore name.
+Proxmox Backup Server datastore name.
`--disable` `<boolean>` ::
target portal group for Linux LIO targets
+`--master-pubkey` `a file containing a PEM-formatted master public key` ::
+
+Base64-encoded, PEM-formatted public RSA key. Used tp encrypt a copy of the encryption-key which will be added to each encrypted backup.
+
`--maxfiles` `<integer> (0 - N)` ::
Maximal number of backup files per VM. Use '0' for unlimted.
mount point
+`--namespace` `<string>` ::
+
+RBD Namespace.
+
`--nodes` `<string>` ::
List of cluster node names.
Pool.
+`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+
+For non default port.
+
`--portal` `<string>` ::
iSCSI portal (IP or DNS name with optional port).
-`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
+`--prune-backups` `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.
Destination file name
-`--base` `(?^:[a-z0-9_\-]{1,40})` ::
+`--base` `(?^i:[a-z0-9_\-]{1,40})` ::
Snapshot to start an incremental stream from
-`--snapshot` `(?^:[a-z0-9_\-]{1,40})` ::
+`--snapshot` `(?^i:[a-z0-9_\-]{1,40})` ::
Snapshot to export
`<filename>`: `<string>` ::
-Source file name. For '-' stdin is used, the tcp://<IP-or-CIDR> format allows to use a TCP connection as input. Else, the file is treated as common file.
+Source file name. For '-' stdin is used, the tcp://<IP-or-CIDR> format allows to use a TCP connection, the unix://PATH-TO-SOCKET format a UNIX socket as input.Else, the file is treated as common file.
`--allow-rename` `<boolean>` ('default =' `0`)::
Choose a new volume ID if the requested volume ID already exists, instead of throwing an error.
-`--base` `(?^:[a-z0-9_\-]{1,40})` ::
+`--base` `(?^i:[a-z0-9_\-]{1,40})` ::
Base snapshot of an incremental stream
-`--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` ::
+`--delete-snapshot` `(?^i:[a-z0-9_\-]{1,80})` ::
A snapshot to delete on success
*pvesm prune-backups* `<storage>` `[OPTIONS]`
-Prune backups. This is only a wrapper for the proper API endpoints.
+Prune backups. Only those using the standard naming scheme are considered.
+If no keep options are specified, those from the storage configuration are
+used.
`<storage>`: `<string>` ::
Only show what would be pruned, don't delete anything.
-`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
+`--keep-all` `<boolean>` ::
+
+Keep all backups. Conflicts with the other options when true.
+
+`--keep-daily` `<N>` ::
+
+Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept.
+
+`--keep-hourly` `<N>` ::
-Use these retention options instead of those from the storage configuration.
+Keep backups for the last <N> different hours. If there is morethan 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 morethan 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 is morethan 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 morethan one backup for a single year, only the latest one is kept.
`--type` `<lxc | qemu>` ::
The server address (name or IP).
+*pvesm scan pbs* `<server> <username> --password <string>` `[OPTIONS]` `[FORMAT_OPTIONS]`
+
+Scan remote Proxmox Backup Server.
+
+`<server>`: `<string>` ::
+
+The server address (name or IP).
+
+`<username>`: `<string>` ::
+
+User-name or API token-ID.
+
+`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
+
+Certificate SHA 256 fingerprint.
+
+`--password` `<string>` ::
+
+User password or API token secret.
+
+`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+
+Optional port.
+
*pvesm scan zfs*
Scan zfs pool list on local node.
target portal group for Linux LIO targets
+`--master-pubkey` `a file containing a PEM-formatted master public key` ::
+
+Base64-encoded, PEM-formatted public RSA key. Used tp encrypt a copy of the encryption-key which will be added to each encrypted backup.
+
`--maxfiles` `<integer> (0 - N)` ::
Maximal number of backup files per VM. Use '0' for unlimted.
mount point
+`--namespace` `<string>` ::
+
+RBD Namespace.
+
`--nodes` `<string>` ::
List of cluster node names.
Pool.
-`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
+`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+
+For non default port.
+
+`--prune-backups` `[keep-all=<1|0>] [,keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.
projects / pve-docs.git / blobdiff