pbs: fix password and encryption key file location

[pve-docs.git] / pvesm.1-synopsis.adoc

diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc
index c7d427108771e42564afa35f3479a593eb3aa9ec..af25db29f3d456f2958c33acce78677fc32653ed 100644 (file)
--- a/pvesm.1-synopsis.adoc
+++ b/pvesm.1-synopsis.adoc
@@ -4,7 +4,7 @@
 
 Create a new storage.
 
-`<type>`: `<cephfs | cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | rbd | zfs | zfspool>` ::
+`<type>`: `<cephfs | cifs | dir | drbd | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | pbs | rbd | zfs | zfspool>` ::
 
 Storage type.
 
@@ -42,6 +42,10 @@ Allowed content types.
 +
 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 
+`--datastore` `<string>` ::
+
+Proxmox backup server datastore name.
+
 `--disable` `<boolean>` ::
 
 Flag to disable the storage.
@@ -50,10 +54,18 @@ Flag to disable the storage.
 
 CIFS domain.
 
+`--encryption-key` `a file containing an encryption key, or the special value "autogen"` ::
+
+Encryption key. Use 'autogen' to generate one automatically without passphrase.
+
 `--export` `<string>` ::
 
 NFS export path.
 
+`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
+
+Certificate SHA 256 fingerprint.
+
 `--format` `<string>` ::
 
 Default image format.
@@ -90,6 +102,10 @@ Create the directory if it doesn't exist.
 
 IP addresses of monitors (for external clusters).
 
+`--mountpoint` `<string>` ::
+
+mount point
+
 `--nodes` `<string>` ::
 
 List of cluster node names.
@@ -104,7 +120,7 @@ NFS mount options (see 'man nfs')
 
 `--password` `<password>` ::
 
-Password for CIFS share.
+Password for accessing the share/datastore.
 
 `--path` `<string>` ::
 
@@ -118,6 +134,10 @@ Pool.
 
 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>]` ::
+
+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.
+
 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
 
 The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.
@@ -214,13 +234,17 @@ no description available
 +
 NOTE: Requires option(s): `size`
 
+*pvesm apiinfo*
+
+Returns APIVER and APIAGE.
+
 *pvesm cifsscan*
 
 An alias for 'pvesm scan cifs'.
 
 *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
 
-Export a volume.
+Used internally to export a volume.
 
 `<volume>`: `<string>` ::
 
@@ -262,6 +286,10 @@ Delete volume
 
 Volume identifier
 
+`--delay` `<integer> (1 - 30)` ::
+
+Time to wait for the task to finish. We return 'null' if the task finish within that time.
+
 `--storage` `<string>` ::
 
 The storage identifier.
@@ -284,7 +312,7 @@ Verbose output format.
 
 *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
 
-Import a volume.
+Used internally to import a volume.
 
 `<volume>`: `<string>` ::
 
@@ -296,7 +324,11 @@ Import stream format
 
 `<filename>`: `<string>` ::
 
-Source file name
+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.
+
+`--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})` ::
 
@@ -350,6 +382,30 @@ Get filesystem path for specified volume
 
 Volume identifier
 
+*pvesm prune-backups* `<storage>` `[OPTIONS]`
+
+Prune backups. This is only a wrapper for the proper API endpoints.
+
+`<storage>`: `<string>` ::
+
+The storage identifier.
+
+`--dry-run` `<boolean>` ::
+
+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>]` ::
+
+Use these retention options instead of those from the storage configuration.
+
+`--type` `<lxc | qemu>` ::
+
+Either 'qemu' or 'lxc'. Only consider backups for guests of this type.
+
+`--vmid` `<integer> (1 - N)` ::
+
+Only consider backups for this guest.
+
 *pvesm remove* `<storage>`
 
 Delete storage configuration.
@@ -464,6 +520,14 @@ Flag to disable the storage.
 
 CIFS domain.
 
+`--encryption-key` `a file containing an encryption key, or the special value "autogen"` ::
+
+Encryption key. Use 'autogen' to generate one automatically without passphrase.
+
+`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
+
+Certificate SHA 256 fingerprint.
+
 `--format` `<string>` ::
 
 Default image format.
@@ -496,6 +560,10 @@ Create the directory if it doesn't exist.
 
 IP addresses of monitors (for external clusters).
 
+`--mountpoint` `<string>` ::
+
+mount point
+
 `--nodes` `<string>` ::
 
 List of cluster node names.
@@ -508,14 +576,18 @@ disable write caching on the target
 
 NFS mount options (see 'man nfs')
 
-`--password` `<string>` ::
+`--password` `<password>` ::
 
-Password for CIFS share.
+Password for accessing the share/datastore.
 
 `--pool` `<string>` ::
 
 Pool.
 
+`--prune-backups` `[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.
+
 `--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
 
 The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster.