Create a new storage.
-`<type>`: `<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.
`--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)` ::
-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>` ::
-List of cluster node names.
+List of nodes for which the storage configuration applies.
`--nowritecache` `<boolean>` ::
`--options` `<string>` ::
-NFS mount options (see 'man nfs')
+NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')
`--password` `<password>` ::
Pool.
-`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+`--port` `<integer> (1 - 65535)` ::
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.
`--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.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>` ::
Allocate disk images.
-`<storage>`: `<string>` ::
+`<storage>`: `<storage ID>` ::
The storage identifier.
-`<vmid>`: `<integer> (1 - N)` ::
+`<vmid>`: `<integer> (100 - 999999999)` ::
Specify owner VM
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
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.
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
List storage content.
-`<storage>`: `<string>` ::
+`<storage>`: `<storage ID>` ::
The storage identifier.
Only list content of this type.
-`--vmid` `<integer> (1 - N)` ::
+`--vmid` `<integer> (100 - 999999999)` ::
Only list images for this VM
If no keep options are specified, those from the storage configuration are
used.
-`<storage>`: `<string>` ::
+`<storage>`: `<storage ID>` ::
The storage identifier.
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.
Delete storage configuration.
-`<storage>`: `<string>` ::
+`<storage>`: `<storage ID>` ::
The storage identifier.
Update storage configuration.
-`<storage>`: `<string>` ::
+`<storage>`: `<storage ID>` ::
The storage identifier.
`--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.
`--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>` ::
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)` ::
-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>` ::
-List of cluster node names.
+List of nodes for which the storage configuration applies.
`--nowritecache` `<boolean>` ::
`--options` `<string>` ::
-NFS mount options (see 'man nfs')
+NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')
`--password` `<password>` ::
Pool.
-`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+`--port` `<integer> (1 - 65535)` ::
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.
`--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.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>` ::
Include information about formats
-`--storage` `<string>` ::
+`--storage` `<storage ID>` ::
Only list status for specified storage
projects / pve-docs.git / blobdiff