]> git.proxmox.com Git - pve-docs.git/commitdiff
update static info
authorThomas Lamprecht <t.lamprecht@proxmox.com>
Mon, 13 Jul 2020 10:04:29 +0000 (12:04 +0200)
committerThomas Lamprecht <t.lamprecht@proxmox.com>
Mon, 13 Jul 2020 10:04:29 +0000 (12:04 +0200)
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
api-viewer/apidata.js
pct.1-synopsis.adoc
pct.conf.5-opts.adoc
pvesm.1-synopsis.adoc
qm.1-synopsis.adoc
qm.conf.5-opts.adoc

index 597c3e60986b256b1359f63e46ef5c9305c2c619..819802ea8d7a19d69ae378c8a832a103977b23de 100644 (file)
@@ -2897,6 +2897,100 @@ var pveapi = [
          {
             "children" : [
                {
+                  "children" : [
+                     {
+                        "info" : {
+                           "GET" : {
+                              "allowtoken" : 1,
+                              "description" : "Returns included guests and the backup status of their disks. Optimized to be used in ExtJS tree views.",
+                              "method" : "GET",
+                              "name" : "get_volume_backup_included",
+                              "parameters" : {
+                                 "additionalProperties" : 0,
+                                 "properties" : {
+                                    "id" : {
+                                       "description" : "The job ID.",
+                                       "maxLength" : 50,
+                                       "type" : "string",
+                                       "typetext" : "<string>"
+                                    }
+                                 }
+                              },
+                              "permissions" : {
+                                 "check" : [
+                                    "perm",
+                                    "/",
+                                    [
+                                       "Sys.Audit"
+                                    ]
+                                 ]
+                              },
+                              "protected" : 1,
+                              "returns" : {
+                                 "description" : "Root node of the tree object. Children represent guests, grandchildren represent volumes of that guest.",
+                                 "properties" : {
+                                    "children" : {
+                                       "items" : {
+                                          "properties" : {
+                                             "children" : {
+                                                "description" : "The volumes of the guest with the information if they will be included in backups.",
+                                                "items" : {
+                                                   "properties" : {
+                                                      "id" : {
+                                                         "description" : "Configuration key of the volume.",
+                                                         "type" : "string"
+                                                      },
+                                                      "included" : {
+                                                         "description" : "Whether the volume is included in the backup or not.",
+                                                         "type" : "boolean"
+                                                      },
+                                                      "name" : {
+                                                         "description" : "Name of the volume.",
+                                                         "type" : "string"
+                                                      },
+                                                      "reason" : {
+                                                         "description" : "The reason why the volume is included (or excluded).",
+                                                         "type" : "string"
+                                                      }
+                                                   },
+                                                   "type" : "object"
+                                                },
+                                                "optional" : 1,
+                                                "type" : "array"
+                                             },
+                                             "id" : {
+                                                "description" : "VMID of the guest.",
+                                                "type" : "integer"
+                                             },
+                                             "name" : {
+                                                "description" : "Name of the guest",
+                                                "optional" : 1,
+                                                "type" : "string"
+                                             },
+                                             "type" : {
+                                                "description" : "Type of the guest, VM, CT or unknown for removed but not purged guests.",
+                                                "enum" : [
+                                                   "qemu",
+                                                   "lxc",
+                                                   "unknown"
+                                                ],
+                                                "type" : "string"
+                                             }
+                                          },
+                                          "type" : "object"
+                                       },
+                                       "type" : "array"
+                                    }
+                                 },
+                                 "type" : "object"
+                              }
+                           }
+                        },
+                        "leaf" : 1,
+                        "path" : "/cluster/backup/{id}/included_volumes",
+                        "text" : "included_volumes"
+                     }
+                  ],
                   "info" : {
                      "DELETE" : {
                         "allowtoken" : 1,
@@ -3205,7 +3299,8 @@ var pveapi = [
                               [
                                  "Sys.Modify"
                               ]
-                           ]
+                           ],
+                           "description" : "The 'tmpdir', 'dumpdir' and 'script' parameters are additionally restricted to the 'root@pam' user."
                         },
                         "protected" : 1,
                         "returns" : {
@@ -3213,7 +3308,7 @@ var pveapi = [
                         }
                      }
                   },
-                  "leaf" : 1,
+                  "leaf" : 0,
                   "path" : "/cluster/backup/{id}",
                   "text" : "{id}"
                }
@@ -3505,6 +3600,81 @@ var pveapi = [
             "path" : "/cluster/backup",
             "text" : "backup"
          },
+         {
+            "children" : [
+               {
+                  "info" : {
+                     "GET" : {
+                        "allowtoken" : 1,
+                        "description" : "Shows all guests which are not covered by any backup job.",
+                        "method" : "GET",
+                        "name" : "get_guests_not_in_backup",
+                        "parameters" : {
+                           "additionalProperties" : 0
+                        },
+                        "permissions" : {
+                           "check" : [
+                              "perm",
+                              "/",
+                              [
+                                 "Sys.Audit"
+                              ]
+                           ]
+                        },
+                        "protected" : 1,
+                        "returns" : {
+                           "description" : "Contains the guest objects.",
+                           "items" : {
+                              "properties" : {
+                                 "name" : {
+                                    "description" : "Name of the guest",
+                                    "optional" : 1,
+                                    "type" : "string"
+                                 },
+                                 "type" : {
+                                    "description" : "Type of the guest.",
+                                    "enum" : [
+                                       "qemu",
+                                       "lxc"
+                                    ],
+                                    "type" : "string"
+                                 },
+                                 "vmid" : {
+                                    "description" : "VMID of the guest.",
+                                    "type" : "integer"
+                                 }
+                              },
+                              "type" : "object"
+                           },
+                           "type" : "array"
+                        }
+                     }
+                  },
+                  "leaf" : 1,
+                  "path" : "/cluster/backupinfo/not_backed_up",
+                  "text" : "not_backed_up"
+               }
+            ],
+            "info" : {
+               "GET" : {
+                  "allowtoken" : 1,
+                  "description" : "Stub, waits for future use.",
+                  "method" : "GET",
+                  "name" : "get_backupinfo",
+                  "parameters" : {
+                     "additionalProperties" : 0
+                  },
+                  "protected" : 1,
+                  "returns" : {
+                     "description" : "Shows stub message",
+                     "type" : "string"
+                  }
+               }
+            },
+            "leaf" : 0,
+            "path" : "/cluster/backupinfo",
+            "text" : "backupinfo"
+         },
          {
             "children" : [
                {
@@ -12760,7 +12930,7 @@ var pveapi = [
                                              "format" : "pve-vm-cpu-conf",
                                              "optional" : 1,
                                              "type" : "string",
-                                             "typetext" : "<string>"
+                                             "typetext" : "[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]"
                                           },
                                           "cpulimit" : {
                                              "default" : 0,
@@ -15038,7 +15208,7 @@ var pveapi = [
                                              "format" : "pve-vm-cpu-conf",
                                              "optional" : 1,
                                              "type" : "string",
-                                             "typetext" : "<string>"
+                                             "typetext" : "[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]"
                                           },
                                           "cpulimit" : {
                                              "default" : 0,
@@ -19964,7 +20134,7 @@ var pveapi = [
                                  "format" : "pve-vm-cpu-conf",
                                  "optional" : 1,
                                  "type" : "string",
-                                 "typetext" : "<string>"
+                                 "typetext" : "[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]"
                               },
                               "cpulimit" : {
                                  "default" : 0,
@@ -22609,6 +22779,12 @@ var pveapi = [
                                              "optional" : 1,
                                              "type" : "boolean"
                                           },
+                                          "timezone" : {
+                                             "description" : "Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab",
+                                             "format" : "pve-ct-timezone",
+                                             "optional" : 1,
+                                             "type" : "string"
+                                          },
                                           "tty" : {
                                              "default" : 2,
                                              "description" : "Specify the number of tty available to the container",
@@ -23119,6 +23295,13 @@ var pveapi = [
                                              "type" : "boolean",
                                              "typetext" : "<boolean>"
                                           },
+                                          "timezone" : {
+                                             "description" : "Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab",
+                                             "format" : "pve-ct-timezone",
+                                             "optional" : 1,
+                                             "type" : "string",
+                                             "typetext" : "<string>"
+                                          },
                                           "tty" : {
                                              "default" : 2,
                                              "description" : "Specify the number of tty available to the container",
@@ -28072,6 +28255,13 @@ var pveapi = [
                                  "type" : "boolean",
                                  "typetext" : "<boolean>"
                               },
+                              "timezone" : {
+                                 "description" : "Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab",
+                                 "format" : "pve-ct-timezone",
+                                 "optional" : 1,
+                                 "type" : "string",
+                                 "typetext" : "<string>"
+                              },
                               "tty" : {
                                  "default" : 2,
                                  "description" : "Specify the number of tty available to the container",
@@ -38433,6 +38623,12 @@ var pveapi = [
                            "type" : "string",
                            "typetext" : "<string>"
                         },
+                        "encryption-key" : {
+                           "description" : "Encryption key. Use 'autogen' to generate one automatically without passphrase.",
+                           "optional" : 1,
+                           "type" : "string",
+                           "typetext" : "<string>"
+                        },
                         "fingerprint" : {
                            "description" : "Certificate SHA 256 fingerprint.",
                            "optional" : 1,
@@ -38520,7 +38716,7 @@ var pveapi = [
                            "typetext" : "<string>"
                         },
                         "password" : {
-                           "description" : "Password for CIFS share.",
+                           "description" : "Password for accessing the share/datastore.",
                            "maxLength" : 256,
                            "optional" : 1,
                            "type" : "string",
@@ -38810,6 +39006,12 @@ var pveapi = [
                      "type" : "string",
                      "typetext" : "<string>"
                   },
+                  "encryption-key" : {
+                     "description" : "Encryption key. Use 'autogen' to generate one automatically without passphrase.",
+                     "optional" : 1,
+                     "type" : "string",
+                     "typetext" : "<string>"
+                  },
                   "export" : {
                      "description" : "NFS export path.",
                      "format" : "pve-storage-path",
@@ -38910,7 +39112,7 @@ var pveapi = [
                      "typetext" : "<string>"
                   },
                   "password" : {
-                     "description" : "Password for CIFS share.",
+                     "description" : "Password for accessing the share/datastore.",
                      "maxLength" : 256,
                      "optional" : 1,
                      "type" : "string",
index a04fa47ee2f5e624d6657f72b0155bd4192afbfe..014a655a533fd2dbcdbc03896987b3cc1992c259 100644 (file)
@@ -224,6 +224,10 @@ Tags of the Container. This is only meta information.
 
 Enable/disable Template.
 
+`--timezone` `<string>` ::
+
+Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
+
 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
 
 Specify the number of tty available to the container
@@ -673,6 +677,10 @@ Tags of the Container. This is only meta information.
 
 Enable/disable Template.
 
+`--timezone` `<string>` ::
+
+Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
+
 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
 
 Specify the number of tty available to the container
@@ -831,6 +839,10 @@ Tags of the Container. This is only meta information.
 
 Enable/disable Template.
 
+`--timezone` `<string>` ::
+
+Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
+
 `--tty` `<integer> (0 - 6)` ('default =' `2`)::
 
 Specify the number of tty available to the container
index 1a88936fc7442e0423851ec283cfe1f8f563dc91..09aca49d6c1c55a2b6822c3dfc498c445c81fb1a 100644 (file)
@@ -252,6 +252,10 @@ Tags of the Container. This is only meta information.
 
 Enable/disable Template.
 
+`timezone`: `<string>` ::
+
+Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab
+
 `tty`: `<integer> (0 - 6)` ('default =' `2`)::
 
 Specify the number of tty available to the container
index 930b4a9ea06d616509a36242fc4a5cbd0963a299..ebfd6761552ebd8b812b9f50f8bf15c8db7c3c8f 100644 (file)
@@ -54,6 +54,10 @@ Flag to disable the storage.
 
 CIFS domain.
 
+`--encryption-key` `<filepath>` ::
+
+Encryption key. Use 'autogen' to generate one automatically without passphrase.
+
 `--export` `<string>` ::
 
 NFS export path.
@@ -116,7 +120,7 @@ NFS mount options (see 'man nfs')
 
 `--password` `<password>` ::
 
-Password for CIFS share.
+Password for accessing the share/datastore.
 
 `--path` `<string>` ::
 
@@ -236,7 +240,7 @@ An alias for 'pvesm scan cifs'.
 
 *pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
 
-Export a volume.
+Used internally to export a volume.
 
 `<volume>`: `<string>` ::
 
@@ -304,7 +308,7 @@ Verbose output format.
 
 *pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
 
-Import a volume.
+Used internally to import a volume.
 
 `<volume>`: `<string>` ::
 
@@ -488,6 +492,10 @@ Flag to disable the storage.
 
 CIFS domain.
 
+`--encryption-key` `<filepath>` ::
+
+Encryption key. Use 'autogen' to generate one automatically without passphrase.
+
 `--fingerprint` `([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}` ::
 
 Certificate SHA 256 fingerprint.
@@ -540,9 +548,9 @@ disable write caching on the target
 
 NFS mount options (see 'man nfs')
 
-`--password` `<string>` ::
+`--password` `<password>` ::
 
-Password for CIFS share.
+Password for accessing the share/datastore.
 
 `--pool` `<string>` ::
 
index 301655494a143bb3f9031c32859c87b8d74138c7..be8288f6c525e9908952a4d81c507845df214c04 100644 (file)
@@ -179,7 +179,7 @@ cloud-init: User name to change ssh keys and password for instead of the image's
 
 The number of cores per socket.
 
-`--cpu` `<string>` ::
+`--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
 
 Emulated CPU type.
 
@@ -886,7 +886,7 @@ cloud-init: User name to change ssh keys and password for instead of the image's
 
 The number of cores per socket.
 
-`--cpu` `<string>` ::
+`--cpu` `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
 
 Emulated CPU type.
 
index 3903135fa2a8ee8f37e1d35383c725ee9f1852ba..fc9606c2a8edba4d33a3f6e930c7bcd229a492d7 100644 (file)
@@ -98,10 +98,34 @@ cloud-init: User name to change ssh keys and password for instead of the image's
 
 The number of cores per socket.
 
-`cpu`: `<string>` ::
+`cpu`: `[[cputype=]<string>] [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>] [,phys-bits=<8-64|host>] [,reported-model=<enum>]` ::
 
 Emulated CPU type.
 
+`cputype`=`<string>` ('default =' `kvm64`);;
+
+Emulated CPU type. Can be default or custom name (custom model names must be prefixed with 'custom-').
+
+`flags`=`<+FLAG[;-FLAG...]>` ;;
+
+List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Custom CPU models can specify any flag supported by QEMU/KVM, VM-specific flags must be from the following set for security reasons: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.
+
+`hidden`=`<boolean>` ('default =' `0`);;
+
+Do not identify as a KVM virtual machine.
+
+`hv-vendor-id`=`<vendor-id>` ;;
+
+The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.
+
+`phys-bits`=`<8-64|host>` ;;
+
+The physical memory address bits that are reported to the guest OS. Should be smaller or equal to the host's. Set to 'host' to use value from host CPU, but note that doing so will break live migration to CPUs with other values.
+
+`reported-model`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Cascadelake-Server | Cascadelake-Server-noTSX | Conroe | EPYC | EPYC-IBPB | EPYC-Rome | Haswell | Haswell-IBRS | Haswell-noTSX | Haswell-noTSX-IBRS | Icelake-Client | Icelake-Client-noTSX | Icelake-Server | Icelake-Server-noTSX | IvyBridge | IvyBridge-IBRS | KnightsMill | Nehalem | Nehalem-IBRS | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | SandyBridge-IBRS | Skylake-Client | Skylake-Client-IBRS | Skylake-Client-noTSX-IBRS | Skylake-Server | Skylake-Server-IBRS | Skylake-Server-noTSX-IBRS | Westmere | Westmere-IBRS | athlon | core2duo | coreduo | host | kvm32 | kvm64 | max | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);;
+
+CPU model and vendor to report to the guest. Must be a QEMU/KVM supported model. Only valid for custom CPU model definitions, default models will always report themselves to the guest OS.
+
 `cpulimit`: `<number> (0 - 128)` ('default =' `0`)::
 
 Limit of CPU usage.