update static/schema information

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

diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc
index 2ee66d99be69a640ccb4ce36b1bfd33fe694aa9e..89c797b78eb0824d5f4ac0c71ee496712cd669d5 100644 (file)
--- a/pvesm.1-synopsis.adoc
+++ b/pvesm.1-synopsis.adoc
@@ -42,6 +42,10 @@ Allowed content types.
 +
 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 
+`--data-pool` `<string>` ::
+
+Data Pool (for erasure coding only)
+
 `--datastore` `<string>` ::
 
 Proxmox Backup Server datastore name.
@@ -70,6 +74,10 @@ Certificate SHA 256 fingerprint.
 
 Default image format.
 
+`--fs-name` `<string>` ::
+
+The Ceph filesystem name.
+
 `--fuse` `<boolean>` ::
 
 Mount CephFS through FUSE.
@@ -82,6 +90,10 @@ Assume the given path is an externally managed mountpoint and consider the stora
 
 iscsi provider
 
+`--keyring` `file containing the keyring to authenticate in the Ceph cluster` ::
+
+Client keyring contents (for external clusters).
+
 `--krbd` `<boolean>` ::
 
 Always access rbd through krbd kernel module.
@@ -94,6 +106,10 @@ 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.
@@ -112,7 +128,7 @@ mount point
 
 `--namespace` `<string>` ::
 
-RBD Namespace.
+Namespace.
 
 `--nocow` `<boolean>` ('default =' `0`)::
 
@@ -150,6 +166,10 @@ For non default port.
 
 iSCSI portal (IP or DNS name with optional port).
 
+`--preallocation` `<falloc | full | metadata | off>` ('default =' `metadata`)::
+
+Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off.
+
 `--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.
@@ -180,9 +200,9 @@ CIFS share.
 
 Mark storage as shared.
 
-`--smbversion` `<2.0 | 2.1 | 3.0>` ::
+`--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`)::
 
-SMB protocol version
+SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server.
 
 `--sparse` `<boolean>` ::
 
@@ -574,6 +594,10 @@ Allowed content types.
 +
 NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
 
+`--data-pool` `<string>` ::
+
+Data Pool (for erasure coding only)
+
 `--delete` `<string>` ::
 
 A list of settings you want to delete.
@@ -602,6 +626,10 @@ Certificate SHA 256 fingerprint.
 
 Default image format.
 
+`--fs-name` `<string>` ::
+
+The Ceph filesystem name.
+
 `--fuse` `<boolean>` ::
 
 Mount CephFS through FUSE.
@@ -610,6 +638,10 @@ Mount CephFS through FUSE.
 
 Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.
 
+`--keyring` `file containing the keyring to authenticate in the Ceph cluster` ::
+
+Client keyring contents (for external clusters).
+
 `--krbd` `<boolean>` ::
 
 Always access rbd through krbd kernel module.
@@ -622,6 +654,10 @@ 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.
@@ -640,7 +676,7 @@ mount point
 
 `--namespace` `<string>` ::
 
-RBD Namespace.
+Namespace.
 
 `--nocow` `<boolean>` ('default =' `0`)::
 
@@ -670,6 +706,10 @@ Pool.
 
 For non default port.
 
+`--preallocation` `<falloc | full | metadata | off>` ('default =' `metadata`)::
+
+Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off.
+
 `--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.
@@ -696,9 +736,9 @@ NOTE: Requires option(s): `server`
 
 Mark storage as shared.
 
-`--smbversion` `<2.0 | 2.1 | 3.0>` ::
+`--smbversion` `<2.0 | 2.1 | 3 | 3.0 | 3.11 | default>` ('default =' `default`)::
 
-SMB protocol version
+SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server.
 
 `--sparse` `<boolean>` ::