totp: fix copy/paste mistake

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

diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc
index d322974befbb25b5ed1227731c43c50ef8c2fd1f..e5f885f21f726e003e83ccea2f5a43161865d03d 100644 (file)
--- a/pvesm.1-synopsis.adoc
+++ b/pvesm.1-synopsis.adoc
@@ -4,11 +4,11 @@
 
 Create a new storage.
 
-`<type>`: `<btrfs | cephfs | cifs | dir | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | pbs | rbd | zfs | zfspool>` ::
+`<type>`: `<btrfs | cephfs | cifs | dir | esxi | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | pbs | rbd | zfs | zfspool>` ::
 
 Storage type.
 
-`<storage>`: `<string>` ::
+`<storage>`: `<storage ID>` ::
 
 The storage identifier.
 
@@ -26,7 +26,7 @@ block size
 
 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
 
-Set bandwidth/io limits various operations.
+Set I/O bandwidth limit for various operations (in KiB/s).
 
 `--comstar_hg` `<string>` ::
 
@@ -42,6 +42,22 @@ Allowed content types.
 +
 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 
+`--content-dirs` `<string>` ::
+
+Overrides for default content type directories.
+
+`--create-base-path` `<boolean>` ('default =' `yes`)::
+
+Create the base directory if it doesn't exist.
+
+`--create-subdirs` `<boolean>` ('default =' `yes`)::
+
+Populate the directory with the default structure.
+
+`--data-pool` `<string>` ::
+
+Data Pool (for erasure coding only)
+
 `--datastore` `<string>` ::
 
 Proxmox Backup Server datastore name.
@@ -102,13 +118,17 @@ target portal group for Linux LIO targets
 
 Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup.
 
+`--max-protected-backups` `<integer> (-1 - N)` ('default =' `Unlimited for users with Datastore.Allocate privilege, 5 for other users`)::
+
+Maximal number of protected backups per guest. Use '-1' for unlimited.
+
 `--maxfiles` `<integer> (0 - N)` ::
 
 Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.
 
 `--mkdir` `<boolean>` ('default =' `yes`)::
 
-Create the directory if it doesn't exist.
+Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE: Deprecated, use the 'create-base-path' and 'create-subdirs' options instead.
 
 `--monhost` `<string>` ::
 
@@ -120,7 +140,7 @@ mount point
 
 `--namespace` `<string>` ::
 
-RBD Namespace.
+Namespace.
 
 `--nocow` `<boolean>` ('default =' `0`)::
 
@@ -128,7 +148,7 @@ Set the NOCOW flag on files. Disables data checksumming and causes data errors t
 
 `--nodes` `<string>` ::
 
-List of cluster node names.
+List of nodes for which the storage configuration applies.
 
 `--nowritecache` `<boolean>` ::
 
@@ -136,7 +156,7 @@ disable write caching on the target
 
 `--options` `<string>` ::
 
-NFS mount options (see 'man nfs')
+NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')
 
 `--password` `<password>` ::
 
@@ -150,7 +170,7 @@ File system path.
 
 Pool.
 
-`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+`--port` `<integer> (1 - 65535)` ::
 
 For non default port.
 
@@ -190,7 +210,11 @@ CIFS share.
 
 `--shared` `<boolean>` ::
 
-Mark storage as shared.
+Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such!
+
+`--skip-cert-verification` `<boolean>` ('default =' `false`)::
+
+Disable TLS certificate verification, only enable on fully trusted networks!
 
 `--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`)::
 
@@ -236,11 +260,11 @@ Glusterfs Volume.
 
 Allocate disk images.
 
-`<storage>`: `<string>` ::
+`<storage>`: `<storage ID>` ::
 
 The storage identifier.
 
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
 
 Specify owner VM
 
@@ -318,7 +342,7 @@ Volume identifier
 
 Time to wait for the task to finish. We return 'null' if the task finish within that time.
 
-`--storage` `<string>` ::
+`--storage` `<storage ID>` ::
 
 The storage identifier.
 
@@ -382,7 +406,7 @@ An alias for 'pvesm scan iscsi'.
 
 List storage content.
 
-`<storage>`: `<string>` ::
+`<storage>`: `<storage ID>` ::
 
 The storage identifier.
 
@@ -390,7 +414,7 @@ The storage identifier.
 
 Only list content of this type.
 
-`--vmid` `<integer> (1 - N)` ::
+`--vmid` `<integer> (100 - 999999999)` ::
 
 Only list images for this VM
 
@@ -420,7 +444,7 @@ 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>` ::
+`<storage>`: `<storage ID>` ::
 
 The storage identifier.
 
