]> git.proxmox.com Git - pve-docs.git/blobdiff - pvesm.1-synopsis.adoc
bump version to 7.0-5
[pve-docs.git] / pvesm.1-synopsis.adoc
index d231c485c85aaf02ccafc8e67e49ce8a082276b7..2ee66d99be69a640ccb4ce36b1bfd33fe694aa9e 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.
 
@@ -90,9 +90,13 @@ 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.
+
 `--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`)::
 
@@ -106,6 +110,14 @@ IP addresses of monitors (for external clusters).
 
 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.
@@ -142,10 +154,6 @@ iSCSI portal (IP or DNS name with optional port).
 
 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.
 
-`--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
-
-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.
-
 `--saferemove` `<boolean>` ::
 
 Zero-out data when removing LVs.
@@ -254,7 +262,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
 
@@ -262,14 +270,18 @@ 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
@@ -322,26 +334,30 @@ 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
 
 `<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
@@ -500,6 +516,30 @@ Scan remote NFS server.
 
 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.
@@ -578,9 +618,13 @@ 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.
+
 `--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`)::
 
@@ -594,6 +638,14 @@ IP addresses of monitors (for external clusters).
 
 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.
@@ -622,10 +674,6 @@ For non default port.
 
 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.
 
-`--redundancy` `<integer> (1 - 16)` ('default =' `2`)::
-
-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.
-
 `--saferemove` `<boolean>` ::
 
 Zero-out data when removing LVs.