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.
`--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>` ::
+
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.
Default image format.
+`--fs-name` `<string>` ::
+
+The Ceph filesystem name.
+
`--fuse` `<boolean>` ::
Mount CephFS through FUSE.
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.
`--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`)::
-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>` ::
`--namespace` `<string>` ::
-RBD Namespace.
+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>` ::
`--options` `<string>` ::
-NFS mount options (see 'man nfs')
+NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')
`--password` `<password>` ::
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.
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>` ::
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
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
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
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
`--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>` ::
+
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.
Default image format.
+`--fs-name` `<string>` ::
+
+The Ceph filesystem name.
+
`--fuse` `<boolean>` ::
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.
`--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`)::
-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>` ::
`--namespace` `<string>` ::
-RBD Namespace.
+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>` ::
`--options` `<string>` ::
-NFS mount options (see 'man nfs')
+NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')
`--password` `<password>` ::
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.
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>` ::
projects / pve-docs.git / blobdiff