]> git.proxmox.com Git - pve-docs.git/commitdiff
update static and schema information
authorThomas Lamprecht <t.lamprecht@proxmox.com>
Wed, 23 Jun 2021 20:26:26 +0000 (22:26 +0200)
committerThomas Lamprecht <t.lamprecht@proxmox.com>
Wed, 23 Jun 2021 20:26:38 +0000 (22:26 +0200)
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
api-viewer/apidata.js
pvesm.1-synopsis.adoc

index 887e48bee4ff56bf0c0cc89d3e583ecaf1e6c9ae..6392cb1fbaccea92b8fe5f8d716d8f6789c151cc 100644 (file)
@@ -40158,8 +40158,8 @@ const apiSchema = [
                                  "default" : "login",
                                  "description" : "Run specific command or default to login.",
                                  "enum" : [
-                                    "upgrade",
                                     "login",
+                                    "upgrade",
                                     "ceph_install"
                                  ],
                                  "optional" : 1,
@@ -40254,8 +40254,8 @@ const apiSchema = [
                                  "default" : "login",
                                  "description" : "Run specific command or default to login.",
                                  "enum" : [
-                                    "upgrade",
                                     "login",
+                                    "upgrade",
                                     "ceph_install"
                                  ],
                                  "optional" : 1,
@@ -40380,8 +40380,8 @@ const apiSchema = [
                                  "default" : "login",
                                  "description" : "Run specific command or default to login.",
                                  "enum" : [
-                                    "upgrade",
                                     "login",
+                                    "upgrade",
                                     "ceph_install"
                                  ],
                                  "optional" : 1,
@@ -41366,13 +41366,13 @@ const apiSchema = [
                            "typetext" : "<string>"
                         },
                         "master-pubkey" : {
-                           "description" : "Base64-encoded, PEM-formatted public RSA key. Used tp encrypt a copy of the encryption-key which will be added to each encrypted backup.",
+                           "description" : "Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup.",
                            "optional" : 1,
                            "type" : "string",
                            "typetext" : "<string>"
                         },
                         "maxfiles" : {
-                           "description" : "Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimted.",
+                           "description" : "Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.",
                            "minimum" : 0,
                            "optional" : 1,
                            "type" : "integer",
@@ -41405,6 +41405,13 @@ const apiSchema = [
                            "type" : "string",
                            "typetext" : "<string>"
                         },
+                        "nocow" : {
+                           "default" : 0,
+                           "description" : "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.",
+                           "optional" : 1,
+                           "type" : "boolean",
+                           "typetext" : "<boolean>"
+                        },
                         "nodes" : {
                            "description" : "List of cluster node names.",
                            "format" : "pve-node-list",
@@ -41573,6 +41580,7 @@ const apiSchema = [
                         "type" : {
                            "description" : "The type of the created storage.",
                            "enum" : [
+                              "btrfs",
                               "cephfs",
                               "cifs",
                               "dir",
@@ -41611,6 +41619,7 @@ const apiSchema = [
                   "type" : {
                      "description" : "Only list storage of specific type",
                      "enum" : [
+                        "btrfs",
                         "cephfs",
                         "cifs",
                         "dir",
@@ -41818,13 +41827,13 @@ const apiSchema = [
                      "typetext" : "<string>"
                   },
                   "master-pubkey" : {
-                     "description" : "Base64-encoded, PEM-formatted public RSA key. Used tp encrypt a copy of the encryption-key which will be added to each encrypted backup.",
+                     "description" : "Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup.",
                      "optional" : 1,
                      "type" : "string",
                      "typetext" : "<string>"
                   },
                   "maxfiles" : {
-                     "description" : "Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimted.",
+                     "description" : "Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.",
                      "minimum" : 0,
                      "optional" : 1,
                      "type" : "integer",
@@ -41857,6 +41866,13 @@ const apiSchema = [
                      "type" : "string",
                      "typetext" : "<string>"
                   },
+                  "nocow" : {
+                     "default" : 0,
+                     "description" : "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.",
+                     "optional" : 1,
+                     "type" : "boolean",
+                     "typetext" : "<boolean>"
+                  },
                   "nodes" : {
                      "description" : "List of cluster node names.",
                      "format" : "pve-node-list",
@@ -42020,6 +42036,7 @@ const apiSchema = [
                   "type" : {
                      "description" : "Storage type.",
                      "enum" : [
+                        "btrfs",
                         "cephfs",
                         "cifs",
                         "dir",
@@ -42090,6 +42107,7 @@ const apiSchema = [
                   "type" : {
                      "description" : "The type of the created storage.",
                      "enum" : [
+                        "btrfs",
                         "cephfs",
                         "cifs",
                         "dir",
index f3a77a779d0433c28e6b36958c555f7c82a98fd5..2ee66d99be69a640ccb4ce36b1bfd33fe694aa9e 100644 (file)
@@ -4,7 +4,7 @@
 
 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.
 
@@ -92,11 +92,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)` ::
 
-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`)::
 
@@ -114,6 +114,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.
@@ -258,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
 
@@ -274,6 +278,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
@@ -326,7 +334,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
 
@@ -346,6 +354,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
@@ -608,11 +620,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)` ::
 
-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`)::
 
@@ -630,6 +642,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.