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.
+
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.
+Proxmox Backup Server datastore name.
`--disable` `<boolean>` ::
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.
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 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`)::
mount point
+`--namespace` `<string>` ::
+
+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.
Pool.
+`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+
+For non default port.
+
`--portal` `<string>` ::
iSCSI portal (IP or DNS name with optional port).
-`--prune-backups` `[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>` ::
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
Destination file name
-`--base` `(?^:[a-z0-9_\-]{1,40})` ::
+`--base` `(?^i:[a-z0-9_\-]{1,40})` ::
Snapshot to start an incremental stream from
-`--snapshot` `(?^:[a-z0-9_\-]{1,40})` ::
+`--snapshot` `(?^i:[a-z0-9_\-]{1,40})` ::
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
`<filename>`: `<string>` ::
-Source file name. For '-' stdin is used, the tcp://<IP-or-CIDR> format allows to use a TCP connection as input. Else, the file is treated as common file.
+Source file name. For '-' stdin is used, the tcp://<IP-or-CIDR> format allows to use a TCP connection, the unix://PATH-TO-SOCKET format a UNIX socket as input.Else, the file is treated as common file.
`--allow-rename` `<boolean>` ('default =' `0`)::
Choose a new volume ID if the requested volume ID already exists, instead of throwing an error.
-`--base` `(?^:[a-z0-9_\-]{1,40})` ::
+`--base` `(?^i:[a-z0-9_\-]{1,40})` ::
Base snapshot of an incremental stream
-`--delete-snapshot` `(?^:[a-z0-9_\-]{1,80})` ::
+`--delete-snapshot` `(?^i:[a-z0-9_\-]{1,80})` ::
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
*pvesm prune-backups* `<storage>` `[OPTIONS]`
-Prune backups. This is only a wrapper for the proper API endpoints.
+Prune backups. Only those using the standard naming scheme are considered.
+If no keep options are specified, those from the storage configuration are
+used.
`<storage>`: `<string>` ::
Only show what would be pruned, don't delete anything.
-`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
+`--keep-all` `<boolean>` ::
+
+Keep all backups. Conflicts with the other options when true.
+
+`--keep-daily` `<N>` ::
+
+Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept.
+
+`--keep-hourly` `<N>` ::
+
+Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept.
+
+`--keep-last` `<N>` ::
+
+Keep the last <N> backups.
+
+`--keep-monthly` `<N>` ::
+
+Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept.
+
+`--keep-weekly` `<N>` ::
+
+Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept.
+
+`--keep-yearly` `<N>` ::
-Use these retention options instead of those from the storage configuration.
+Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept.
`--type` `<lxc | qemu>` ::
The server address (name or IP).
+*pvesm scan pbs* `<server> <username> --password <string>` `[OPTIONS]` `[FORMAT_OPTIONS]`
+
+Scan remote Proxmox Backup Server.
+
+`<server>`: `<string>` ::
+
+The server address (name or IP).
+
+`<username>`: `<string>` ::
+
+User-name or API token-ID.
+
+`--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
+
+Certificate SHA 256 fingerprint.
+
+`--password` `<string>` ::
+
+User password or API token secret.
+
+`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
+
+Optional port.
+
*pvesm scan zfs*
Scan zfs pool list on local node.
+
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.
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.
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 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`)::
mount point
+`--namespace` `<string>` ::
+
+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.
Pool.
-`--prune-backups` `[keep-daily=<N>] [,keep-hourly=<N>] [,keep-last=<N>] [,keep-monthly=<N>] [,keep-weekly=<N>] [,keep-yearly=<N>]` ::
+`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
-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.
+For non default port.
+
+`--preallocation` `<falloc | full | metadata | off>` ('default =' `metadata`)::
-`--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
+Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off.
-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.
+`--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.
`--saferemove` `<boolean>` ::
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