"items" : {
"properties" : {
"id" : {
+ "description" : "The job ID.",
+ "maxLength" : 50,
"type" : "string"
}
},
},
"returns" : {
"description" : "ACME TermsOfService URL.",
+ "optional" : 1,
"type" : "string"
}
}
"path" : "/cluster/acme",
"text" : "acme"
},
+ {
+ "children" : [
+ {
+ "info" : {
+ "GET" : {
+ "description" : "Get ceph metadata.",
+ "method" : "GET",
+ "name" : "metadata",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Audit",
+ "Datastore.Audit"
+ ],
+ "any",
+ 1
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "type" : "object"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/cluster/ceph/metadata",
+ "text" : "metadata"
+ },
+ {
+ "info" : {
+ "GET" : {
+ "description" : "Get ceph status.",
+ "method" : "GET",
+ "name" : "status",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Audit",
+ "Datastore.Audit"
+ ],
+ "any",
+ 1
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "type" : "object"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/cluster/ceph/status",
+ "text" : "status"
+ },
+ {
+ "children" : [
+ {
+ "info" : {
+ "GET" : {
+ "description" : "Get the status of a specific ceph flag.",
+ "method" : "GET",
+ "name" : "get_flag",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "flag" : {
+ "description" : "The name of the flag name to get.",
+ "enum" : [
+ "nobackfill",
+ "nodeep-scrub",
+ "nodown",
+ "noin",
+ "noout",
+ "norebalance",
+ "norecover",
+ "noscrub",
+ "notieragent",
+ "noup",
+ "pause"
+ ],
+ "type" : "string"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Audit"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "type" : "boolean"
+ }
+ },
+ "PUT" : {
+ "description" : "Set or clear (unset) a specific ceph flag",
+ "method" : "PUT",
+ "name" : "update_flag",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "flag" : {
+ "description" : "The ceph flag to update",
+ "enum" : [
+ "nobackfill",
+ "nodeep-scrub",
+ "nodown",
+ "noin",
+ "noout",
+ "norebalance",
+ "norecover",
+ "noscrub",
+ "notieragent",
+ "noup",
+ "pause"
+ ],
+ "type" : "string"
+ },
+ "value" : {
+ "description" : "The new value of the flag",
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "type" : "null"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/cluster/ceph/flags/{flag}",
+ "text" : "{flag}"
+ }
+ ],
+ "info" : {
+ "GET" : {
+ "description" : "get the status of all ceph flags",
+ "method" : "GET",
+ "name" : "get_all_flags",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Audit"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "items" : {
+ "additionalProperties" : 1,
+ "properties" : {
+ "name" : {
+ "description" : "Flag name.",
+ "enum" : [
+ "nobackfill",
+ "nodeep-scrub",
+ "nodown",
+ "noin",
+ "noout",
+ "norebalance",
+ "norecover",
+ "noscrub",
+ "notieragent",
+ "noup",
+ "pause"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "links" : [
+ {
+ "href" : "{name}",
+ "rel" : "child"
+ }
+ ],
+ "type" : "array"
+ }
+ },
+ "PUT" : {
+ "description" : "Set/Unset multiple ceph flags at once.",
+ "method" : "PUT",
+ "name" : "set_flags",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "nobackfill" : {
+ "description" : "Backfilling of PGs is suspended.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "nodeep-scrub" : {
+ "description" : "Deep Scrubbing is disabled.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "nodown" : {
+ "description" : "OSD failure reports are being ignored, such that the monitors will not mark OSDs down.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "noin" : {
+ "description" : "OSDs that were previously marked out will not be marked back in when they start.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "noout" : {
+ "description" : "OSDs will not automatically be marked out after the configured interval.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "norebalance" : {
+ "description" : "Rebalancing of PGs is suspended.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "norecover" : {
+ "description" : "Recovery of PGs is suspended.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "noscrub" : {
+ "description" : "Scrubbing is disabled.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "notieragent" : {
+ "description" : "Cache tiering activity is suspended.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "noup" : {
+ "description" : "OSDs are not allowed to start.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "pause" : {
+ "description" : "Pauses read and writes.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "type" : "string"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/cluster/ceph/flags",
+ "text" : "flags"
+ }
+ ],
+ "info" : {
+ "GET" : {
+ "description" : "Cluster ceph index.",
+ "method" : "GET",
+ "name" : "cephindex",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "permissions" : {
+ "user" : "all"
+ },
+ "returns" : {
+ "items" : {
+ "properties" : {},
+ "type" : "object"
+ },
+ "links" : [
+ {
+ "href" : "{name}",
+ "rel" : "child"
+ }
+ ],
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/cluster/ceph",
+ "text" : "ceph"
+ },
{
"info" : {
"GET" : {
"enum" : [
"vm",
"storage",
- "node"
+ "node",
+ "sdn"
],
"optional" : 1,
"type" : "string"
"pool",
"qemu",
"lxc",
- "openvz"
+ "openvz",
+ "sdn"
],
"type" : "string"
},
"format" : {
"shutdown_policy" : {
"default" : "conditional",
- "description" : "The policy for HA services on node shutdown. 'freeze' disables auto-recovery, 'failover' ensures recovery, 'conditional' recovers on poweroff and freezes on reboot. Running HA Services will always get stopped first on shutdown.",
+ "description" : "The policy for HA services on node shutdown. 'freeze' disables auto-recovery, 'failover' ensures recovery, 'conditional' recovers on poweroff and freezes on reboot. 'migrate' will migrate running services to other nodes, if possible. With 'freeze' or 'failover', HA Services will always get stopped first on shutdown.",
"enum" : [
"freeze",
"failover",
- "conditional"
+ "conditional",
+ "migrate"
],
"type" : "string",
- "verbose_description" : "Describes the policy for handling HA services on poweroff or reboot of a node. Freeze will always freeze services which are still located on the node on shutdown, those services won't be recovered by the HA manager. Failover will not mark the services as frozen and thus the services will get recovered to other nodes, if the shutdown node does not come up again quickly (< 1min). 'conditional' chooses automatically depending on the type of shutdown, i.e., on a reboot the service will be frozen but on a poweroff the service will stay as is, and thus get recovered after about 2 minutes."
+ "verbose_description" : "Describes the policy for handling HA services on poweroff or reboot of a node. Freeze will always freeze services which are still located on the node on shutdown, those services won't be recovered by the HA manager. Failover will not mark the services as frozen and thus the services will get recovered to other nodes, if the shutdown node does not come up again quickly (< 1min). 'conditional' chooses automatically depending on the type of shutdown, i.e., on a reboot the service will be frozen but on a poweroff the service will stay as is, and thus get recovered after about 2 minutes. Migrate will try to move all running services to another node on both, rebootand shutdown. The poweroff process will only continue once no running services are located on the node anymore. If the node comes up again, the service will be moved back to the previously powered-off node, at least if no other migration, reloaction or recovery took place."
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "shutdown_policy=<freeze|failover|conditional>"
+ "typetext" : "shutdown_policy=<enum>"
},
"http_proxy" : {
"description" : "Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')",
"language" : {
"description" : "Default GUI language.",
"enum" : [
- "zh_CN",
- "zh_TW",
"ca",
+ "da",
+ "de",
"en",
+ "es",
"eu",
+ "fa",
"fr",
- "de",
+ "he",
"it",
- "es",
"ja",
"nb",
"nn",
- "fa",
"pl",
"pt_BR",
"ru",
"sl",
"sv",
- "tr"
+ "tr",
+ "zh_CN",
+ "zh_TW"
],
"optional" : 1,
"type" : "string"
"leaf" : 1,
"path" : "/cluster/nextid",
"text" : "nextid"
- },
- {
- "children" : [
- {
- "info" : {
- "GET" : {
- "description" : "Get ceph metadata.",
- "method" : "GET",
- "name" : "ceph_metadata",
- "parameters" : {
- "additionalProperties" : 0
- },
- "permissions" : {
- "check" : [
- "perm",
- "/",
- [
- "Sys.Audit",
- "Datastore.Audit"
- ],
- "any",
- 1
- ]
- },
- "protected" : 1,
- "returns" : {
- "type" : "object"
- }
- }
- },
- "leaf" : 1,
- "path" : "/cluster/ceph/metadata",
- "text" : "metadata"
- },
- {
- "info" : {
- "GET" : {
- "description" : "Get ceph status.",
- "method" : "GET",
- "name" : "cephstatus",
- "parameters" : {
- "additionalProperties" : 0
- },
- "permissions" : {
- "check" : [
- "perm",
- "/",
- [
- "Sys.Audit",
- "Datastore.Audit"
- ],
- "any",
- 1
- ]
- },
- "protected" : 1,
- "returns" : {
- "type" : "object"
- }
- }
- },
- "leaf" : 1,
- "path" : "/cluster/ceph/status",
- "text" : "status"
- }
- ],
- "info" : {
- "GET" : {
- "description" : "Cluster ceph index.",
- "method" : "GET",
- "name" : "cephindex",
- "parameters" : {
- "additionalProperties" : 0
- },
- "permissions" : {
- "user" : "all"
- },
- "returns" : {
- "items" : {
- "properties" : {},
- "type" : "object"
- },
- "links" : [
- {
- "href" : "{name}",
- "rel" : "child"
- }
- ],
- "type" : "array"
- }
- }
- },
- "leaf" : 0,
- "path" : "/cluster/ceph",
- "text" : "ceph"
}
],
"info" : {
"returns" : {
"properties" : {
"dhcp" : {
+ "default" : 0,
"description" : "Enable DHCP.",
"optional" : 1,
"type" : "boolean"
},
"enable" : {
+ "default" : 0,
"description" : "Enable/disable firewall rules.",
"optional" : 1,
"type" : "boolean"
"type" : "string"
},
"macfilter" : {
+ "default" : 0,
"description" : "Enable/disable MAC address filter.",
"optional" : 1,
"type" : "boolean"
},
"ndp" : {
- "description" : "Enable NDP.",
+ "default" : 0,
+ "description" : "Enable NDP (Neighbor Discovery Protocol).",
"optional" : 1,
"type" : "boolean"
},
"typetext" : "<string>"
},
"dhcp" : {
+ "default" : 0,
"description" : "Enable DHCP.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<string>"
},
"enable" : {
+ "default" : 0,
"description" : "Enable/disable firewall rules.",
"optional" : 1,
"type" : "boolean",
"type" : "string"
},
"macfilter" : {
+ "default" : 0,
"description" : "Enable/disable MAC address filter.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"ndp" : {
- "description" : "Enable NDP.",
+ "default" : 0,
+ "description" : "Enable NDP (Neighbor Discovery Protocol).",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"password" : {
"description" : "The new password.",
- "maxLength" : 64,
+ "maxLength" : 1024,
"minLength" : 5,
"type" : "string",
"typetext" : "<string>"
"description" : "Run fstrim after cloning/moving a disk.",
"optional" : 1,
"type" : "boolean"
+ },
+ "type" : {
+ "default" : "virtio",
+ "description" : "Select the agent type",
+ "enum" : [
+ "virtio",
+ "isa"
+ ],
+ "optional" : 1,
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
"verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n"
},
+ "audio0" : {
+ "description" : "Configure a audio device, useful in combination with QXL/Spice.",
+ "format" : {
+ "device" : {
+ "description" : "Configure an audio device.",
+ "enum" : [
+ "ich9-intel-hda",
+ "intel-hda",
+ "AC97"
+ ],
+ "type" : "string"
+ },
+ "driver" : {
+ "default" : "spice",
+ "description" : "Driver backend for the audio device.",
+ "enum" : [
+ "spice"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string"
+ },
"autostart" : {
"default" : 0,
"description" : "Automatic restart after crash (currently ignored).",
"Broadwell-IBRS",
"Broadwell-noTSX",
"Broadwell-noTSX-IBRS",
+ "Cascadelake-Server",
"Conroe",
"core2duo",
"coreduo",
"host",
"IvyBridge",
"IvyBridge-IBRS",
+ "KnightsMill",
"kvm32",
"kvm64",
"max",
"type" : "string"
},
"flags" : {
- "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.",
+ "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.",
"format_description" : "+FLAG[;-FLAG...]",
"optional" : 1,
- "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)",
+ "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes)))*)",
"type" : "string"
},
"hidden" : {
"description" : "Specifies the Qemu machine type.",
"maxLength" : 40,
"optional" : 1,
- "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)",
+ "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)",
"type" : "string"
},
"memory" : {
],
"optional" : 1,
"type" : "string",
- "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
+ "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
},
"parallel[n]" : {
"description" : "Map host parallel devices (n is 0 to 2).",
"optional" : 1,
"type" : "integer"
},
+ "spice_enhancements" : {
+ "description" : "Configure additional enhancements for SPICE.",
+ "format" : {
+ "foldersharing" : {
+ "default" : "0",
+ "description" : "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "videostreaming" : {
+ "default" : "off",
+ "description" : "Enable video streaming. Uses compression for detected video streams.",
+ "enum" : [
+ "off",
+ "all",
+ "filter"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string"
+ },
"sshkeys" : {
"description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).",
"format" : "urlencoded",
"type" : "boolean",
"verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)."
},
+ "tags" : {
+ "description" : "Tags of the VM. This is only meta information.",
+ "format" : "pve-tag-list",
+ "optional" : 1,
+ "type" : "string"
+ },
"tdf" : {
"default" : 0,
"description" : "Enable/disable time drift fix.",
},
"usb3" : {
"default" : 0,
- "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).",
+ "description" : "Specifies whether if given host option is a USB3 device or port.",
"optional" : 1,
"type" : "boolean"
}
"description" : "Run fstrim after cloning/moving a disk.",
"optional" : 1,
"type" : "boolean"
+ },
+ "type" : {
+ "default" : "virtio",
+ "description" : "Select the agent type",
+ "enum" : [
+ "virtio",
+ "isa"
+ ],
+ "optional" : 1,
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]"
+ "typetext" : "[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]"
},
"arch" : {
"description" : "Virtual processor architecture. Defaults to the host.",
"typetext" : "<string>",
"verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n"
},
+ "audio0" : {
+ "description" : "Configure a audio device, useful in combination with QXL/Spice.",
+ "format" : {
+ "device" : {
+ "description" : "Configure an audio device.",
+ "enum" : [
+ "ich9-intel-hda",
+ "intel-hda",
+ "AC97"
+ ],
+ "type" : "string"
+ },
+ "driver" : {
+ "default" : "spice",
+ "description" : "Driver backend for the audio device.",
+ "enum" : [
+ "spice"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]"
+ },
"autostart" : {
"default" : 0,
"description" : "Automatic restart after crash (currently ignored).",
"Broadwell-IBRS",
"Broadwell-noTSX",
"Broadwell-noTSX-IBRS",
+ "Cascadelake-Server",
"Conroe",
"core2duo",
"coreduo",
"host",
"IvyBridge",
"IvyBridge-IBRS",
+ "KnightsMill",
"kvm32",
"kvm64",
"max",
"type" : "string"
},
"flags" : {
- "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.",
+ "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.",
"format_description" : "+FLAG[;-FLAG...]",
"optional" : 1,
- "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)",
+ "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes)))*)",
"type" : "string"
},
"hidden" : {
"description" : "Specifies the Qemu machine type.",
"maxLength" : 40,
"optional" : 1,
- "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)",
+ "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)",
"type" : "string"
},
"memory" : {
],
"optional" : 1,
"type" : "string",
- "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
+ "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
},
"parallel[n]" : {
"description" : "Map host parallel devices (n is 0 to 2).",
"type" : "integer",
"typetext" : "<integer> (1 - N)"
},
+ "spice_enhancements" : {
+ "description" : "Configure additional enhancements for SPICE.",
+ "format" : {
+ "foldersharing" : {
+ "default" : "0",
+ "description" : "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "videostreaming" : {
+ "default" : "off",
+ "description" : "Enable video streaming. Uses compression for detected video streams.",
+ "enum" : [
+ "off",
+ "all",
+ "filter"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]"
+ },
"sshkeys" : {
"description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).",
"format" : "urlencoded",
"typetext" : "<boolean>",
"verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)."
},
+ "tags" : {
+ "description" : "Tags of the VM. This is only meta information.",
+ "format" : "pve-tag-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"tdf" : {
"default" : 0,
"description" : "Enable/disable time drift fix.",
},
"usb3" : {
"default" : 0,
- "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).",
+ "description" : "Specifies whether if given host option is a USB3 device or port.",
"optional" : 1,
"type" : "boolean"
}
"description" : "Run fstrim after cloning/moving a disk.",
"optional" : 1,
"type" : "boolean"
+ },
+ "type" : {
+ "default" : "virtio",
+ "description" : "Select the agent type",
+ "enum" : [
+ "virtio",
+ "isa"
+ ],
+ "optional" : 1,
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]"
+ "typetext" : "[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]"
},
"arch" : {
"description" : "Virtual processor architecture. Defaults to the host.",
"typetext" : "<string>",
"verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n"
},
+ "audio0" : {
+ "description" : "Configure a audio device, useful in combination with QXL/Spice.",
+ "format" : {
+ "device" : {
+ "description" : "Configure an audio device.",
+ "enum" : [
+ "ich9-intel-hda",
+ "intel-hda",
+ "AC97"
+ ],
+ "type" : "string"
+ },
+ "driver" : {
+ "default" : "spice",
+ "description" : "Driver backend for the audio device.",
+ "enum" : [
+ "spice"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]"
+ },
"autostart" : {
"default" : 0,
"description" : "Automatic restart after crash (currently ignored).",
"Broadwell-IBRS",
"Broadwell-noTSX",
"Broadwell-noTSX-IBRS",
+ "Cascadelake-Server",
"Conroe",
"core2duo",
"coreduo",
"host",
"IvyBridge",
"IvyBridge-IBRS",
+ "KnightsMill",
"kvm32",
"kvm64",
"max",
"type" : "string"
},
"flags" : {
- "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.",
+ "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.",
"format_description" : "+FLAG[;-FLAG...]",
"optional" : 1,
- "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)",
+ "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes)))*)",
"type" : "string"
},
"hidden" : {
"description" : "Specifies the Qemu machine type.",
"maxLength" : 40,
"optional" : 1,
- "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)",
+ "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)",
"type" : "string"
},
"memory" : {
],
"optional" : 1,
"type" : "string",
- "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
+ "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
},
"parallel[n]" : {
"description" : "Map host parallel devices (n is 0 to 2).",
"type" : "integer",
"typetext" : "<integer> (1 - N)"
},
+ "spice_enhancements" : {
+ "description" : "Configure additional enhancements for SPICE.",
+ "format" : {
+ "foldersharing" : {
+ "default" : "0",
+ "description" : "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "videostreaming" : {
+ "default" : "off",
+ "description" : "Enable video streaming. Uses compression for detected video streams.",
+ "enum" : [
+ "off",
+ "all",
+ "filter"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]"
+ },
"sshkeys" : {
"description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).",
"format" : "urlencoded",
"typetext" : "<boolean>",
"verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)."
},
+ "tags" : {
+ "description" : "Tags of the VM. This is only meta information.",
+ "format" : "pve-tag-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"tdf" : {
"default" : 0,
"description" : "Enable/disable time drift fix.",
},
"usb3" : {
"default" : 0,
- "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).",
+ "description" : "Specifies whether if given host option is a USB3 device or port.",
"optional" : 1,
"type" : "boolean"
}
],
"type" : "string"
},
+ "tags" : {
+ "description" : "The current configured tags, if any",
+ "optional" : 1,
+ "type" : "string"
+ },
"uptime" : {
"description" : "Uptime.",
"optional" : 1,
"description" : "Specifies the Qemu machine type.",
"maxLength" : 40,
"optional" : 1,
- "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)",
+ "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)",
"type" : "string"
},
"migratedfrom" : {
"path" : "/nodes/{node}/qemu/{vmid}/status/shutdown",
"text" : "shutdown"
},
+ {
+ "info" : {
+ "POST" : {
+ "description" : "Reboot the VM by shutting it down, and starting it again. Applies pending changes.",
+ "method" : "POST",
+ "name" : "vm_reboot",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "timeout" : {
+ "description" : "Wait maximal timeout seconds for the shutdown.",
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (0 - N)"
+ },
+ "vmid" : {
+ "description" : "The (unique) ID of the VM.",
+ "format" : "pve-vmid",
+ "minimum" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - N)"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/vms/{vmid}",
+ [
+ "VM.PowerMgmt"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "string"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/qemu/{vmid}/status/reboot",
+ "text" : "reboot"
+ },
{
"info" : {
"POST" : {
"typetext" : "<string>"
},
"online" : {
- "description" : "Use online/live migration.",
+ "description" : "Use online/live migration if VM is running. Ignored if VM is stopped.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
"type" : "string",
"typetext" : "<string>"
},
+ "purge" : {
+ "description" : "Remove vmid from backup cron jobs.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"optional" : 1,
],
"type" : "string"
},
+ "tags" : {
+ "description" : "The current configured tags, if any",
+ "optional" : 1,
+ "type" : "string"
+ },
"uptime" : {
"description" : "Uptime.",
"optional" : 1,
"description" : "Run fstrim after cloning/moving a disk.",
"optional" : 1,
"type" : "boolean"
+ },
+ "type" : {
+ "default" : "virtio",
+ "description" : "Select the agent type",
+ "enum" : [
+ "virtio",
+ "isa"
+ ],
+ "optional" : 1,
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]"
+ "typetext" : "[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]"
},
"arch" : {
"description" : "Virtual processor architecture. Defaults to the host.",
"typetext" : "<string>",
"verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n"
},
+ "audio0" : {
+ "description" : "Configure a audio device, useful in combination with QXL/Spice.",
+ "format" : {
+ "device" : {
+ "description" : "Configure an audio device.",
+ "enum" : [
+ "ich9-intel-hda",
+ "intel-hda",
+ "AC97"
+ ],
+ "type" : "string"
+ },
+ "driver" : {
+ "default" : "spice",
+ "description" : "Driver backend for the audio device.",
+ "enum" : [
+ "spice"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]"
+ },
"autostart" : {
"default" : 0,
"description" : "Automatic restart after crash (currently ignored).",
"Broadwell-IBRS",
"Broadwell-noTSX",
"Broadwell-noTSX-IBRS",
+ "Cascadelake-Server",
"Conroe",
"core2duo",
"coreduo",
"host",
"IvyBridge",
"IvyBridge-IBRS",
+ "KnightsMill",
"kvm32",
"kvm64",
"max",
"type" : "string"
},
"flags" : {
- "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.",
+ "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.",
"format_description" : "+FLAG[;-FLAG...]",
"optional" : 1,
- "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)",
+ "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes)))*)",
"type" : "string"
},
"hidden" : {
"description" : "Specifies the Qemu machine type.",
"maxLength" : 40,
"optional" : 1,
- "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)",
+ "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)",
"type" : "string"
},
"memory" : {
],
"optional" : 1,
"type" : "string",
- "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
+ "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
},
"parallel[n]" : {
"description" : "Map host parallel devices (n is 0 to 2).",
"type" : "integer",
"typetext" : "<integer> (1 - N)"
},
+ "spice_enhancements" : {
+ "description" : "Configure additional enhancements for SPICE.",
+ "format" : {
+ "foldersharing" : {
+ "default" : "0",
+ "description" : "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "videostreaming" : {
+ "default" : "off",
+ "description" : "Enable video streaming. Uses compression for detected video streams.",
+ "enum" : [
+ "off",
+ "all",
+ "filter"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]"
+ },
"sshkeys" : {
"description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).",
"format" : "urlencoded",
"typetext" : "<boolean>",
"verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)."
},
+ "tags" : {
+ "description" : "Tags of the VM. This is only meta information.",
+ "format" : "pve-tag-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"tdf" : {
"default" : 0,
"description" : "Enable/disable time drift fix.",
},
"usb3" : {
"default" : 0,
- "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).",
+ "description" : "Specifies whether if given host option is a USB3 device or port.",
"optional" : 1,
"type" : "boolean"
}
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "current" : {
+ "default" : 0,
+ "description" : "Get current values (instead of pending values).",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"enum" : [
"backup",
"create",
+ "destroyed",
"disk",
"fstrim",
"migrate",
"type" : "boolean",
"verbose_description" : "Whether to include the mount point in backups (only used for volume mount points)."
},
+ "mountoptions" : {
+ "description" : "Extra mount options for rootfs/mps.",
+ "format_description" : "opt[;opt...]",
+ "optional" : 1,
+ "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
+ "type" : "string"
+ },
"mp" : {
"description" : "Path to the mount point as seen from inside the container (must not contain symlinks).",
"format" : "pve-lxc-mp-string",
"optional" : 1,
"type" : "boolean"
},
+ "mountoptions" : {
+ "description" : "Extra mount options for rootfs/mps.",
+ "format_description" : "opt[;opt...]",
+ "optional" : 1,
+ "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
+ "type" : "string"
+ },
"quota" : {
"description" : "Enable user quotas inside the container (not supported with zfs subvolumes)",
"optional" : 1,
"optional" : 1,
"type" : "integer"
},
+ "tags" : {
+ "description" : "Tags of the Container. This is only meta information.",
+ "format" : "pve-tag-list",
+ "optional" : 1,
+ "type" : "string"
+ },
"template" : {
"default" : 0,
"description" : "Enable/disable Template.",
"enum" : [
"backup",
"create",
+ "destroyed",
"disk",
"fstrim",
"migrate",
"type" : "boolean",
"verbose_description" : "Whether to include the mount point in backups (only used for volume mount points)."
},
+ "mountoptions" : {
+ "description" : "Extra mount options for rootfs/mps.",
+ "format_description" : "opt[;opt...]",
+ "optional" : 1,
+ "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
+ "type" : "string"
+ },
"mp" : {
"description" : "Path to the mount point as seen from inside the container (must not contain symlinks).",
"format" : "pve-lxc-mp-string",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
+ "typetext" : "[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
},
"nameserver" : {
"description" : "Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
"type" : "boolean",
"typetext" : "<boolean>"
},
+ "revert" : {
+ "description" : "Revert a pending change.",
+ "format" : "pve-configid-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"rootfs" : {
"description" : "Use volume as container root.",
"format" : {
"optional" : 1,
"type" : "boolean"
},
+ "mountoptions" : {
+ "description" : "Extra mount options for rootfs/mps.",
+ "format_description" : "opt[;opt...]",
+ "optional" : 1,
+ "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
+ "type" : "string"
+ },
"quota" : {
"description" : "Enable user quotas inside the container (not supported with zfs subvolumes)",
"optional" : 1,
},
"optional" : 1,
"type" : "string",
- "typetext" : "[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
+ "typetext" : "[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
},
"searchdomain" : {
"description" : "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
"type" : "integer",
"typetext" : "<integer> (0 - N)"
},
+ "tags" : {
+ "description" : "Tags of the Container. This is only meta information.",
+ "format" : "pve-tag-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"template" : {
"default" : 0,
"description" : "Enable/disable Template.",
],
"type" : "string"
},
+ "tags" : {
+ "description" : "The current configured tags, if any.",
+ "optional" : 1,
+ "type" : "string"
+ },
"uptime" : {
"description" : "Uptime.",
"optional" : 1,
"leaf" : 1,
"path" : "/nodes/{node}/lxc/{vmid}/status/resume",
"text" : "resume"
+ },
+ {
+ "info" : {
+ "POST" : {
+ "description" : "Reboot the container by shutting it down, and starting it again. Applies pending changes.",
+ "method" : "POST",
+ "name" : "vm_reboot",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "timeout" : {
+ "description" : "Wait maximal timeout seconds for the shutdown.",
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (0 - N)"
+ },
+ "vmid" : {
+ "description" : "The (unique) ID of the VM.",
+ "format" : "pve-vmid",
+ "minimum" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - N)"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/vms/{vmid}",
+ [
+ "VM.PowerMgmt"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "string"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/lxc/{vmid}/status/reboot",
+ "text" : "reboot"
}
],
"info" : {
"returns" : {
"properties" : {
"dhcp" : {
+ "default" : 0,
"description" : "Enable DHCP.",
"optional" : 1,
"type" : "boolean"
},
"enable" : {
+ "default" : 0,
"description" : "Enable/disable firewall rules.",
"optional" : 1,
"type" : "boolean"
"type" : "string"
},
"macfilter" : {
+ "default" : 0,
"description" : "Enable/disable MAC address filter.",
"optional" : 1,
"type" : "boolean"
},
"ndp" : {
- "description" : "Enable NDP.",
+ "default" : 0,
+ "description" : "Enable NDP (Neighbor Discovery Protocol).",
"optional" : 1,
"type" : "boolean"
},
"typetext" : "<string>"
},
"dhcp" : {
+ "default" : 0,
"description" : "Enable DHCP.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<string>"
},
"enable" : {
+ "default" : 0,
"description" : "Enable/disable firewall rules.",
"optional" : 1,
"type" : "boolean",
"type" : "string"
},
"macfilter" : {
+ "default" : 0,
"description" : "Enable/disable MAC address filter.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"ndp" : {
- "description" : "Enable NDP.",
+ "default" : 0,
+ "description" : "Enable NDP (Neighbor Discovery Protocol).",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
"leaf" : 1,
"path" : "/nodes/{node}/lxc/{vmid}/move_volume",
"text" : "move_volume"
+ },
+ {
+ "info" : {
+ "GET" : {
+ "description" : "Get container configuration, including pending changes.",
+ "method" : "GET",
+ "name" : "vm_pending",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "vmid" : {
+ "description" : "The (unique) ID of the VM.",
+ "format" : "pve-vmid",
+ "minimum" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - N)"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/vms/{vmid}",
+ [
+ "VM.Audit"
+ ]
+ ]
+ },
+ "proxyto" : "node",
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "delete" : {
+ "description" : "Indicates a pending delete request if present and not 0.",
+ "maximum" : 2,
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "key" : {
+ "description" : "Configuration option name.",
+ "type" : "string"
+ },
+ "pending" : {
+ "description" : "Pending value.",
+ "optional" : 1,
+ "type" : "string"
+ },
+ "value" : {
+ "description" : "Current value.",
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/lxc/{vmid}/pending",
+ "text" : "pending"
}
],
"info" : {
"type" : "string",
"typetext" : "<string>"
},
+ "purge" : {
+ "description" : "Remove vmid from backup cron jobs.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
],
"type" : "string"
},
+ "tags" : {
+ "description" : "The current configured tags, if any.",
+ "optional" : 1,
+ "type" : "string"
+ },
"uptime" : {
"description" : "Uptime.",
"optional" : 1,
"enum" : [
"backup",
"create",
+ "destroyed",
"disk",
"fstrim",
"migrate",
"type" : "boolean",
"verbose_description" : "Whether to include the mount point in backups (only used for volume mount points)."
},
+ "mountoptions" : {
+ "description" : "Extra mount options for rootfs/mps.",
+ "format_description" : "opt[;opt...]",
+ "optional" : 1,
+ "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
+ "type" : "string"
+ },
"mp" : {
"description" : "Path to the mount point as seen from inside the container (must not contain symlinks).",
"format" : "pve-lxc-mp-string",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
+ "typetext" : "[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
},
"nameserver" : {
"description" : "Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
"optional" : 1,
"type" : "boolean"
},
+ "mountoptions" : {
+ "description" : "Extra mount options for rootfs/mps.",
+ "format_description" : "opt[;opt...]",
+ "optional" : 1,
+ "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
+ "type" : "string"
+ },
"quota" : {
"description" : "Enable user quotas inside the container (not supported with zfs subvolumes)",
"optional" : 1,
},
"optional" : 1,
"type" : "string",
- "typetext" : "[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
+ "typetext" : "[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
},
"searchdomain" : {
"description" : "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
"type" : "integer",
"typetext" : "<integer> (0 - N)"
},
+ "tags" : {
+ "description" : "Tags of the Container. This is only meta information.",
+ "format" : "pve-tag-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"template" : {
"default" : 0,
"description" : "Enable/disable Template.",
"leaf" : 1,
"path" : "/nodes/{node}/ceph/osd/{osdid}/out",
"text" : "out"
+ },
+ {
+ "info" : {
+ "POST" : {
+ "description" : "Instruct the OSD to scrub.",
+ "method" : "POST",
+ "name" : "scrub",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "deep" : {
+ "default" : 0,
+ "description" : "If set, instructs a deep scrub instead of a normal one.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "osdid" : {
+ "description" : "OSD ID",
+ "type" : "integer",
+ "typetext" : "<integer>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "null"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/ceph/osd/{osdid}/scrub",
+ "text" : "scrub"
}
],
"info" : {
"path" : "/nodes/{node}/ceph/config",
"text" : "config"
},
+ {
+ "info" : {
+ "GET" : {
+ "description" : "Get Ceph configuration database.",
+ "method" : "GET",
+ "name" : "configdb",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Audit",
+ "Datastore.Audit"
+ ],
+ "any",
+ 1
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "can_update_at_runtime" : {
+ "type" : "boolean"
+ },
+ "level" : {
+ "type" : "string"
+ },
+ "mask" : {
+ "type" : "string"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "section" : {
+ "type" : "string"
+ },
+ "value" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/ceph/configdb",
+ "text" : "configdb"
+ },
{
"info" : {
"POST" : {
"additionalProperties" : 0,
"properties" : {
"flag" : {
- "description" : "The ceph flag to set/unset",
+ "description" : "The ceph flag to unset",
"enum" : [
- "full",
- "pause",
- "noup",
+ "nobackfill",
+ "nodeep-scrub",
"nodown",
- "noout",
"noin",
- "nobackfill",
+ "noout",
"norebalance",
"norecover",
"noscrub",
- "nodeep-scrub",
- "notieragent"
+ "notieragent",
+ "noup",
+ "pause"
],
"type" : "string"
},
}
},
"POST" : {
- "description" : "Set a ceph flag",
+ "description" : "Set a specific ceph flag",
"method" : "POST",
"name" : "set_flag",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"flag" : {
- "description" : "The ceph flag to set/unset",
+ "description" : "The ceph flag to set",
"enum" : [
- "full",
- "pause",
- "noup",
+ "nobackfill",
+ "nodeep-scrub",
"nodown",
- "noout",
"noin",
- "nobackfill",
+ "noout",
"norebalance",
"norecover",
"noscrub",
- "nodeep-scrub",
- "notieragent"
+ "notieragent",
+ "noup",
+ "pause"
],
"type" : "string"
},
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "delay" : {
+ "description" : "Time to wait for the task to finish. We return 'null' if the task finish within that time.",
+ "maximum" : 30,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - 30)"
+ },
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"protected" : 1,
"proxyto" : "node",
"returns" : {
- "type" : "null"
+ "optional" : 1,
+ "type" : "string"
}
},
"GET" : {
"type" : "boolean"
},
"ndp" : {
- "description" : "Enable NDP.",
+ "default" : 0,
+ "description" : "Enable NDP (Neighbor Discovery Protocol).",
"optional" : 1,
"type" : "boolean"
},
"type" : "boolean"
},
"nf_conntrack_max" : {
+ "default" : 262144,
"description" : "Maximum number of tracked connections.",
"minimum" : 32768,
"optional" : 1,
"type" : "integer"
},
"nf_conntrack_tcp_timeout_established" : {
+ "default" : 432000,
"description" : "Conntrack established timeout.",
"minimum" : 7875,
"optional" : 1,
"type" : "integer"
},
+ "nf_conntrack_tcp_timeout_syn_recv" : {
+ "default" : 60,
+ "description" : "Conntrack syn recv timeout.",
+ "maximum" : 60,
+ "minimum" : 30,
+ "optional" : 1,
+ "type" : "integer"
+ },
"nosmurfs" : {
"description" : "Enable SMURFS filter.",
"optional" : 1,
"type" : "boolean"
},
+ "protection_synflood" : {
+ "default" : 0,
+ "description" : "Enable synflood protection",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "protection_synflood_burst" : {
+ "default" : 1000,
+ "description" : "Synflood protection rate burst by ip src.",
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "protection_synflood_rate" : {
+ "default" : 200,
+ "description" : "Synflood protection rate syn/sec by ip src.",
+ "optional" : 1,
+ "type" : "integer"
+ },
"smurf_log_level" : {
"description" : "Log level for SMURFS filter.",
"enum" : [
"type" : "string"
},
"tcpflags" : {
+ "default" : 0,
"description" : "Filter illegal combinations of TCP flags.",
"optional" : 1,
"type" : "boolean"
"typetext" : "<boolean>"
},
"ndp" : {
- "description" : "Enable NDP.",
+ "default" : 0,
+ "description" : "Enable NDP (Neighbor Discovery Protocol).",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
"typetext" : "<boolean>"
},
"nf_conntrack_max" : {
+ "default" : 262144,
"description" : "Maximum number of tracked connections.",
"minimum" : 32768,
"optional" : 1,
"typetext" : "<integer> (32768 - N)"
},
"nf_conntrack_tcp_timeout_established" : {
+ "default" : 432000,
"description" : "Conntrack established timeout.",
"minimum" : 7875,
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (7875 - N)"
},
+ "nf_conntrack_tcp_timeout_syn_recv" : {
+ "default" : 60,
+ "description" : "Conntrack syn recv timeout.",
+ "maximum" : 60,
+ "minimum" : 30,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (30 - 60)"
+ },
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "boolean",
"typetext" : "<boolean>"
},
+ "protection_synflood" : {
+ "default" : 0,
+ "description" : "Enable synflood protection",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "protection_synflood_burst" : {
+ "default" : 1000,
+ "description" : "Synflood protection rate burst by ip src.",
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer>"
+ },
+ "protection_synflood_rate" : {
+ "default" : 200,
+ "description" : "Synflood protection rate syn/sec by ip src.",
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer>"
+ },
"smurf_log_level" : {
"description" : "Log level for SMURFS filter.",
"enum" : [
"type" : "string"
},
"tcpflags" : {
+ "default" : 0,
"description" : "Filter illegal combinations of TCP flags.",
"optional" : 1,
"type" : "boolean",
"optional" : 1,
"type" : "string"
},
+ "public-key-bits" : {
+ "description" : "Certificate's public key size",
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "public-key-type" : {
+ "description" : "Certificate's public key algorithm",
+ "optional" : 1,
+ "type" : "string"
+ },
"san" : {
"description" : "List of Certificate's SubjectAlternativeName entries.",
"items" : {
"optional" : 1,
"type" : "string"
},
+ "public-key-bits" : {
+ "description" : "Certificate's public key size",
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "public-key-type" : {
+ "description" : "Certificate's public key algorithm",
+ "optional" : 1,
+ "type" : "string"
+ },
"san" : {
"description" : "List of Certificate's SubjectAlternativeName entries.",
"items" : {
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
+ },
+ "property" : {
+ "default" : "all",
+ "description" : "Return only a specific property from the node configuration.",
+ "enum" : [
+ "acme",
+ "description",
+ "startall-onboot-delay",
+ "wakeonlan"
+ ],
+ "optional" : 1,
+ "type" : "string"
}
}
},
"type" : "string",
"typetext" : "<string>"
},
+ "startall-onboot-delay" : {
+ "default" : 0,
+ "description" : "Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled.",
+ "maximum" : 300,
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (0 - 300)"
+ },
"wakeonlan" : {
"description" : "MAC address for wake on LAN",
"format" : "mac-addr",
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
- "upgrade",
"login",
- "ceph_install"
+ "ceph_install",
+ "upgrade"
],
"optional" : 1,
"type" : "string"
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
- "upgrade",
"login",
- "ceph_install"
+ "ceph_install",
+ "upgrade"
],
"optional" : 1,
"type" : "string"
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
- "upgrade",
"login",
- "ceph_install"
+ "ceph_install",
+ "upgrade"
],
"optional" : 1,
"type" : "string"
{
"info" : {
"POST" : {
- "description" : "Start all VMs and containers (when onboot=1).",
+ "description" : "Start all VMs and containers located on this node (by default only those with onboot=1).",
"method" : "POST",
"name" : "startall",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"force" : {
- "description" : "force if onboot=0.",
+ "default" : "off",
+ "description" : "Issue start command even if virtual guest have 'onboot' not set or set to off.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
"typetext" : "<string>"
},
"vms" : {
- "description" : "Only consider Guests with these IDs.",
+ "description" : "Only consider guests from this comma separated list of VMIDs.",
"format" : "pve-vmid-list",
"optional" : 1,
"type" : "string",
"description" : "Used memory in bytes.",
"optional" : 1,
"renderer" : "bytes",
- "type" : "string"
+ "type" : "integer"
},
"node" : {
"description" : "The cluster node name.",
"type" : "string",
"typetext" : "<string>"
},
+ "mountpoint" : {
+ "description" : "mount point",
+ "format" : "pve-storage-path",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"nodes" : {
"description" : "List of cluster node names.",
"format" : "pve-node-list",
"type" : "string",
"typetext" : "<string>"
},
+ "mountpoint" : {
+ "description" : "mount point",
+ "format" : "pve-storage-path",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"nodes" : {
"description" : "List of cluster node names.",
"format" : "pve-node-list",
"optional" : 1,
"type" : "boolean"
},
+ "SDN.Allocate" : {
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "SDN.Audit" : {
+ "optional" : 1,
+ "type" : "boolean"
+ },
"Sys.Audit" : {
"optional" : 1,
"type" : "boolean"
"type" : "string",
"typetext" : "<string>"
},
+ "sslversion" : {
+ "description" : "LDAPS TLS/SSL version. It's not recommended to use version older than 1.2!",
+ "enum" : [
+ "tlsv1",
+ "tlsv1_1",
+ "tlsv1_2",
+ "tlsv1_3"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"tfa" : {
"description" : "Use Two-factor authentication.",
"format" : "pve-tfa-config",
"type" : "string",
"typetext" : "<string>"
},
+ "sslversion" : {
+ "description" : "LDAPS TLS/SSL version. It's not recommended to use version older than 1.2!",
+ "enum" : [
+ "tlsv1",
+ "tlsv1_1",
+ "tlsv1_2",
+ "tlsv1_3"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"tfa" : {
"description" : "Use Two-factor authentication.",
"format" : "pve-tfa-config",
},
"key" : {
"description" : "When adding TOTP, the shared secret value.",
+ "format" : "pve-tfa-secret",
"optional" : 1,
- "pattern" : "(?^:[A-Z2-7=]{16}|[A-Fa-f0-9]{40})",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"password" : {
"description" : "The current password.",