{
"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,
[
"Sys.Modify"
]
- ]
+ ],
+ "description" : "The 'tmpdir', 'dumpdir' and 'script' parameters are additionally restricted to the 'root@pam' user."
},
"protected" : 1,
"returns" : {
}
}
},
- "leaf" : 1,
+ "leaf" : 0,
"path" : "/cluster/backup/{id}",
"text" : "{id}"
}
"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" : [
{
"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,
"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,
"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,
"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",
"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",
"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",
"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,
"typetext" : "<string>"
},
"password" : {
- "description" : "Password for CIFS share.",
+ "description" : "Password for accessing the share/datastore.",
"maxLength" : 256,
"optional" : 1,
"type" : "string",
"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",
"typetext" : "<string>"
},
"password" : {
- "description" : "Password for CIFS share.",
+ "description" : "Password for accessing the share/datastore.",
"maxLength" : 256,
"optional" : 1,
"type" : "string",
CIFS domain.
+`--encryption-key` `<filepath>` ::
+
+Encryption key. Use 'autogen' to generate one automatically without passphrase.
+
`--export` `<string>` ::
NFS export path.
`--password` `<password>` ::
-Password for CIFS share.
+Password for accessing the share/datastore.
`--path` `<string>` ::
*pvesm export* `<volume> <format> <filename>` `[OPTIONS]`
-Export a volume.
+Used internally to export a volume.
`<volume>`: `<string>` ::
*pvesm import* `<volume> <format> <filename>` `[OPTIONS]`
-Import a volume.
+Used internally to import a volume.
`<volume>`: `<string>` ::
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.
NFS mount options (see 'man nfs')
-`--password` `<string>` ::
+`--password` `<password>` ::
-Password for CIFS share.
+Password for accessing the share/datastore.
`--pool` `<string>` ::
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.