},
"group" : {
"description" : "Security Group name.",
- "maxLength" : 20,
+ "maxLength" : 18,
"minLength" : 2,
"pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+",
"type" : "string"
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
}
}
},
"properties" : {
"group" : {
"description" : "Security Group name.",
- "maxLength" : 20,
+ "maxLength" : 18,
"minLength" : 2,
"pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+",
"type" : "string"
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
}
}
},
"enable" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"group" : {
"description" : "Security Group name.",
- "maxLength" : 20,
+ "maxLength" : 18,
"minLength" : 2,
"pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+",
"type" : "string"
"description" : "Move rule to new position <moveto>. Other arguments are ignored.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"properties" : {
"group" : {
"description" : "Security Group name.",
- "maxLength" : 20,
+ "maxLength" : 18,
"minLength" : 2,
"pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+",
"type" : "string"
"properties" : {
"group" : {
"description" : "Security Group name.",
- "maxLength" : 20,
+ "maxLength" : 18,
"minLength" : 2,
"pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+",
"type" : "string"
"enable" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"group" : {
"description" : "Security Group name.",
- "maxLength" : 20,
+ "maxLength" : 18,
"minLength" : 2,
"pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+",
"type" : "string"
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
},
"group" : {
"description" : "Security Group name.",
- "maxLength" : 20,
+ "maxLength" : 18,
"minLength" : 2,
"pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+",
"type" : "string"
},
"group" : {
"description" : "Security Group name.",
- "maxLength" : 20,
+ "maxLength" : 18,
"minLength" : 2,
"pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+",
"type" : "string"
},
"rename" : {
"description" : "Rename/update an existing security group. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing group.",
- "maxLength" : 20,
+ "maxLength" : 18,
"minLength" : 2,
"optional" : 1,
"pattern" : "[A-Za-z][A-Za-z0-9\\-\\_]+",
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
}
}
},
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
}
}
},
"enable" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"description" : "Move rule to new position <moveto>. Other arguments are ignored.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"pos" : {
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"enable" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"description" : "Enable or disable the firewall cluster wide.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"policy_in" : {
"description" : "Input policy.",
"description" : "Limit I/O bandwidth (KBytes per second).",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"compress" : {
"default" : "0",
"maximum" : 8,
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-8)"
},
"lockwait" : {
"default" : 180,
"description" : "Maximal time to wait for the global lock (minutes).",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"mailnotification" : {
"default" : "always",
"description" : "Maximal number of backup files per guest system.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"mode" : {
"default" : "snapshot",
"description" : "Unused, will be removed in a future release.",
"minimum" : 500,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (500- N)"
},
"starttime" : {
"description" : "Job Start time.",
"description" : "Maximal time to wait until a guest system is stopped (minutes).",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"storage" : {
"description" : "Store resulting file to this storage.",
"description" : "Limit I/O bandwidth (KBytes per second).",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"compress" : {
"default" : "0",
"maximum" : 8,
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-8)"
},
"lockwait" : {
"default" : 180,
"description" : "Maximal time to wait for the global lock (minutes).",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"mailnotification" : {
"default" : "always",
"description" : "Maximal number of backup files per guest system.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"mode" : {
"default" : "snapshot",
"description" : "Unused, will be removed in a future release.",
"minimum" : 500,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (500- N)"
},
"starttime" : {
"description" : "Job Start time.",
"description" : "Maximal time to wait until a guest system is stopped (minutes).",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"storage" : {
"description" : "Store resulting file to this storage.",
"description" : "Maximal number of service relocate tries when a service failes to start.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"max_restart" : {
"default" : 1,
"description" : "Maximal number of tries to restart the service on a node after its start failed.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"sid" : {
"description" : "HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).",
"description" : "Maximal number of service relocate tries when a service failes to start.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"max_restart" : {
"default" : 1,
"description" : "Maximal number of tries to restart the service on a node after its start failed.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"sid" : {
"description" : "HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).",
"description" : "Maximum number of entries.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"optional" : 1,
"type" : "string"
},
+ "mac_prefix" : {
+ "description" : "Prefix for autogenerated MAC addresses.",
+ "optional" : 1,
+ "pattern" : "(?^i:[a-f0-9]{2}(?::[a-f0-9]{2}){0,2}:?)",
+ "type" : "string"
+ },
"max_workers" : {
"description" : "Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"migration_unsecure" : {
"description" : "Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration.",
"format" : "pve-vmid",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"enable" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"description" : "Move rule to new position <moveto>. Other arguments are ignored.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"node" : {
"description" : "The cluster node name.",
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"enable" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"limit" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"node" : {
"description" : "The cluster node name.",
"start" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"type" : "boolean"
},
"args" : {
- "description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n",
+ "description" : "Arbitrary arguments passed to kvm.",
"optional" : 1,
- "type" : "string"
+ "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"
},
"autostart" : {
"default" : 0,
"maximum" : 30,
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1-30)"
},
"balloon" : {
"description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"bios" : {
"default" : "seabios",
"description" : "The number of cores per socket.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"cpu" : {
"description" : "Emulated CPU type.",
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[cputype=]<cputype> [,hidden=<1|0>]"
},
"cpulimit" : {
"default" : 0,
- "description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.",
+ "description" : "Limit of CPU usage.",
"maximum" : 128,
"minimum" : 0,
"optional" : 1,
- "type" : "number"
+ "type" : "number",
+ "typetext" : "number (0-128)",
+ "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit."
},
"cpuunits" : {
"default" : 1000,
- "description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0.",
+ "description" : "CPU weight for a VM.",
"maximum" : 500000,
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-500000)",
+ "verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0."
},
"delete" : {
"description" : "A list of settings you want to delete.",
"type" : "boolean"
},
"hostpci[n]" : {
- "description" : "Map host pci devices. HOSTPCIDEVICE syntax is:\n\n'bus:dev.func' (hexadecimal numbers)\n\nYou can us the 'lspci' command to list existing pci devices.\n\nThe 'rombar' option determines whether or not the device's ROM will be visible in the guest's memory map (default is 'on').\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nExperimental: user reported problems with this option.\n",
+ "description" : "Map host PCI devices into guest.",
"format" : "pve-qm-hostpci",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]",
+ "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer \npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
},
"hotplug" : {
"default" : "network,disk,usb",
"optional" : 1,
"type" : "string"
},
+ "hugepages" : {
+ "description" : "Enable/disable hugepages memory.",
+ "enum" : [
+ "any",
+ "2",
+ "1024"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"ide[n]" : {
"description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).",
"format" : {
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
},
"keyboard" : {
"default" : "en-us",
- "description" : "Keybord layout for vnc server. Default is read from the datacenter configuration file.",
+ "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.",
"enum" : [
"de",
"de-ch",
"description" : "Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.",
"minimum" : 16,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (16- N)"
},
"migrate_downtime" : {
"default" : 0.1,
"description" : "Set maximum tolerated downtime (in seconds) for migrations.",
"minimum" : 0,
"optional" : 1,
- "type" : "number"
+ "type" : "number",
+ "typetext" : "number (0- N)"
},
"migrate_speed" : {
"default" : 0,
"description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"name" : {
"description" : "Set a name for the VM. Only used on the configuration web interface.",
"type" : "string"
},
"net[n]" : {
- "description" : "Specify network devices.\n\nMODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3\n\nXX:XX:XX:XX:XX:XX should be an unique MAC address. This is\nautomatically generated if not specified.\n\nThe bridge parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'.\n\nOption 'rate' is used to limit traffic bandwidth from and to this interface. It is specified as floating point number, unit is 'Megabytes per second'.\n\nIf you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services. The following addresses are used:\n\n10.0.2.2 Gateway\n10.0.2.3 DNS Server\n10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n\n",
+ "description" : "Specify network devices.",
"format" : {
"bridge" : {
- "description" : "Bridge to attach the network device to.",
+ "description" : "Bridge to attach the network device to. The Proxmox VE standard bridge\nis called 'vmbr0'.\n\nIf you do not specify a bridge, we create a kvm user (NATed) network\ndevice, which provides DHCP and DNS services. The following addresses\nare used:\n\n 10.0.2.2 Gateway\n 10.0.2.3 DNS Server\n 10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n",
"format_description" : "bridge",
"optional" : 1,
"type" : "string"
"keyAlias" : "model"
},
"link_down" : {
- "description" : "Whether this interface should be DISconnected (like pulling the plug).",
+ "description" : "Whether this interface should be disconnected (like pulling the plug).",
"optional" : 1,
"type" : "boolean"
},
"macaddr" : {
- "description" : "MAC address",
+ "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
"format_description" : "XX:XX:XX:XX:XX:XX",
- "keyAlias" : "model",
"optional" : 1,
"pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
"type" : "string"
},
"model" : {
"default_key" : 1,
- "description" : "Network Card Model.",
+ "description" : "Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.",
"enum" : [
"rtl8139",
"ne2k_pci",
"type" : "integer"
},
"rate" : {
- "description" : "Rate limit in mbps as floating point number.",
+ "description" : "Rate limit in mbps (megabytes per second) as floating point number.",
"minimum" : 0,
"optional" : 1,
"type" : "number"
"tag" : {
"description" : "VLAN tag to apply to packets on this interface.",
"maximum" : 4094,
- "minimum" : 2,
+ "minimum" : 1,
"optional" : 1,
"type" : "integer"
},
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[model=]<model> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
},
"node" : {
"description" : "The cluster node name.",
"type" : "boolean"
},
"numa[n]" : {
- "description" : "numa topology",
+ "description" : "NUMA topology.",
"format" : {
"cpus" : {
- "description" : "CPUs accessing this numa node.",
+ "description" : "CPUs accessing this NUMA node.",
"format_description" : "id[-id];...",
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string"
},
"hostnodes" : {
- "description" : "host numa nodes to use",
+ "description" : "Host NUMA nodes to use.",
"format_description" : "id[-id];...",
"optional" : 1,
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string"
},
"memory" : {
- "description" : "Amount of memory this numa node provides.",
+ "description" : "Amount of memory this NUMA node provides.",
"optional" : 1,
"type" : "number"
},
"policy" : {
- "description" : "numa allocation policy.",
+ "description" : "NUMA allocation policy.",
"enum" : [
"preferred",
"bind",
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]"
},
"onboot" : {
"default" : 0,
"type" : "boolean"
},
"ostype" : {
- "description" : "Used to enable special optimization/features for specific\noperating systems:\n\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\nl24 => Linux 2.4 Kernel\nl26 => Linux 2.6/3.X Kernel\nsolaris => solaris/opensolaris/openindiania kernel\n\nother|l24|l26|solaris ... no special behaviour\nwxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch\n",
+ "description" : "Specify guest operating system.",
"enum" : [
"other",
"wxp",
"solaris"
],
"optional" : 1,
- "type" : "string"
+ "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\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
},
"parallel[n]" : {
- "description" : "Map host parallel devices (n is 0 to 2).\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nExperimental: user reported problems with this option.\n",
+ "description" : "Map host parallel devices (n is 0 to 2).",
"optional" : 1,
"pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+",
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "Map host parallel devices (n is 0 to 2).\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
},
"protection" : {
"default" : 0,
- "description" : "Sets the protection flag of the VM. This will prevent the remove operation.",
+ "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.",
"optional" : 1,
"type" : "boolean"
},
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
},
"scsi[n]" : {
"description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
},
"scsihw" : {
"default" : "lsi",
- "description" : "scsi controller model",
+ "description" : "SCSI controller model",
"enum" : [
"lsi",
"lsi53c810",
"type" : "string"
},
"serial[n]" : {
- "description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a host serial device (i.e. /dev/ttyS0), or create a unix socket on the host side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nExperimental: user reported problems with this option.\n",
+ "description" : "Create a serial device inside the VM (n is 0 to 3)",
"optional" : 1,
"pattern" : "(/dev/.+|socket)",
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
},
"shares" : {
"default" : 1000,
"maximum" : 50000,
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-50000)"
},
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"format" : "pve-qm-smbios1",
"maxLength" : 256,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]"
},
"smp" : {
"default" : 1,
"description" : "The number of CPUs. Please use option -sockets instead.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"sockets" : {
"default" : 1,
"description" : "The number of CPU sockets.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"startdate" : {
"default" : "now",
},
"tablet" : {
"default" : 1,
- "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).",
+ "description" : "Enable/disable the USB tablet device.",
"optional" : 1,
- "type" : "boolean"
+ "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)."
},
"tdf" : {
"default" : 0,
"type" : "boolean"
},
"unused[n]" : {
- "description" : "Reference to unused volumes.",
+ "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
"format" : "pve-volume-id",
"optional" : 1,
"type" : "string"
},
"usb[n]" : {
- "description" : "Configure an USB device (n is 0 to 4). This can be used to\npass-through usb devices to the guest. HOSTUSBDEVICE syntax is:\n\n'bus-port(.port)*' (decimal numbers) or\n'vendor_id:product_id' (hexadeciaml numbers) or\n'spice'\n\nYou can use the 'lsusb -t' command to list existing usb devices.\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n\nThe 'usb3' option determines whether the device is a USB3 device or not (this does currently not work reliably with spice redirection and is then ignored).\n\n",
+ "description" : "Configure an USB device (n is 0 to 4).",
"format" : {
"host" : {
"default_key" : 1,
- "description" : "The Host USB device or port or the value spice",
+ "description" : "The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:\n\n 'bus-port(.port)*' (decimal numbers) or\n 'vendor_id:product_id' (hexadeciaml numbers) or\n 'spice'\n\nYou can use the 'lsusb -t' command to list existing usb devices.\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n",
"format" : "pve-qm-usb-device",
"format_description" : "HOSTUSBDEVICE|spice",
"type" : "string"
},
"usb3" : {
- "description" : "Specifies whether if given host option is a USB3 device or port",
+ "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).",
"optional" : 1,
"type" : "boolean"
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]"
},
"vcpus" : {
"default" : 0,
"description" : "Number of hotplugged vcpus.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"vga" : {
- "description" : "Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal.",
+ "description" : "Select the VGA type.",
"enum" : [
"std",
"cirrus",
"qxl4"
],
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal."
},
"virtio[n]" : {
"description" : "Use volume as VIRTIO hard disk (n is 0 to 15).",
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"watchdog" : {
- "description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)",
+ "description" : "Create a virtual hardware watchdog device.",
"format" : "pve-qm-watchdog",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]",
+ "verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)"
}
}
},
"type" : "boolean"
},
"args" : {
- "description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n",
+ "description" : "Arbitrary arguments passed to kvm.",
"optional" : 1,
- "type" : "string"
+ "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"
},
"autostart" : {
"default" : 0,
"description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"bios" : {
"default" : "seabios",
"description" : "The number of cores per socket.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"cpu" : {
"description" : "Emulated CPU type.",
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[cputype=]<cputype> [,hidden=<1|0>]"
},
"cpulimit" : {
"default" : 0,
- "description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.",
+ "description" : "Limit of CPU usage.",
"maximum" : 128,
"minimum" : 0,
"optional" : 1,
- "type" : "number"
+ "type" : "number",
+ "typetext" : "number (0-128)",
+ "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit."
},
"cpuunits" : {
"default" : 1000,
- "description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0.",
+ "description" : "CPU weight for a VM.",
"maximum" : 500000,
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-500000)",
+ "verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0."
},
"delete" : {
"description" : "A list of settings you want to delete.",
"type" : "boolean"
},
"hostpci[n]" : {
- "description" : "Map host pci devices. HOSTPCIDEVICE syntax is:\n\n'bus:dev.func' (hexadecimal numbers)\n\nYou can us the 'lspci' command to list existing pci devices.\n\nThe 'rombar' option determines whether or not the device's ROM will be visible in the guest's memory map (default is 'on').\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nExperimental: user reported problems with this option.\n",
+ "description" : "Map host PCI devices into guest.",
"format" : "pve-qm-hostpci",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]",
+ "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer \npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
},
"hotplug" : {
"default" : "network,disk,usb",
"optional" : 1,
"type" : "string"
},
+ "hugepages" : {
+ "description" : "Enable/disable hugepages memory.",
+ "enum" : [
+ "any",
+ "2",
+ "1024"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"ide[n]" : {
"description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).",
"format" : {
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
},
"keyboard" : {
"default" : "en-us",
- "description" : "Keybord layout for vnc server. Default is read from the datacenter configuration file.",
+ "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.",
"enum" : [
"de",
"de-ch",
"description" : "Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.",
"minimum" : 16,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (16- N)"
},
"migrate_downtime" : {
"default" : 0.1,
"description" : "Set maximum tolerated downtime (in seconds) for migrations.",
"minimum" : 0,
"optional" : 1,
- "type" : "number"
+ "type" : "number",
+ "typetext" : "number (0- N)"
},
"migrate_speed" : {
"default" : 0,
"description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"name" : {
"description" : "Set a name for the VM. Only used on the configuration web interface.",
"type" : "string"
},
"net[n]" : {
- "description" : "Specify network devices.\n\nMODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3\n\nXX:XX:XX:XX:XX:XX should be an unique MAC address. This is\nautomatically generated if not specified.\n\nThe bridge parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'.\n\nOption 'rate' is used to limit traffic bandwidth from and to this interface. It is specified as floating point number, unit is 'Megabytes per second'.\n\nIf you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services. The following addresses are used:\n\n10.0.2.2 Gateway\n10.0.2.3 DNS Server\n10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n\n",
+ "description" : "Specify network devices.",
"format" : {
"bridge" : {
- "description" : "Bridge to attach the network device to.",
+ "description" : "Bridge to attach the network device to. The Proxmox VE standard bridge\nis called 'vmbr0'.\n\nIf you do not specify a bridge, we create a kvm user (NATed) network\ndevice, which provides DHCP and DNS services. The following addresses\nare used:\n\n 10.0.2.2 Gateway\n 10.0.2.3 DNS Server\n 10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n",
"format_description" : "bridge",
"optional" : 1,
"type" : "string"
"keyAlias" : "model"
},
"link_down" : {
- "description" : "Whether this interface should be DISconnected (like pulling the plug).",
+ "description" : "Whether this interface should be disconnected (like pulling the plug).",
"optional" : 1,
"type" : "boolean"
},
"macaddr" : {
- "description" : "MAC address",
+ "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
"format_description" : "XX:XX:XX:XX:XX:XX",
- "keyAlias" : "model",
"optional" : 1,
"pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
"type" : "string"
},
"model" : {
"default_key" : 1,
- "description" : "Network Card Model.",
+ "description" : "Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.",
"enum" : [
"rtl8139",
"ne2k_pci",
"type" : "integer"
},
"rate" : {
- "description" : "Rate limit in mbps as floating point number.",
+ "description" : "Rate limit in mbps (megabytes per second) as floating point number.",
"minimum" : 0,
"optional" : 1,
"type" : "number"
"tag" : {
"description" : "VLAN tag to apply to packets on this interface.",
"maximum" : 4094,
- "minimum" : 2,
+ "minimum" : 1,
"optional" : 1,
"type" : "integer"
},
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[model=]<model> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
},
"node" : {
"description" : "The cluster node name.",
"type" : "boolean"
},
"numa[n]" : {
- "description" : "numa topology",
+ "description" : "NUMA topology.",
"format" : {
"cpus" : {
- "description" : "CPUs accessing this numa node.",
+ "description" : "CPUs accessing this NUMA node.",
"format_description" : "id[-id];...",
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string"
},
"hostnodes" : {
- "description" : "host numa nodes to use",
+ "description" : "Host NUMA nodes to use.",
"format_description" : "id[-id];...",
"optional" : 1,
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string"
},
"memory" : {
- "description" : "Amount of memory this numa node provides.",
+ "description" : "Amount of memory this NUMA node provides.",
"optional" : 1,
"type" : "number"
},
"policy" : {
- "description" : "numa allocation policy.",
+ "description" : "NUMA allocation policy.",
"enum" : [
"preferred",
"bind",
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]"
},
"onboot" : {
"default" : 0,
"type" : "boolean"
},
"ostype" : {
- "description" : "Used to enable special optimization/features for specific\noperating systems:\n\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\nl24 => Linux 2.4 Kernel\nl26 => Linux 2.6/3.X Kernel\nsolaris => solaris/opensolaris/openindiania kernel\n\nother|l24|l26|solaris ... no special behaviour\nwxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch\n",
+ "description" : "Specify guest operating system.",
"enum" : [
"other",
"wxp",
"solaris"
],
"optional" : 1,
- "type" : "string"
+ "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\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
},
"parallel[n]" : {
- "description" : "Map host parallel devices (n is 0 to 2).\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nExperimental: user reported problems with this option.\n",
+ "description" : "Map host parallel devices (n is 0 to 2).",
"optional" : 1,
"pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+",
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "Map host parallel devices (n is 0 to 2).\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
},
"protection" : {
"default" : 0,
- "description" : "Sets the protection flag of the VM. This will prevent the remove operation.",
+ "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.",
"optional" : 1,
"type" : "boolean"
},
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
},
"scsi[n]" : {
"description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
},
"scsihw" : {
"default" : "lsi",
- "description" : "scsi controller model",
+ "description" : "SCSI controller model",
"enum" : [
"lsi",
"lsi53c810",
"type" : "string"
},
"serial[n]" : {
- "description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a host serial device (i.e. /dev/ttyS0), or create a unix socket on the host side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nExperimental: user reported problems with this option.\n",
+ "description" : "Create a serial device inside the VM (n is 0 to 3)",
"optional" : 1,
"pattern" : "(/dev/.+|socket)",
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
},
"shares" : {
"default" : 1000,
"maximum" : 50000,
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-50000)"
},
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"format" : "pve-qm-smbios1",
"maxLength" : 256,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]"
},
"smp" : {
"default" : 1,
"description" : "The number of CPUs. Please use option -sockets instead.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"sockets" : {
"default" : 1,
"description" : "The number of CPU sockets.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"startdate" : {
"default" : "now",
},
"tablet" : {
"default" : 1,
- "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).",
+ "description" : "Enable/disable the USB tablet device.",
"optional" : 1,
- "type" : "boolean"
+ "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)."
},
"tdf" : {
"default" : 0,
"type" : "boolean"
},
"unused[n]" : {
- "description" : "Reference to unused volumes.",
+ "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
"format" : "pve-volume-id",
"optional" : 1,
"type" : "string"
},
"usb[n]" : {
- "description" : "Configure an USB device (n is 0 to 4). This can be used to\npass-through usb devices to the guest. HOSTUSBDEVICE syntax is:\n\n'bus-port(.port)*' (decimal numbers) or\n'vendor_id:product_id' (hexadeciaml numbers) or\n'spice'\n\nYou can use the 'lsusb -t' command to list existing usb devices.\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n\nThe 'usb3' option determines whether the device is a USB3 device or not (this does currently not work reliably with spice redirection and is then ignored).\n\n",
+ "description" : "Configure an USB device (n is 0 to 4).",
"format" : {
"host" : {
"default_key" : 1,
- "description" : "The Host USB device or port or the value spice",
+ "description" : "The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:\n\n 'bus-port(.port)*' (decimal numbers) or\n 'vendor_id:product_id' (hexadeciaml numbers) or\n 'spice'\n\nYou can use the 'lsusb -t' command to list existing usb devices.\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n",
"format" : "pve-qm-usb-device",
"format_description" : "HOSTUSBDEVICE|spice",
"type" : "string"
},
"usb3" : {
- "description" : "Specifies whether if given host option is a USB3 device or port",
+ "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).",
"optional" : 1,
"type" : "boolean"
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]"
},
"vcpus" : {
"default" : 0,
"description" : "Number of hotplugged vcpus.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"vga" : {
- "description" : "Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal.",
+ "description" : "Select the VGA type.",
"enum" : [
"std",
"cirrus",
"qxl4"
],
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal."
},
"virtio[n]" : {
"description" : "Use volume as VIRTIO hard disk (n is 0 to 15).",
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"watchdog" : {
- "description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)",
+ "description" : "Create a virtual hardware watchdog device.",
"format" : "pve-qm-watchdog",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]",
+ "verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"websocket" : {
"description" : "starts websockify instead of vncproxy",
"description" : "Port number returned by previous vncproxy call.",
"maximum" : 5999,
"minimum" : 5900,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (5900-5999)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"vncticket" : {
"description" : "Ticket from previous call to vncproxy.",
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "Wait maximal timeout seconds.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "Wait maximal timeout seconds.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "VMID for the clone.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"node" : {
"description" : "The cluster node name.",
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"vmstate" : {
"description" : "Save the vmstate",
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"type" : "string"
},
"args" : {
- "description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n",
+ "description" : "Arbitrary arguments passed to kvm.",
"optional" : 1,
- "type" : "string"
+ "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"
},
"autostart" : {
"default" : 0,
"description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"bios" : {
"default" : "seabios",
"description" : "The number of cores per socket.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"cpu" : {
"description" : "Emulated CPU type.",
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[cputype=]<cputype> [,hidden=<1|0>]"
},
"cpulimit" : {
"default" : 0,
- "description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit.",
+ "description" : "Limit of CPU usage.",
"maximum" : 128,
"minimum" : 0,
"optional" : 1,
- "type" : "number"
+ "type" : "number",
+ "typetext" : "number (0-128)",
+ "verbose_description" : "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit."
},
"cpuunits" : {
"default" : 1000,
- "description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0.",
+ "description" : "CPU weight for a VM.",
"maximum" : 500000,
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-500000)",
+ "verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0."
},
"description" : {
"description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.",
"type" : "boolean"
},
"hostpci[n]" : {
- "description" : "Map host pci devices. HOSTPCIDEVICE syntax is:\n\n'bus:dev.func' (hexadecimal numbers)\n\nYou can us the 'lspci' command to list existing pci devices.\n\nThe 'rombar' option determines whether or not the device's ROM will be visible in the guest's memory map (default is 'on').\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nExperimental: user reported problems with this option.\n",
+ "description" : "Map host PCI devices into guest.",
"format" : "pve-qm-hostpci",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,pcie=<1|0>] [,rombar=<1|0>] [,x-vga=<1|0>]",
+ "verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer \npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
},
"hotplug" : {
"default" : "network,disk,usb",
"optional" : 1,
"type" : "string"
},
+ "hugepages" : {
+ "description" : "Enable/disable hugepages memory.",
+ "enum" : [
+ "any",
+ "2",
+ "1024"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"ide[n]" : {
"description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3).",
"format" : {
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
},
"keyboard" : {
"default" : "en-us",
- "description" : "Keybord layout for vnc server. Default is read from the datacenter configuration file.",
+ "description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.conf' configuration file.",
"enum" : [
"de",
"de-ch",
"description" : "Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device.",
"minimum" : 16,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (16- N)"
},
"migrate_downtime" : {
"default" : 0.1,
"description" : "Set maximum tolerated downtime (in seconds) for migrations.",
"minimum" : 0,
"optional" : 1,
- "type" : "number"
+ "type" : "number",
+ "typetext" : "number (0- N)"
},
"migrate_speed" : {
"default" : 0,
"description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"name" : {
"description" : "Set a name for the VM. Only used on the configuration web interface.",
"type" : "string"
},
"net[n]" : {
- "description" : "Specify network devices.\n\nMODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3\n\nXX:XX:XX:XX:XX:XX should be an unique MAC address. This is\nautomatically generated if not specified.\n\nThe bridge parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'.\n\nOption 'rate' is used to limit traffic bandwidth from and to this interface. It is specified as floating point number, unit is 'Megabytes per second'.\n\nIf you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services. The following addresses are used:\n\n10.0.2.2 Gateway\n10.0.2.3 DNS Server\n10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n\n",
+ "description" : "Specify network devices.",
"format" : {
"bridge" : {
- "description" : "Bridge to attach the network device to.",
+ "description" : "Bridge to attach the network device to. The Proxmox VE standard bridge\nis called 'vmbr0'.\n\nIf you do not specify a bridge, we create a kvm user (NATed) network\ndevice, which provides DHCP and DNS services. The following addresses\nare used:\n\n 10.0.2.2 Gateway\n 10.0.2.3 DNS Server\n 10.0.2.4 SMB Server\n\nThe DHCP server assign addresses to the guest starting from 10.0.2.15.\n",
"format_description" : "bridge",
"optional" : 1,
"type" : "string"
"keyAlias" : "model"
},
"link_down" : {
- "description" : "Whether this interface should be DISconnected (like pulling the plug).",
+ "description" : "Whether this interface should be disconnected (like pulling the plug).",
"optional" : 1,
"type" : "boolean"
},
"macaddr" : {
- "description" : "MAC address",
+ "description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
"format_description" : "XX:XX:XX:XX:XX:XX",
- "keyAlias" : "model",
"optional" : 1,
"pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
"type" : "string"
},
"model" : {
"default_key" : 1,
- "description" : "Network Card Model.",
+ "description" : "Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.",
"enum" : [
"rtl8139",
"ne2k_pci",
"type" : "integer"
},
"rate" : {
- "description" : "Rate limit in mbps as floating point number.",
+ "description" : "Rate limit in mbps (megabytes per second) as floating point number.",
"minimum" : 0,
"optional" : 1,
"type" : "number"
"tag" : {
"description" : "VLAN tag to apply to packets on this interface.",
"maximum" : 4094,
- "minimum" : 2,
+ "minimum" : 1,
"optional" : 1,
"type" : "integer"
},
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[model=]<model> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
},
"node" : {
"description" : "The cluster node name.",
"type" : "boolean"
},
"numa[n]" : {
- "description" : "numa topology",
+ "description" : "NUMA topology.",
"format" : {
"cpus" : {
- "description" : "CPUs accessing this numa node.",
+ "description" : "CPUs accessing this NUMA node.",
"format_description" : "id[-id];...",
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string"
},
"hostnodes" : {
- "description" : "host numa nodes to use",
+ "description" : "Host NUMA nodes to use.",
"format_description" : "id[-id];...",
"optional" : 1,
"pattern" : "(?^:\\d+(?:-\\d+)?(?:;\\d+(?:-\\d+)?)*)",
"type" : "string"
},
"memory" : {
- "description" : "Amount of memory this numa node provides.",
+ "description" : "Amount of memory this NUMA node provides.",
"optional" : 1,
"type" : "number"
},
"policy" : {
- "description" : "numa allocation policy.",
+ "description" : "NUMA allocation policy.",
"enum" : [
"preferred",
"bind",
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "cpus=<id[-id];...> [,hostnodes=<id[-id];...>] [,memory=<number>] [,policy=<preferred|bind|interleave>]"
},
"onboot" : {
"default" : 0,
"type" : "boolean"
},
"ostype" : {
- "description" : "Used to enable special optimization/features for specific\noperating systems:\n\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\nl24 => Linux 2.4 Kernel\nl26 => Linux 2.6/3.X Kernel\nsolaris => solaris/opensolaris/openindiania kernel\n\nother|l24|l26|solaris ... no special behaviour\nwxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch\n",
+ "description" : "Specify guest operating system.",
"enum" : [
"other",
"wxp",
"solaris"
],
"optional" : 1,
- "type" : "string"
+ "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\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
},
"parallel[n]" : {
- "description" : "Map host parallel devices (n is 0 to 2).\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nExperimental: user reported problems with this option.\n",
+ "description" : "Map host parallel devices (n is 0 to 2).",
"optional" : 1,
"pattern" : "/dev/parport\\d+|/dev/usb/lp\\d+",
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "Map host parallel devices (n is 0 to 2).\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
},
"pool" : {
"description" : "Add the VM to the specified pool.",
},
"protection" : {
"default" : 0,
- "description" : "Sets the protection flag of the VM. This will prevent the remove operation.",
+ "description" : "Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.",
"optional" : 1,
"type" : "boolean"
},
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
},
"scsi[n]" : {
"description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
},
"scsihw" : {
"default" : "lsi",
- "description" : "scsi controller model",
+ "description" : "SCSI controller model",
"enum" : [
"lsi",
"lsi53c810",
"type" : "string"
},
"serial[n]" : {
- "description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a host serial device (i.e. /dev/ttyS0), or create a unix socket on the host side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nExperimental: user reported problems with this option.\n",
+ "description" : "Create a serial device inside the VM (n is 0 to 3)",
"optional" : 1,
"pattern" : "(/dev/.+|socket)",
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "Create a serial device inside the VM (n is 0 to 3), and pass through a\nhost serial device (i.e. /dev/ttyS0), or create a unix socket on the\nhost side (use 'qm terminal' to open a terminal connection).\n\nNOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
},
"shares" : {
"default" : 1000,
"maximum" : 50000,
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-50000)"
},
"smbios1" : {
"description" : "Specify SMBIOS type 1 fields.",
"format" : "pve-qm-smbios1",
"maxLength" : 256,
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[family=<string>] [,manufacturer=<string>] [,product=<string>] [,serial=<string>] [,sku=<string>] [,uuid=<UUID>] [,version=<string>]"
},
"smp" : {
"default" : 1,
"description" : "The number of CPUs. Please use option -sockets instead.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"sockets" : {
"default" : 1,
"description" : "The number of CPU sockets.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"startdate" : {
"default" : "now",
},
"tablet" : {
"default" : 1,
- "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).",
+ "description" : "Enable/disable the USB tablet device.",
"optional" : 1,
- "type" : "boolean"
+ "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)."
},
"tdf" : {
"default" : 0,
"type" : "boolean"
},
"unused[n]" : {
- "description" : "Reference to unused volumes.",
+ "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
"format" : "pve-volume-id",
"optional" : 1,
"type" : "string"
},
"usb[n]" : {
- "description" : "Configure an USB device (n is 0 to 4). This can be used to\npass-through usb devices to the guest. HOSTUSBDEVICE syntax is:\n\n'bus-port(.port)*' (decimal numbers) or\n'vendor_id:product_id' (hexadeciaml numbers) or\n'spice'\n\nYou can use the 'lsusb -t' command to list existing usb devices.\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n\nThe 'usb3' option determines whether the device is a USB3 device or not (this does currently not work reliably with spice redirection and is then ignored).\n\n",
+ "description" : "Configure an USB device (n is 0 to 4).",
"format" : {
"host" : {
"default_key" : 1,
- "description" : "The Host USB device or port or the value spice",
+ "description" : "The Host USB device or port or the value 'spice'. HOSTUSBDEVICE syntax is:\n\n 'bus-port(.port)*' (decimal numbers) or\n 'vendor_id:product_id' (hexadeciaml numbers) or\n 'spice'\n\nYou can use the 'lsusb -t' command to list existing usb devices.\n\nNOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.\n\nThe value 'spice' can be used to add a usb redirection devices for spice.\n",
"format" : "pve-qm-usb-device",
"format_description" : "HOSTUSBDEVICE|spice",
"type" : "string"
},
"usb3" : {
- "description" : "Specifies whether if given host option is a USB3 device or port",
+ "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).",
"optional" : 1,
"type" : "boolean"
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[host=]<HOSTUSBDEVICE|spice> [,usb3=<1|0>]"
},
"vcpus" : {
"default" : 0,
"description" : "Number of hotplugged vcpus.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"vga" : {
- "description" : "Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal.",
+ "description" : "Select the VGA type.",
"enum" : [
"std",
"cirrus",
"qxl4"
],
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "Select the VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use the options 'std' or 'vmware'. Default is 'std' for win8/win7/w2k8, and 'cirrus' for other OS types. The 'qxl' option enables the SPICE display sever. For win* OS you can select how many independent displays you want, Linux guests can add displays them self. You can also run without any graphic card, using a serial device as terminal."
},
"virtio[n]" : {
"description" : "Use volume as VIRTIO hard disk (n is 0 to 15).",
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_rd=<bps>] [,bps_wr=<bps>] [,cache=<none|writethrough|writeback|unsafe|directsync>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<image format>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enospc|ignore|report|stop>]"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"watchdog" : {
- "description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)",
+ "description" : "Create a virtual hardware watchdog device.",
"format" : "pve-qm-watchdog",
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[[model=]<i6300esb|ib700>] [,action=<reset|shutdown|poweroff|pause|debug|none>]",
+ "verbose_description" : "Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"maximum" : 128,
"minimum" : 0,
"optional" : 1,
- "type" : "number"
+ "type" : "number",
+ "typetext" : "number (0-128)"
},
"cpuunits" : {
"default" : 1024,
"maximum" : 500000,
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-500000)"
},
"delete" : {
"description" : "A list of settings you want to delete.",
"description" : "Amount of RAM for the VM in MB.",
"minimum" : 16,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (16- N)"
},
"mp[n]" : {
- "description" : "Use volume as container mount point (experimental feature).",
+ "description" : "Use volume as container mount point.",
"format" : {
"acl" : {
"description" : "Explicitly enable or disable ACL support.",
"backup" : {
"description" : "Whether to include the mountpoint in backups.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "verbose_description" : "Whether to include the mountpoint in backups (only used for volume mountpoints)."
},
"mp" : {
- "description" : "Path to the mountpoint as seen from inside the container.",
+ "description" : "Path to the mountpoint as seen from inside the container (must not contain symlinks).",
"format" : "pve-lxc-mp-string",
"format_description" : "Path",
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "Path to the mountpoint as seen from inside the container.\n\nNOTE: Must not contain any symlinks for security reasons."
},
"quota" : {
"description" : "Enable user quotas inside the container (not supported with zfs subvolumes)",
"type" : "boolean"
},
"ro" : {
- "description" : "Read-only mountpoint (not supported with bind mounts)",
+ "description" : "Read-only mountpoint",
"optional" : 1,
"type" : "boolean"
},
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<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.",
},
"tag" : {
"description" : "VLAN tag for this interface.",
- "maximum" : "4094",
- "minimum" : "2",
+ "maximum" : 4094,
+ "minimum" : 1,
"optional" : 1,
"type" : "integer"
},
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]"
},
"node" : {
"description" : "The cluster node name.",
"opensuse",
"archlinux",
"alpine",
+ "gentoo",
"unmanaged"
],
"optional" : 1,
"optional" : 1,
"type" : "boolean"
},
- "backup" : {
- "description" : "Whether to include the mountpoint in backups.",
- "optional" : 1,
- "type" : "boolean"
- },
"quota" : {
"description" : "Enable user quotas inside the container (not supported with zfs subvolumes)",
"optional" : 1,
"type" : "boolean"
},
"ro" : {
- "description" : "Read-only mountpoint (not supported with bind mounts)",
+ "description" : "Read-only mountpoint",
"optional" : 1,
"type" : "boolean"
},
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<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.",
"description" : "Amount of SWAP for the VM in MB.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"template" : {
"default" : 0,
"maximum" : 6,
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-6)"
},
"unprivileged" : {
"default" : 0,
"type" : "boolean"
},
"unused[n]" : {
- "description" : "Reference to unused volumes.",
+ "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
"format" : "pve-volume-id",
"optional" : 1,
"type" : "string"
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "Wait maximal timeout seconds.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"enable" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"description" : "Move rule to new position <moveto>. Other arguments are ignored.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"node" : {
"description" : "The cluster node name.",
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"enable" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"limit" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"node" : {
"description" : "The cluster node name.",
"start" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"websocket" : {
"description" : "use websocket instead of standard VNC.",
"description" : "Port number returned by previous vncproxy call.",
"maximum" : 5999,
"minimum" : 5900,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (5900-5999)"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"vncticket" : {
"description" : "Ticket from previous call to vncproxy.",
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "VMID for the clone.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"node" : {
"description" : "The cluster node name.",
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"maximum" : 128,
"minimum" : 0,
"optional" : 1,
- "type" : "number"
+ "type" : "number",
+ "typetext" : "number (0-128)"
},
"cpuunits" : {
"default" : 1024,
"maximum" : 500000,
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-500000)"
},
"description" : {
"description" : "Container description. Only used on the configuration web interface.",
"description" : "Amount of RAM for the VM in MB.",
"minimum" : 16,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (16- N)"
},
"mp[n]" : {
- "description" : "Use volume as container mount point (experimental feature).",
+ "description" : "Use volume as container mount point.",
"format" : {
"acl" : {
"description" : "Explicitly enable or disable ACL support.",
"backup" : {
"description" : "Whether to include the mountpoint in backups.",
"optional" : 1,
- "type" : "boolean"
+ "type" : "boolean",
+ "verbose_description" : "Whether to include the mountpoint in backups (only used for volume mountpoints)."
},
"mp" : {
- "description" : "Path to the mountpoint as seen from inside the container.",
+ "description" : "Path to the mountpoint as seen from inside the container (must not contain symlinks).",
"format" : "pve-lxc-mp-string",
"format_description" : "Path",
- "type" : "string"
+ "type" : "string",
+ "verbose_description" : "Path to the mountpoint as seen from inside the container.\n\nNOTE: Must not contain any symlinks for security reasons."
},
"quota" : {
"description" : "Enable user quotas inside the container (not supported with zfs subvolumes)",
"type" : "boolean"
},
"ro" : {
- "description" : "Read-only mountpoint (not supported with bind mounts)",
+ "description" : "Read-only mountpoint",
"optional" : 1,
"type" : "boolean"
},
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,ro=<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.",
},
"tag" : {
"description" : "VLAN tag for this interface.",
- "maximum" : "4094",
- "minimum" : "2",
+ "maximum" : 4094,
+ "minimum" : 1,
"optional" : 1,
"type" : "integer"
},
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]"
},
"node" : {
"description" : "The cluster node name.",
"opensuse",
"archlinux",
"alpine",
+ "gentoo",
"unmanaged"
],
"optional" : 1,
"optional" : 1,
"type" : "boolean"
},
- "backup" : {
- "description" : "Whether to include the mountpoint in backups.",
- "optional" : 1,
- "type" : "boolean"
- },
"quota" : {
"description" : "Enable user quotas inside the container (not supported with zfs subvolumes)",
"optional" : 1,
"type" : "boolean"
},
"ro" : {
- "description" : "Read-only mountpoint (not supported with bind mounts)",
+ "description" : "Read-only mountpoint",
"optional" : 1,
"type" : "boolean"
},
}
},
"optional" : 1,
- "type" : "string"
+ "type" : "string",
+ "typetext" : "[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,ro=<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.",
"description" : "Amount of SWAP for the VM in MB.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"template" : {
"default" : 0,
"maximum" : 6,
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-6)"
},
"unprivileged" : {
"default" : 0,
"type" : "boolean"
},
"unused[n]" : {
- "description" : "Reference to unused volumes.",
+ "description" : "Reference to unused volumes. This is used internally, and should not be modified manually.",
"format" : "pve-volume-id",
"optional" : 1,
"type" : "string"
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"maximum" : 14,
"minimum" : 6,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (6-14)"
},
"size" : {
"default" : 2,
"maximum" : 3,
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1-3)"
}
}
},
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "force" : {
+ "default" : 0,
+ "description" : "If true, destroys pool even if in use",
+ "optional" : 1,
+ "type" : "boolean"
+ },
"name" : {
"description" : "The name of the pool. It must be unique.",
"type" : "string"
"maximum" : 32768,
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-32768)"
},
"min_size" : {
"default" : 1,
"maximum" : 3,
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1-3)"
},
"name" : {
"description" : "The name of the pool. It must be unique.",
"maximum" : 32768,
"minimum" : 8,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (8-32768)"
},
"size" : {
"default" : 2,
"maximum" : 3,
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1-3)"
}
}
},
"limit" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"node" : {
"description" : "The cluster node name.",
"start" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
}
}
},
"text" : "ceph"
},
{
+ "children" : [
+ {
+ "info" : {
+ "GET" : {
+ "description" : "Extract configuration from vzdump backup archive.",
+ "method" : "GET",
+ "name" : "extractconfig",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string"
+ },
+ "volume" : {
+ "description" : "Volume identifier",
+ "type" : "string"
+ }
+ }
+ },
+ "permissions" : {
+ "description" : "The user needs 'VM.Backup' permissions on the backed up guest ID, and 'Datastore.AllocateSpace' on the backup storage.",
+ "user" : "all"
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "string"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/vzdump/extractconfig",
+ "text" : "extractconfig"
+ }
+ ],
"info" : {
"POST" : {
"description" : "Create backup.",
"description" : "Limit I/O bandwidth (KBytes per second).",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"compress" : {
"default" : "0",
"maximum" : 8,
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-8)"
},
"lockwait" : {
"default" : 180,
"description" : "Maximal time to wait for the global lock (minutes).",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"mailnotification" : {
"default" : "always",
"description" : "Maximal number of backup files per guest system.",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"mode" : {
"default" : "snapshot",
"description" : "Unused, will be removed in a future release.",
"minimum" : 500,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (500- N)"
},
"stdexcludes" : {
"default" : 1,
"description" : "Maximal time to wait until a guest system is stopped (minutes).",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"storage" : {
"description" : "Store resulting file to this storage.",
}
}
},
- "leaf" : 1,
+ "leaf" : 0,
"path" : "/nodes/{node}/vzdump",
"text" : "vzdump"
},
"minimum" : 0,
"optional" : 1,
"requires" : "address6",
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-128)"
},
"node" : {
"description" : "The cluster node name.",
"maximum" : 4094,
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1-4094)"
},
"slaves" : {
"description" : "Specify the interfaces used by the bonding device.",
"minimum" : 0,
"optional" : 1,
"requires" : "address6",
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0-128)"
},
"node" : {
"description" : "The cluster node name.",
"maximum" : 4094,
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1-4094)"
},
"slaves" : {
"description" : "Specify the interfaces used by the bonding device.",
"limit" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"node" : {
"description" : "The cluster node name.",
"start" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"upid" : {
"type" : "string"
"limit" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"node" : {
"description" : "The cluster node name.",
"start" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"userfilter" : {
"optional" : 1,
"format" : "pve-vmid",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"format" : "pve-vmid",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "Specify owner VM",
"format" : "pve-vmid",
"minimum" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
}
}
},
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
}
}
},
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
}
}
},
"enable" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"description" : "Move rule to new position <moveto>. Other arguments are ignored.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"node" : {
"description" : "The cluster node name.",
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"enable" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"iface" : {
"description" : "Network interface name. You have to use network configuration key names for VMs and containers ('net\\d+'). Host related rules can use arbitrary strings.",
"description" : "Update rule at position <pos>.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"proto" : {
"description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.",
"description" : "Maximum number of tracked connections.",
"minimum" : 32768,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (32768- N)"
},
"nf_conntrack_tcp_timeout_established" : {
"description" : "Conntrack established timeout.",
"minimum" : 7875,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (7875- N)"
},
"node" : {
"description" : "The cluster node name.",
"limit" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"node" : {
"description" : "The cluster node name.",
"start" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
}
}
},
"limit" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"node" : {
"description" : "The cluster node name.",
"start" : {
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"until" : {
"description" : "Display all log until this date-time string.",
"description" : "Port number returned by previous vncproxy call.",
"maximum" : 5999,
"minimum" : 5900,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (5900-5999)"
},
"vncticket" : {
"description" : "Ticket from previous call to vncproxy.",
"type" : "string"
},
"storage" : {
- "description" : "Only list status for specified storage",
+ "description" : "The storage where the template will be stored",
"format" : "pve-storage-id",
"type" : "string"
},
"description" : "Maximal number of parallel migration job. If not set use 'max_workers' from datacenter.cfg, one of both must be set!",
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1- N)"
},
"node" : {
"description" : "The cluster node name.",
"description" : "Maximal number of backup files per VM. Use '0' for unlimted.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
+ },
+ "mkdir" : {
+ "default" : "yes",
+ "description" : "Create the directory if it doesn't exist.",
+ "optional" : 1,
+ "type" : "boolean"
},
"nodes" : {
"description" : "List of cluster node names.",
"maximum" : 16,
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1-16)"
},
"saferemove" : {
"description" : "Zero-out data when removing LVs.",
"format" : "pve-storage-id",
"type" : "string"
},
+ "tagged_only" : {
+ "description" : "Only use logical volumes tagged with 'pve-vm-ID'.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
"transport" : {
"description" : "Gluster transport: tcp or rdma",
"enum" : [
"description" : "Maximal number of backup files per VM. Use '0' for unlimted.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
+ },
+ "mkdir" : {
+ "default" : "yes",
+ "description" : "Create the directory if it doesn't exist.",
+ "optional" : 1,
+ "type" : "boolean"
},
"monhost" : {
"description" : "Monitors daemon ips.",
+ "format" : "pve-storage-portal-dns-list",
"optional" : 1,
"type" : "string"
},
"maximum" : 16,
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1-16)"
},
"saferemove" : {
"description" : "Zero-out data when removing LVs.",
"format" : "pve-storage-id",
"type" : "string"
},
+ "tagged_only" : {
+ "description" : "Only use logical volumes tagged with 'pve-vm-ID'.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
"target" : {
"description" : "iSCSI target.",
"optional" : 1,
"description" : "Account expiration date (seconds since epoch). '0' means no expiration date.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"firstname" : {
"optional" : 1,
"description" : "Account expiration date (seconds since epoch). '0' means no expiration date.",
"minimum" : 0,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (0- N)"
},
"firstname" : {
"optional" : 1,
"pattern" : "\\w+=[^,]+(,\\s*\\w+=[^,]+)*",
"type" : "string"
},
+ "bind_dn" : {
+ "description" : "LDAP bind domain name",
+ "maxLength" : 256,
+ "optional" : 1,
+ "pattern" : "\\w+=[^,]+(,\\s*\\w+=[^,]+)*",
+ "type" : "string"
+ },
"comment" : {
"description" : "Description.",
"maxLength" : 4096,
"maximum" : 65535,
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1-65535)"
},
"realm" : {
"description" : "Authentication domain ID",
"pattern" : "\\w+=[^,]+(,\\s*\\w+=[^,]+)*",
"type" : "string"
},
+ "bind_dn" : {
+ "description" : "LDAP bind domain name",
+ "maxLength" : 256,
+ "optional" : 1,
+ "pattern" : "\\w+=[^,]+(,\\s*\\w+=[^,]+)*",
+ "type" : "string"
+ },
"comment" : {
"description" : "Description.",
"maxLength" : 4096,
"maximum" : 65535,
"minimum" : 1,
"optional" : 1,
- "type" : "integer"
+ "type" : "integer",
+ "typetext" : "integer (1-65535)"
},
"realm" : {
"description" : "Authentication domain ID",
projects / pve-docs.git / blobdiff