]> git.proxmox.com Git - pve-docs.git/blobdiff - pvesm.1-synopsis.adoc
qm: pct: mention move-disk for storage and reassign
[pve-docs.git] / pvesm.1-synopsis.adoc
index 986f58299825b692112c76576e95d730cab57673..d322974befbb25b5ed1227731c43c50ef8c2fd1f 100644 (file)
@@ -4,7 +4,7 @@
 
 Create a new storage.
 
-`<type>`: `<cephfs | cifs | dir | drbd | 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.
 
@@ -70,6 +70,10 @@ Certificate SHA 256 fingerprint.
 
 Default image format.
 
+`--fs-name` `<string>` ::
+
+The Ceph filesystem name.
+
 `--fuse` `<boolean>` ::
 
 Mount CephFS through FUSE.
@@ -82,6 +86,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 +100,11 @@ 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.
 
 `--maxfiles` `<integer> (0 - N)` ::
 
-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 +122,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,13 +158,13 @@ For non default port.
 
 iSCSI portal (IP or DNS name with optional 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>]` ::
+`--preallocation` `<falloc | full | metadata | off>` ('default =' `metadata`)::
 
-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.
+Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off.
 
-`--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
+`--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 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.
+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.
 
 `--saferemove` `<boolean>` ::
 
@@ -180,9 +192,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>` ::
 
@@ -262,7 +274,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
 
@@ -278,6 +290,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
@@ -330,7 +346,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
 
@@ -350,6 +366,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
@@ -594,6 +614,10 @@ Certificate SHA 256 fingerprint.
 
 Default image format.
 
+`--fs-name` `<string>` ::
+
+The Ceph filesystem name.
+
 `--fuse` `<boolean>` ::
 
 Mount CephFS through FUSE.
@@ -602,6 +626,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.
@@ -612,11 +640,11 @@ 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.
 
 `--maxfiles` `<integer> (0 - N)` ::
 
-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`)::
 
@@ -634,6 +662,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.
@@ -658,13 +690,13 @@ Pool.
 
 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>]` ::
+`--preallocation` `<falloc | full | metadata | off>` ('default =' `metadata`)::
 
-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.
+Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off.
 
-`--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
+`--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 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.
+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.
 
 `--saferemove` `<boolean>` ::
 
@@ -688,9 +720,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>` ::