pveceph: add section about erasure code pools

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

diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc
index f3a77a779d0433c28e6b36958c555f7c82a98fd5..f7fc499c02a69454ebaf1cf3063113c6bfbfc82e 100644 (file)
--- a/pvesm.1-synopsis.adoc
+++ b/pvesm.1-synopsis.adoc
@@ -4,7 +4,7 @@
 
 Create a new storage.
 
-`<type>`: `<cephfs | cifs | dir | glusterfs | iscsi | iscsidirect | lvm | lvmthin | nfs | pbs | rbd | zfs | zfspool>` ::
+`<type>`: `<btrfs | cephfs | cifs | dir | 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.
 
+`--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.
@@ -92,11 +104,15 @@ 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.
+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 unlimted.
+Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.
 
 `--mkdir` `<boolean>` ('default =' `yes`)::
 
@@ -114,6 +130,10 @@ mount point
 
 RBD Namespace.
 
+`--nocow` `<boolean>` ('default =' `0`)::
+
+Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system.
+
 `--nodes` `<string>` ::
 
 List of cluster node names.
@@ -146,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.
@@ -176,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>` ::
 
@@ -258,7 +282,7 @@ Used internally to export a volume.
 
 Volume identifier
 
-`<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
+`<format>`: `<btrfs | qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
 
 Export stream format
 
@@ -274,6 +298,10 @@ Snapshot to start an incremental stream from
 
 Snapshot to export
 
+`--snapshot-list` `<string>` ::
+
+Ordered list of snapshots to transfer
+
 `--with-snapshots` `<boolean>` ('default =' `0`)::
 
 Whether to include intermediate snapshots in the stream
@@ -326,7 +354,7 @@ Used internally to import a volume.
 
 Volume identifier
 
-`<format>`: `<qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
+`<format>`: `<btrfs | qcow2+size | raw+size | tar+size | vmdk+size | zfs>` ::
 
 Import stream format
 
@@ -346,6 +374,10 @@ Base snapshot of an incremental stream
 
 A snapshot to delete on success
 
+`--snapshot` `(?^i:[a-z0-9_\-]{1,40})` ::
+
+The current-state snapshot if the stream contains snapshots
+
 `--with-snapshots` `<boolean>` ('default =' `0`)::
 
 Whether the stream includes intermediate snapshots
@@ -562,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.
@@ -590,6 +626,10 @@ Certificate SHA 256 fingerprint.
 
 Default image format.
 
+`--fs-name` `<string>` ::
+
+The Ceph filesystem name.
+
 `--fuse` `<boolean>` ::
 
 Mount CephFS through FUSE.
@@ -598,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.
@@ -608,11 +652,15 @@ 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.
+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 unlimted.
+Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.
 
 `--mkdir` `<boolean>` ('default =' `yes`)::
 
@@ -630,6 +678,10 @@ mount point
 
 RBD Namespace.
 
+`--nocow` `<boolean>` ('default =' `0`)::
+
+Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system.
+
 `--nodes` `<string>` ::
 
 List of cluster node names.
@@ -654,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.
@@ -680,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>` ::