@@ -460,7 +484,7 @@ Keep backups for the last <N> different years. If there is morethan one backup f
 
 Either 'qemu' or 'lxc'. Only consider backups for guests of this type.
 
-`--vmid` `<integer> (1 - N)` ::
+`--vmid` `<integer> (100 - 999999999)` ::
 
 Only consider backups for this guest.
 
@@ -468,7 +492,7 @@ Only consider backups for this guest.
 
 Delete storage configuration.
 
-`<storage>`: `<string>` ::
+`<storage>`: `<storage ID>` ::
 
 The storage identifier.
 
@@ -560,7 +584,7 @@ Scan zfs pool list on local node.
 
 Update storage configuration.
 
-`<storage>`: `<string>` ::
+`<storage>`: `<storage ID>` ::
 
 The storage identifier.
 
@@ -570,7 +594,7 @@ block size
 
 `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
 
-Set bandwidth/io limits various operations.
+Set I/O bandwidth limit for various operations (in KiB/s).
 
 `--comstar_hg` `<string>` ::
 
@@ -586,13 +610,29 @@ Allowed content types.
 +
 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 
+`--content-dirs` `<string>` ::
+
+Overrides for default content type directories.
+
+`--create-base-path` `<boolean>` ('default =' `yes`)::
+
+Create the base directory if it doesn't exist.
+
+`--create-subdirs` `<boolean>` ('default =' `yes`)::
+
+Populate the directory with the default structure.
+
+`--data-pool` `<string>` ::
+
+Data Pool (for erasure coding only)
+
 `--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.
+Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
 
 `--disable` `<boolean>` ::
 
@@ -642,13 +682,17 @@ target portal group for Linux LIO targets
 
 Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup.
 
+`--max-protected-backups` `<integer> (-1 - N)` ('default =' `Unlimited for users with Datastore.Allocate privilege, 5 for other users`)::
+
+Maximal number of protected backups per guest. Use '-1' for unlimited.
+
 `--maxfiles` `<integer> (0 - N)` ::
 
 Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.
 
 `--mkdir` `<boolean>` ('default =' `yes`)::
 
-Create the directory if it doesn't exist.
+Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE: Deprecated, use the 'create-base-path' and 'create-subdirs' options instead.
 
 `--monhost` `<string>` ::
 
@@ -660,7 +704,7 @@ mount point
 
 `--namespace` `<string>` ::
 
-RBD Namespace.
+Namespace.
 
 `--nocow` `<boolean>` ('default =' `0`)::
 
@@ -668,7 +712,7 @@ Set the NOCOW flag on files. Disables data checksumming and causes data errors t
 
 `--nodes` `<string>` ::
 
-List of cluster node names.
+List of nodes for which the storage configuration applies.
 
 `--nowritecache` `<boolean>` ::
 
@@ -676,7 +720,7 @@ disable write caching on the target
 
 `--options` `<string>` ::
 
-NFS mount options (see 'man nfs')
+NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')
 
 `--password` `<password>` ::
 
@@ -686,7 +730,7 @@ Password for accessing the share/datastore.
 
 Pool.
 
-`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+`--port` `<integer> (1 - 65535)` ::
 
 For non default port.
 
@@ -718,7 +762,11 @@ NOTE: Requires option(s): `server`
 
 `--shared` `<boolean>` ::
 
-Mark storage as shared.
+Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such!
+
+`--skip-cert-verification` `<boolean>` ('default =' `false`)::
+
+Disable TLS certificate verification, only enable on fully trusted networks!
 
 `--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`)::
 
@@ -760,7 +808,7 @@ Only list stores which are enabled (not disabled in config).
 
 Include information about formats
 
-`--storage` `<string>` ::
+`--storage` `<storage ID>` ::
 
 Only list status for  specified storage