]>
git.proxmox.com Git - pve-docs.git/blob - api-viewer/apidata.js
25 "additionalProperties" : 0 28 "description" : "Cluster index." 49 "description" : "Directory index." , 54 "additionalProperties" : 0 78 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 79 "description" : "Security Group name." , 83 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 96 "description" : "List security groups." , 101 "additionalProperties" : 0 103 "name" : "list_security_groups" 111 "additionalProperties" : 0 , 115 "description" : "Security Group name." , 116 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 124 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 131 "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." , 132 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" 149 "name" : "create_security_group" , 150 "description" : "Create new security group." , 158 "path" : "/cluster/firewall/groups/{group}" , 162 "description" : "List rules." , 176 "description" : "Security Group name." , 177 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 182 "additionalProperties" : 0 184 "name" : "get_rules" , 205 "name" : "delete_security_group" , 207 "additionalProperties" : 0 , 212 "description" : "Security Group name." , 213 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 228 "description" : "Delete security group." , 237 "additionalProperties" : 0 , 241 "format" : "pve-iface" , 242 "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." , 253 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 258 "description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." , 261 "format" : "pve-fw-addr-spec" 264 "format" : "pve-fw-sport-spec" , 265 "description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 272 "description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." , 273 "format" : "pve-fw-addr-spec" 279 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 280 "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name." , 289 "format" : "pve-fw-dport-spec" , 290 "description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 310 "description" : "Security Group name." , 311 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 318 "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'." , 319 "format" : "pve-fw-protocol-spec" 323 "description" : "Update rule at position <pos>." , 329 "name" : "create_rule" , 343 "description" : "Create new rule." , 353 "additionalProperties" : 0 , 356 "format" : "pve-fw-sport-spec" , 357 "description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 363 "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." , 367 "format" : "pve-iface" 375 "format" : "pve-fw-protocol-spec" , 378 "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'." 381 "description" : "Update rule at position <pos>." , 390 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 391 "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name." , 400 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 408 "description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." , 409 "format" : "pve-fw-addr-spec" 412 "format" : "pve-fw-addr-spec" , 415 "description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." 418 "description" : "A list of settings you want to delete." , 421 "format" : "pve-configid-list" 428 "description" : "Move rule to new position <moveto>. Other arguments are ignored." , 436 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 437 "description" : "Security Group name." , 443 "description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 444 "format" : "pve-fw-dport-spec" 457 "name" : "update_rule" , 469 "description" : "Modify rule data." , 479 "description" : "Delete rule." , 492 "name" : "delete_rule" , 498 "description" : "Update rule at position <pos>." , 503 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 504 "description" : "Security Group name." , 511 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 515 "additionalProperties" : 0 532 "description" : "Update rule at position <pos>." , 538 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 539 "description" : "Security Group name." , 545 "additionalProperties" : 0 548 "description" : "Get single rule data." , 560 "path" : "/cluster/firewall/groups/{group}/{pos}" , 568 "path" : "/cluster/firewall/groups" 591 "name" : "get_rules" , 593 "additionalProperties" : 0 604 "description" : "List rules." , 610 "name" : "create_rule" , 614 "description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 617 "format" : "pve-fw-dport-spec" 637 "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name." , 638 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 647 "description" : "Update rule at position <pos>." , 653 "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'." , 656 "format" : "pve-fw-protocol-spec" 659 "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." , 664 "format" : "pve-iface" 671 "description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." , 674 "format" : "pve-fw-addr-spec" 677 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 683 "format" : "pve-fw-addr-spec" , 684 "description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." , 689 "format" : "pve-fw-sport-spec" , 690 "description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 695 "additionalProperties" : 0 701 "description" : "Create new rule." , 737 "additionalProperties" : 0 , 740 "description" : "Update rule at position <pos>." , 748 "description" : "Get single rule data." , 753 "name" : "update_rule" , 757 "description" : "A list of settings you want to delete." , 760 "format" : "pve-configid-list" 764 "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." , 767 "format" : "pve-iface" , 772 "description" : "Move rule to new position <moveto>. Other arguments are ignored." , 782 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 787 "format" : "pve-fw-addr-spec" , 790 "description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." 795 "description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 796 "format" : "pve-fw-sport-spec" 801 "description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." , 802 "format" : "pve-fw-addr-spec" 812 "description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 813 "format" : "pve-fw-dport-spec" 827 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 828 "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name." , 838 "description" : "Update rule at position <pos>." , 844 "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'." , 847 "format" : "pve-fw-protocol-spec" 850 "additionalProperties" : 0 854 "description" : "Modify rule data." , 879 "description" : "Delete rule." , 884 "additionalProperties" : 0 , 889 "description" : "Update rule at position <pos>." , 896 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 900 "name" : "delete_rule" , 905 "path" : "/cluster/firewall/rules/{pos}" , 911 "path" : "/cluster/firewall/rules" 914 "path" : "/cluster/firewall/ipset" , 919 "path" : "/cluster/firewall/ipset/{name}" , 923 "description" : "Delete IPSet" , 934 "additionalProperties" : 0 , 937 "description" : "IP set name." , 938 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 945 "name" : "delete_ipset" , 969 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 993 "name" : "get_ipset" , 995 "additionalProperties" : 0 , 998 "description" : "IP set name." , 999 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 1006 "description" : "List IPSet content" 1013 "name" : "create_ip" , 1015 "additionalProperties" : 0 , 1018 "format" : "IPorCIDRorAlias" , 1020 "description" : "Network/IP specification in CIDR format." 1028 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 1029 "description" : "IP set name." , 1048 "description" : "Add IP or Network to IPSet." , 1062 "description" : "Read IP or Network settings from IPSet." , 1074 "additionalProperties" : 0 , 1077 "description" : "Network/IP specification in CIDR format." , 1079 "format" : "IPorCIDRorAlias" 1085 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 1086 "description" : "IP set name." 1098 "additionalProperties" : 0 , 1106 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 1107 "description" : "IP set name." , 1116 "format" : "IPorCIDRorAlias" , 1117 "description" : "Network/IP specification in CIDR format." , 1121 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 1128 "name" : "update_ip" , 1138 "description" : "Update IP or Network settings" , 1142 "method" : "DELETE" , 1146 "description" : "Remove IP or Network from IPSet." , 1161 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 1166 "description" : "Network/IP specification in CIDR format." , 1168 "format" : "IPorCIDRorAlias" 1172 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 1173 "description" : "IP set name." , 1178 "additionalProperties" : 0 1180 "name" : "remove_ip" 1183 "path" : "/cluster/firewall/ipset/{name}/{cidr}" , 1197 "description" : "Create new IPSet" , 1199 "additionalProperties" : 0 , 1206 "description" : "IP set name." , 1207 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 1216 "description" : "Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet." , 1217 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 1222 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 1237 "name" : "create_ipset" 1252 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 1253 "description" : "IP set name." 1259 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 1272 "description" : "List IPSets" , 1273 "name" : "ipset_index" , 1275 "additionalProperties" : 0 1297 "description" : "Create IP or Network Alias." , 1299 "additionalProperties" : 0 , 1302 "description" : "Network/IP specification in CIDR format." , 1304 "format" : "IPorCIDR" 1310 "description" : "Alias name." , 1311 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" 1328 "name" : "create_alias" 1345 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 1362 "description" : "List aliases" , 1364 "additionalProperties" : 0 1375 "name" : "get_aliases" 1388 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 1394 "description" : "Alias name." , 1395 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 1399 "additionalProperties" : 0 1401 "name" : "remove_alias" , 1411 "description" : "Remove IP or Network alias." , 1423 "description" : "Update IP or Network alias." , 1426 "additionalProperties" : 0 , 1431 "description" : "Rename an existing alias." , 1432 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 1438 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 1439 "description" : "Alias name." , 1448 "description" : "Network/IP specification in CIDR format." , 1450 "format" : "IPorCIDR" 1456 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 1460 "name" : "update_alias" , 1473 "additionalProperties" : 0 , 1478 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 1479 "description" : "Alias name." , 1493 "name" : "read_alias" , 1494 "description" : "Read alias." , 1503 "path" : "/cluster/firewall/aliases/{name}" 1507 "path" : "/cluster/firewall/aliases" 1512 "description" : "Set Firewall options." , 1519 "description" : "Output policy." , 1529 "description" : "A list of settings you want to delete." , 1530 "format" : "pve-configid-list" 1535 "description" : "Enable or disable the firewall cluster wide." , 1542 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 1547 "description" : "Input policy." , 1555 "additionalProperties" : 0 1557 "name" : "set_options" , 1583 "additionalProperties" : 0 1585 "name" : "get_options" , 1586 "description" : "Get Firewall options." , 1594 "description" : "Input policy." , 1602 "description" : "Enable or disable the firewall cluster wide." , 1610 "description" : "Output policy." , 1623 "path" : "/cluster/firewall/options" 1628 "description" : "List available macros" , 1629 "name" : "get_macros" , 1634 "additionalProperties" : 0 1643 "description" : "More verbose description (if available)." 1646 "description" : "Macro name." , 1657 "path" : "/cluster/firewall/macros" 1661 "path" : "/cluster/firewall/refs" , 1665 "additionalProperties" : 0 , 1668 "description" : "Only list references of specified type." , 1688 "description" : "Lists possible IPSet/Alias reference which are allowed in source/dest properties." , 1721 "path" : "/cluster/firewall" 1729 "description" : "Delete vzdump backup job definition." , 1730 "name" : "delete_job" , 1732 "additionalProperties" : 0 , 1736 "description" : "The job ID." , 1750 "method" : "DELETE" , 1760 "name" : "update_job" , 1774 "description" : "Unused, will be removed in a future release." , 1782 "description" : "Only run if executed on this node." , 1783 "format" : "pve-node" 1788 "description" : "Exclude specified guest systems (assumes --all)" , 1789 "format" : "pve-vmid-list" 1792 "format" : "pve-configid-list" , 1795 "description" : "A list of settings you want to delete." 1798 "description" : "Exclude temporary files and logs." , 1804 "format" : "string-alist" , 1807 "description" : "Exclude certain files/directories (shell globs)." 1810 "description" : "Enable or disable the job." , 1816 "format" : "pve-storage-id" , 1819 "description" : "Store resulting file to this storage." 1825 "description" : "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count." 1829 "description" : "Maximal time to wait until a guest system is stopped (minutes)." , 1835 "description" : "Be quiet." , 1840 "mailnotification" : { 1845 "description" : "Specify when to send an email" , 1848 "default" : "always" 1854 "description" : "Backup all known guest systems on this host." 1857 "description" : "The job ID." , 1865 "description" : "Remove old backup files if there are more than 'maxfiles' backup files." 1870 "description" : "Use specified hook script." 1877 "description" : "Maximal time to wait for the global lock (minutes)." 1882 "description" : "Comma-separated list of email addresses that should receive email notifications." , 1883 "format" : "string-list" 1886 "description" : "Store resulting files to specified directory." , 1891 "pattern" : " \\ d{1,2}: \\ d{1,2}" , 1892 "description" : "Job Start time." , 1894 "typetext" : "HH:MM" 1898 "description" : "Limit I/O bandwidth (KBytes per second)." , 1905 "description" : "Set CFQ ionice priority." , 1915 "description" : "Stop runnig backup jobs on this host." 1918 "description" : "Maximal number of backup files per guest system." , 1925 "description" : "Backup mode." , 1931 "default" : "snapshot" , 1939 "description" : "Compress dump file." , 1950 "description" : "Store temporary files to specified directory." 1953 "format" : "pve-vmid-list" , 1956 "description" : "The ID of the guest system you want to backup." 1959 "description" : "Day of week selection." , 1962 "format" : "pve-day-of-week-list" 1965 "additionalProperties" : 0 1968 "description" : "Update vzdump backup job definition." 1978 "description" : "The job ID." , 1983 "additionalProperties" : 0 1994 "name" : "read_job" , 1995 "description" : "Read vzdump backup job definition." 2000 "path" : "/cluster/backup/{id}" 2006 "description" : "Create new vzdump backup job." , 2008 "name" : "create_job" , 2024 "description" : "Maximal time to wait until a guest system is stopped (minutes)." , 2028 "description" : "Be quiet." , 2037 "description" : "Remove old backup files if there are more than 'maxfiles' backup files." 2039 "mailnotification" : { 2040 "description" : "Specify when to send an email" , 2045 "default" : "always" , 2050 "description" : "Backup all known guest systems on this host." , 2056 "description" : "Exclude specified guest systems (assumes --all)" , 2059 "format" : "pve-vmid-list" 2062 "description" : "Unused, will be removed in a future release." , 2071 "description" : "Only run if executed on this node." , 2072 "format" : "pve-node" 2078 "description" : "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count." 2081 "description" : "Exclude temporary files and logs." , 2089 "description" : "Exclude certain files/directories (shell globs)." , 2090 "format" : "string-alist" 2095 "description" : "Store resulting file to this storage." , 2096 "format" : "pve-storage-id" 2099 "description" : "Enable or disable the job." , 2109 "description" : "Maximal number of backup files per guest system." 2115 "description" : "Stop runnig backup jobs on this host." 2120 "description" : "Store temporary files to specified directory." 2132 "description" : "Compress dump file." 2137 "default" : "snapshot" , 2143 "description" : "Backup mode." 2146 "description" : "Limit I/O bandwidth (KBytes per second)." , 2158 "description" : "Set CFQ ionice priority." 2161 "format" : "pve-day-of-week-list" , 2162 "default" : "mon,tue,wed,thu,fri,sat,sun" , 2165 "description" : "Day of week selection." 2168 "description" : "The ID of the guest system you want to backup." , 2171 "format" : "pve-vmid-list" 2175 "description" : "Maximal time to wait for the global lock (minutes)." , 2183 "description" : "Use specified hook script." 2186 "description" : "Comma-separated list of email addresses that should receive email notifications." , 2189 "format" : "string-list" 2192 "description" : "Store resulting files to specified directory." , 2197 "typetext" : "HH:MM" , 2198 "description" : "Job Start time." , 2199 "pattern" : " \\ d{1,2}: \\ d{1,2}" , 2203 "additionalProperties" : 0 2229 "description" : "List vzdump backup schedule." , 2241 "additionalProperties" : 0 2245 "path" : "/cluster/backup" , 2249 "path" : "/cluster/ha" , 2273 "description" : "Maximal number of tries to restart the service on a node after its start failed." , 2282 "default" : "enabled" , 2287 "description" : "Resource state." 2293 "description" : "Maximal number of service relocate tries when a service failes to start." , 2299 "description" : "The HA group identifier." , 2300 "format" : "pve-configid" 2305 "description" : "Description." , 2313 "description" : "Resource type." , 2318 "format" : "pve-ha-resource-or-vm-id" , 2319 "typetext" : "<type>:<name>" , 2320 "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)." , 2324 "additionalProperties" : 0 , 2328 "description" : "Create a new HA resource." 2349 "description" : "List HA resources." , 2361 "additionalProperties" : 0 , 2370 "description" : "Only list resources of specific type" 2376 "text" : "resources" , 2382 "path" : "/cluster/ha/resources/{sid}/migrate" , 2391 "typetext" : "<type>:<name>" , 2392 "format" : "pve-ha-resource-or-vm-id" , 2394 "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)." 2397 "format" : "pve-node" , 2398 "description" : "The cluster node name." , 2402 "additionalProperties" : 0 2414 "description" : "Request resource migration (online) to another node." , 2423 "path" : "/cluster/ha/resources/{sid}/relocate" , 2425 "text" : "relocate" , 2428 "name" : "relocate" , 2430 "additionalProperties" : 0 , 2433 "format" : "pve-node" , 2434 "description" : "The cluster node name." , 2438 "typetext" : "<type>:<name>" , 2439 "format" : "pve-ha-resource-or-vm-id" , 2441 "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)." 2455 "description" : "Request resource relocatzion to another node. This stops the service on the old node, and restarts it on the target node." , 2471 "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)." , 2473 "format" : "pve-ha-resource-or-vm-id" , 2474 "typetext" : "<type>:<name>" 2477 "additionalProperties" : 0 2489 "description" : "Read resource configuration." 2497 "additionalProperties" : 0 , 2501 "format" : "pve-configid" , 2504 "description" : "The HA group identifier." 2511 "description" : "Maximal number of tries to restart the service on a node after its start failed." 2514 "description" : "A list of settings you want to delete." , 2517 "format" : "pve-configid-list" , 2521 "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)." , 2523 "format" : "pve-ha-resource-or-vm-id" , 2524 "typetext" : "<type>:<name>" 2527 "description" : "Description." , 2536 "description" : "Maximal number of service relocate tries when a service failes to start." , 2540 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 2550 "description" : "Resource state." , 2553 "default" : "enabled" 2567 "description" : "Update resource configuration." , 2572 "description" : "Delete resource configuration." , 2586 "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)." , 2588 "format" : "pve-ha-resource-or-vm-id" , 2589 "typetext" : "<type>:<name>" 2592 "additionalProperties" : 0 2594 "method" : "DELETE" , 2600 "path" : "/cluster/ha/resources/{sid}" , 2605 "path" : "/cluster/ha/resources" 2609 "path" : "/cluster/ha/groups" , 2613 "additionalProperties" : 0 2625 "description" : "Get HA groups." , 2650 "description" : "Create a new HA group." , 2656 "description" : "Description." , 2661 "description" : "Services on unrestricted groups may run on any cluster members if all group members are offline. But they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with one member." , 2670 "description" : "The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior." 2676 "description" : "Group type." , 2681 "description" : "List of cluster node names with optional priority. We use priority '0' as default. The CRM tries to run services on the node with highest priority (also see option 'nofailback')." , 2684 "format" : "pve-ha-group-node-list" , 2685 "typetext" : "<node>[:<pri>]{,<node>[:<pri>]}*" 2688 "format" : "pve-configid" , 2690 "description" : "The HA group identifier." 2694 "additionalProperties" : 0 2714 "description" : "Update ha group configuration." , 2717 "additionalProperties" : 0 , 2720 "format" : "pve-ha-group-node-list" , 2721 "typetext" : "<node>[:<pri>]{,<node>[:<pri>]}*" , 2722 "description" : "List of cluster node names with optional priority. We use priority '0' as default. The CRM tries to run services on the node with highest priority (also see option 'nofailback')." , 2727 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 2733 "description" : "The HA group identifier." , 2735 "format" : "pve-configid" 2741 "description" : "Description." 2747 "description" : "The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior." 2750 "description" : "Services on unrestricted groups may run on any cluster members if all group members are offline. But they will migrate back as soon as a group member comes online. One can implement a 'preferred node' behavior using an unrestricted group with one member." , 2756 "format" : "pve-configid-list" , 2760 "description" : "A list of settings you want to delete." 2780 "method" : "DELETE" , 2788 "description" : "The HA group identifier." , 2790 "format" : "pve-configid" 2793 "additionalProperties" : 0 2804 "description" : "Delete ha group configuration." , 2811 "description" : "The HA group identifier." , 2813 "format" : "pve-configid" 2816 "additionalProperties" : 0 2828 "description" : "Read ha group configuration." , 2835 "path" : "/cluster/ha/groups/{group}" 2849 "description" : "Get HA manger status." , 2861 "additionalProperties" : 0 2867 "path" : "/cluster/ha/status/current" 2876 "description" : "Get full HA manger status, including LRM status." , 2878 "additionalProperties" : 0 2880 "name" : "manager_status" , 2892 "text" : "manager_status" , 2894 "path" : "/cluster/ha/status/manager_status" 2913 "description" : "Directory index." , 2918 "additionalProperties" : 0 2923 "path" : "/cluster/ha/status" , 2929 "description" : "Directory index." , 2941 "additionalProperties" : 0 2965 "path" : "/cluster/log" , 2970 "description" : "Read cluster log" , 2975 "additionalProperties" : 0 , 2980 "description" : "Maximum number of entries." , 3008 "name" : "resources" , 3013 "additionalProperties" : 0 , 3026 "description" : "Resources index (cluster wide)." 3029 "text" : "resources" , 3031 "path" : "/cluster/resources" 3036 "description" : "List recent tasks (cluster wide)." , 3042 "additionalProperties" : 0 3060 "path" : "/cluster/tasks" 3064 "path" : "/cluster/options" , 3068 "additionalProperties" : 0 3079 "name" : "get_options" , 3080 "description" : "Get datacenter options." , 3097 "name" : "set_options" , 3099 "additionalProperties" : 0 , 3102 "default" : "watchdog" , 3105 "description" : "Set the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used. \n\n WARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP" , 3115 "description" : "Select the default Console viewer. You can either use the builtin java applet (VNC), an external virt-viewer comtatible application (SPICE), or an HTML5 based viewer (noVNC)." , 3123 "format" : "pve-configid-list" , 3124 "description" : "A list of settings you want to delete." , 3130 "description" : "Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager." , 3141 "description" : "Default GUI language." 3171 "description" : "Default keybord layout for vnc server." , 3178 "pattern" : "http://.*" , 3179 "description" : "Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')" 3182 "format" : "email-opt" , 3185 "description" : "Specify email address to send notification from (default is root@$hostname)" 3187 "migration_unsecure" : { 3190 "description" : "Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration." 3195 "description" : "Set datacenter options." , 3209 "additionalProperties" : 0 3211 "name" : "get_status" , 3221 "description" : "Get cluster status informations." , 3237 "path" : "/cluster/status" , 3246 "description" : "The next free VMID." 3248 "description" : "Get next free VMID. If you pass an VMID it will raise an error if the ID is already used." , 3252 "format" : "pve-vmid" , 3254 "description" : "The (unique) ID of the VM." , 3259 "additionalProperties" : 0 3269 "path" : "/cluster/nextid" 3296 "description" : "Node index." , 3298 "additionalProperties" : 0 , 3301 "format" : "pve-node" , 3302 "description" : "The cluster node name." , 3317 "path" : "/nodes/{node}/qemu/{vmid}" , 3322 "path" : "/nodes/{node}/qemu/{vmid}/firewall" , 3324 "text" : "firewall" , 3333 "method" : "DELETE" , 3338 "description" : "The cluster node name." , 3339 "format" : "pve-node" 3343 "format" : "pve-vmid" , 3344 "description" : "The (unique) ID of the VM." , 3350 "description" : "Update rule at position <pos>." , 3356 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 3360 "additionalProperties" : 0 3362 "name" : "delete_rule" , 3376 "description" : "Delete rule." , 3393 "description" : "Modify rule data." , 3398 "format" : "pve-fw-dport-spec" , 3399 "description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 3413 "format" : "pve-node" , 3415 "description" : "The cluster node name." 3421 "description" : "Move rule to new position <moveto>. Other arguments are ignored." 3428 "format" : "pve-configid-list" , 3429 "description" : "A list of settings you want to delete." , 3434 "format" : "pve-fw-addr-spec" , 3437 "description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." 3440 "description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." , 3443 "format" : "pve-fw-addr-spec" 3449 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 3457 "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name." , 3458 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 3467 "description" : "Update rule at position <pos>." , 3471 "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'." , 3474 "format" : "pve-fw-protocol-spec" 3477 "format" : "pve-vmid" , 3479 "description" : "The (unique) ID of the VM." , 3488 "format" : "pve-iface" , 3490 "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." , 3496 "format" : "pve-fw-sport-spec" , 3497 "description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 3502 "additionalProperties" : 0 3504 "name" : "update_rule" , 3517 "name" : "get_rule" , 3522 "description" : "The cluster node name." , 3523 "format" : "pve-node" 3529 "description" : "Update rule at position <pos>." 3532 "format" : "pve-vmid" , 3535 "description" : "The (unique) ID of the VM." 3538 "additionalProperties" : 0 3541 "description" : "Get single rule data." , 3553 "path" : "/nodes/{node}/qemu/{vmid}/firewall/rules/{pos}" , 3562 "description" : "Create new rule." , 3580 "description" : "Update rule at position <pos>." , 3584 "format" : "pve-fw-protocol-spec" , 3585 "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'." , 3590 "description" : "The (unique) ID of the VM." , 3592 "format" : "pve-vmid" , 3601 "description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 3604 "format" : "pve-fw-dport-spec" 3624 "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name." , 3625 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 3631 "description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 3632 "format" : "pve-fw-sport-spec" 3635 "format" : "pve-fw-addr-spec" , 3636 "description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." , 3641 "description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." , 3644 "format" : "pve-fw-addr-spec" 3647 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 3654 "description" : "The cluster node name." , 3655 "format" : "pve-node" 3664 "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." , 3666 "format" : "pve-iface" , 3670 "additionalProperties" : 0 3672 "name" : "create_rule" 3675 "description" : "List rules." , 3677 "name" : "get_rules" , 3679 "additionalProperties" : 0 , 3682 "format" : "pve-vmid" , 3684 "description" : "The (unique) ID of the VM." , 3688 "description" : "The cluster node name." , 3690 "format" : "pve-node" 3723 "path" : "/nodes/{node}/qemu/{vmid}/firewall/rules" , 3727 "path" : "/nodes/{node}/qemu/{vmid}/firewall/aliases" , 3738 "description" : "Read alias." , 3743 "description" : "The (unique) ID of the VM." , 3745 "format" : "pve-vmid" 3749 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 3750 "description" : "Alias name." , 3755 "format" : "pve-node" , 3757 "description" : "The cluster node name." 3760 "additionalProperties" : 0 3762 "name" : "read_alias" , 3786 "description" : "The (unique) ID of the VM." , 3788 "format" : "pve-vmid" , 3795 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 3798 "description" : "Network/IP specification in CIDR format." , 3800 "format" : "IPorCIDR" 3808 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 3809 "description" : "Rename an existing alias." , 3816 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 3817 "description" : "Alias name." , 3822 "description" : "The cluster node name." , 3824 "format" : "pve-node" 3827 "additionalProperties" : 0 3829 "name" : "update_alias" , 3831 "description" : "Update IP or Network alias." , 3838 "name" : "remove_alias" , 3840 "additionalProperties" : 0 , 3843 "format" : "pve-vmid" , 3845 "description" : "The (unique) ID of the VM." , 3852 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 3858 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 3859 "description" : "Alias name." 3863 "description" : "The cluster node name." , 3864 "format" : "pve-node" 3878 "description" : "Remove IP or Network alias." , 3885 "path" : "/nodes/{node}/qemu/{vmid}/firewall/aliases/{name}" , 3892 "description" : "Create IP or Network Alias." , 3897 "description" : "The (unique) ID of the VM." , 3899 "format" : "pve-vmid" , 3903 "format" : "IPorCIDR" , 3904 "description" : "Network/IP specification in CIDR format." , 3908 "format" : "pve-node" , 3909 "description" : "The cluster node name." , 3916 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 3917 "description" : "Alias name." 3924 "additionalProperties" : 0 3926 "name" : "create_alias" , 3957 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 3982 "name" : "get_aliases" , 3984 "additionalProperties" : 0 , 3988 "description" : "The (unique) ID of the VM." , 3989 "format" : "pve-vmid" , 3993 "format" : "pve-node" , 3994 "description" : "The cluster node name." , 3999 "description" : "List aliases" 4004 "path" : "/nodes/{node}/qemu/{vmid}/firewall/ipset" , 4009 "path" : "/nodes/{node}/qemu/{vmid}/firewall/ipset/{name}" , 4016 "name" : "create_ip" , 4031 "description" : "IP set name." , 4032 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" 4036 "description" : "The cluster node name." , 4037 "format" : "pve-node" 4040 "description" : "Network/IP specification in CIDR format." , 4042 "format" : "IPorCIDRorAlias" 4045 "format" : "pve-vmid" , 4047 "description" : "The (unique) ID of the VM." , 4051 "additionalProperties" : 0 4062 "description" : "Add IP or Network to IPSet." , 4066 "method" : "DELETE" , 4070 "description" : "Delete IPSet" , 4072 "name" : "delete_ipset" , 4083 "additionalProperties" : 0 , 4086 "format" : "pve-node" , 4088 "description" : "The cluster node name." 4092 "description" : "IP set name." , 4093 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 4098 "description" : "The (unique) ID of the VM." , 4100 "format" : "pve-vmid" , 4121 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 4139 "description" : "List IPSet content" , 4152 "format" : "pve-vmid" , 4154 "description" : "The (unique) ID of the VM." , 4159 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 4160 "description" : "IP set name." , 4165 "description" : "The cluster node name." , 4167 "format" : "pve-node" 4170 "additionalProperties" : 0 4172 "name" : "get_ipset" 4180 "method" : "DELETE" , 4189 "description" : "IP set name." , 4190 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 4194 "description" : "The cluster node name." , 4196 "format" : "pve-node" 4200 "format" : "pve-vmid" , 4202 "description" : "The (unique) ID of the VM." 4206 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 4211 "format" : "IPorCIDRorAlias" , 4213 "description" : "Network/IP specification in CIDR format." 4216 "additionalProperties" : 0 4218 "name" : "remove_ip" , 4229 "description" : "Remove IP or Network from IPSet." 4232 "description" : "Update IP or Network settings" , 4234 "name" : "update_ip" , 4247 "description" : "The (unique) ID of the VM." , 4249 "format" : "pve-vmid" , 4253 "format" : "IPorCIDRorAlias" , 4255 "description" : "Network/IP specification in CIDR format." 4258 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 4265 "description" : "The cluster node name." , 4266 "format" : "pve-node" 4269 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 4270 "description" : "IP set name." , 4284 "additionalProperties" : 0 4293 "additionalProperties" : 0 , 4297 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 4298 "description" : "IP set name." , 4303 "format" : "pve-node" , 4304 "description" : "The cluster node name." , 4308 "description" : "Network/IP specification in CIDR format." , 4310 "format" : "IPorCIDRorAlias" 4313 "description" : "The (unique) ID of the VM." , 4316 "format" : "pve-vmid" 4330 "description" : "Read IP or Network settings from IPSet." , 4340 "path" : "/nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr}" 4349 "description" : "Create new IPSet" , 4353 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 4359 "format" : "pve-vmid" , 4361 "description" : "The (unique) ID of the VM." , 4365 "format" : "pve-node" , 4366 "description" : "The cluster node name." , 4371 "description" : "IP set name." , 4372 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 4380 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 4381 "description" : "Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet." , 4389 "additionalProperties" : 0 4391 "name" : "create_ipset" , 4412 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 4413 "description" : "IP set name." , 4425 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 4439 "description" : "List IPSets" , 4450 "additionalProperties" : 0 , 4454 "description" : "The (unique) ID of the VM." , 4455 "format" : "pve-vmid" , 4460 "description" : "The cluster node name." , 4461 "format" : "pve-node" 4465 "name" : "ipset_index" 4473 "description" : "Set Firewall options." , 4488 "name" : "set_options" , 4490 "additionalProperties" : 0 , 4493 "description" : "Enable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added." , 4498 "description" : "The cluster node name." , 4500 "format" : "pve-node" 4505 "description" : "Allow sending Router Advertisement." 4513 "description" : "Output policy." , 4520 "description" : "A list of settings you want to delete." , 4521 "format" : "pve-configid-list" 4524 "description" : "Log level for incoming traffic." , 4540 "description" : "Enable DHCP." , 4547 "description" : "Enable NDP." 4552 "description" : "Input policy." , 4562 "description" : "Enable/disable MAC address filter." 4565 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 4571 "description" : "Enable/disable firewall rules." , 4576 "description" : "Log level for outgoing traffic." , 4592 "format" : "pve-vmid" , 4595 "description" : "The (unique) ID of the VM." 4614 "description" : "Output policy." 4628 "description" : "Log level for incoming traffic." , 4635 "description" : "Enable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added." 4638 "description" : "Allow sending Router Advertisement." , 4643 "description" : "Enable/disable MAC address filter." , 4653 "description" : "Input policy." , 4658 "description" : "Enable NDP." , 4665 "description" : "Enable DHCP." 4670 "description" : "Enable/disable firewall rules." 4673 "description" : "Log level for outgoing traffic." , 4690 "name" : "get_options" , 4692 "additionalProperties" : 0 , 4695 "description" : "The cluster node name." , 4697 "format" : "pve-node" 4700 "description" : "The (unique) ID of the VM." , 4703 "format" : "pve-vmid" 4717 "description" : "Get VM firewall options." 4720 "path" : "/nodes/{node}/qemu/{vmid}/firewall/options" , 4731 "description" : "Line text" , 4736 "description" : "Line number" 4744 "description" : "Read firewall log" , 4760 "format" : "pve-vmid" , 4762 "description" : "The (unique) ID of the VM." , 4772 "description" : "The cluster node name." , 4773 "format" : "pve-node" 4781 "additionalProperties" : 0 4785 "path" : "/nodes/{node}/qemu/{vmid}/firewall/log" , 4789 "path" : "/nodes/{node}/qemu/{vmid}/firewall/refs" , 4794 "description" : "Lists possible IPSet/Alias reference which are allowed in source/dest properties." , 4807 "format" : "pve-vmid" , 4810 "description" : "The (unique) ID of the VM." 4813 "format" : "pve-node" , 4814 "description" : "The cluster node name." , 4818 "description" : "Only list references of specified type." , 4827 "additionalProperties" : 0 4877 "description" : "The cluster node name." , 4878 "format" : "pve-node" 4881 "format" : "pve-vmid" , 4884 "description" : "The (unique) ID of the VM." 4887 "additionalProperties" : 0 4893 "description" : "Directory index." 4898 "path" : "/nodes/{node}/qemu/{vmid}/rrd" , 4905 "additionalProperties" : 0 , 4912 "description" : "The RRD consolidation function" , 4918 "description" : "The (unique) ID of the VM." , 4919 "format" : "pve-vmid" , 4923 "format" : "pve-node" , 4925 "description" : "The cluster node name." 4935 "description" : "Specify the time frame you are interested in." , 4939 "description" : "The list of datasources you want to display." , 4941 "format" : "pve-configid-list" 4954 "description" : "Read VM RRD statistics (returns PNG)" , 4970 "path" : "/nodes/{node}/qemu/{vmid}/rrddata" , 4974 "description" : "Read VM RRD statistics" , 4979 "format" : "pve-node" , 4981 "description" : "The cluster node name." 4992 "description" : "Specify the time frame you are interested in." 4996 "description" : "The (unique) ID of the VM." , 4997 "format" : "pve-vmid" , 5001 "description" : "The RRD consolidation function" , 5010 "additionalProperties" : 0 5035 "path" : "/nodes/{node}/qemu/{vmid}/config" , 5051 "VM.Config.Network" , 5060 "description" : "Set virtual machine options (asynchrounous API)." , 5065 "description" : "Limit of CPU usage. \n\n NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit." , 5073 "description" : "The cluster node name." , 5075 "format" : "pve-node" 5080 "description" : "Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal." , 5081 "requires" : "delete" 5087 "description" : "Enable/disable KVM hardware virtualization." 5090 "description" : "Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS." , 5095 "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit." , 5102 "pattern" : "(now| \\ d{4}- \\ d{1,2}- \\ d{1,2}(T \\ d{1,2}: \\ d{1,2}: \\ d{1,2})?)" , 5103 "description" : "Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'." , 5107 "typetext" : "(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)" 5112 "format_description" : "mbps" , 5113 "description" : "Maximum r/w speed speed in megabytes per second." , 5118 "format_description" : "count" , 5121 "description" : "Force the drive's physical geometry to have a specific cylinder count." 5124 "description" : "Maximum read speed speed in bytes per second." , 5127 "format_description" : "bps" 5130 "format_description" : "none|lba|auto" , 5138 "description" : "Force disk geometry bios translation mode." 5144 "format_description" : "iops" , 5145 "description" : "Maximum r/w I/O speed in operations per second." , 5151 "format_description" : "volume" , 5152 "format" : "pve-volume-id-or-qm-path" , 5154 "description" : "The drive's backing volume." 5159 "description" : "Maximum write speed speed in megabytes per second." , 5160 "format_description" : "mbps" 5163 "format_description" : "mbps" , 5164 "description" : "Maximum read speed speed in megabytes per second." , 5169 "format_description" : "on|off" , 5172 "description" : "Whether the drive should be included when making backups." 5177 "description" : "Maximum unthrottled write I/O pool speed in operations per second." , 5178 "format_description" : "iops" 5181 "format_description" : "native|threads" , 5182 "description" : "AIO type to use." , 5191 "format_description" : "enospc|ignore|report|stop" , 5200 "description" : "Write error action." 5203 "format" : "disk-size" , 5206 "description" : "Disk size. This is purely informational and has no effect." 5209 "format_description" : "iops" , 5212 "description" : "Maximum read I/O speed in operations per second." 5215 "format_description" : "mbps" , 5216 "description" : "Maximum unthrottled r/w pool speed in megabytes per second." , 5221 "format_description" : "bps" , 5224 "description" : "Maximum write speed speed in bytes per second." 5227 "format_description" : "mbps" , 5230 "description" : "Maximum unthrottled read pool speed in megabytes per second." 5237 "description" : "Controls whether to pass discard/trim requests to the underlying storage." , 5240 "format_description" : "ignore|on" 5244 "format" : "urlencoded" , 5245 "format_description" : "serial" , 5246 "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long." , 5251 "description" : "Force the drive's physical geometry to have a specific head count." , 5254 "format_description" : "count" 5257 "description" : "Maximum r/w speed speed in bytes per second." , 5260 "format_description" : "bps" 5263 "description" : "Maximum unthrottled read I/O pool speed in operations per second." , 5266 "format_description" : "iops" 5269 "format_description" : "drive format" , 5270 "description" : "The drive's backing file's data format." , 5284 "format_description" : "mbps" , 5285 "description" : "Maximum unthrottled write pool speed in megabytes per second." , 5290 "description" : "Controls whether to detect and try to optimize writes of zeroes." , 5295 "format_description" : "count" , 5298 "description" : "Force the drive's physical geometry to have a specific sector count." 5301 "format_description" : "iops" , 5302 "description" : "Maximum write I/O speed in operations per second." , 5316 "description" : "The drive's cache mode" , 5317 "format_description" : "none|writethrough|writeback|unsafe|directsync" 5325 "description" : "Read error action." , 5328 "format_description" : "ignore|report|stop" 5331 "format_description" : "cdrom|disk" , 5335 "description" : "The drive's media type." , 5342 "description" : "Whether the drive should be included when making snapshots." , 5345 "format_description" : "on|off" 5350 "description" : "Maximum unthrottled r/w I/O pool speed in operations per second." , 5351 "format_description" : "iops" 5354 "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5)." , 5362 "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)." 5365 "pattern" : "[acdn]{1,4}" , 5366 "description" : "Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n)." , 5374 "description" : "numa topology" , 5377 "format_description" : "mb" , 5378 "description" : "Amount of memory this numa node provides." , 5384 "pattern" : "(?^: \\ d+(?:- \\ d+)?(?:; \\ d+(?:- \\ d+)?)*)" , 5385 "description" : "CPUs accessing this numa node." , 5386 "format_description" : "id[-id];..." 5391 "pattern" : "(?^: \\ d+(?:- \\ d+)?(?:; \\ d+(?:- \\ d+)?)*)" , 5392 "description" : "host numa nodes to use" , 5393 "format_description" : "id[-id];..." 5398 "description" : "numa allocation policy." , 5404 "format_description" : "preferred|bind|interleave" 5409 "description" : "Enable/disable time drift fix." , 5415 "description" : "Automatic restart after crash (currently ignored)." , 5434 "description" : "Used to enable special optimization/features for specific \n operating systems: \n\n other => unspecified OS \n wxp => Microsoft Windows XP \n w2k => Microsoft Windows 2000 \n w2k3 => Microsoft Windows 2003 \n w2k8 => Microsoft Windows 2008 \n wvista => Microsoft Windows Vista \n win7 => Microsoft Windows 7 \n win8 => Microsoft Windows 8/2012 \n l24 => Linux 2.4 Kernel \n l26 => Linux 2.6/3.X Kernel \n solaris => solaris/opensolaris/openindiania kernel \n\n other|l24|l26|solaris ... no special behaviour \n wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch \n " , 5439 "format" : "pve-volume-id" , 5442 "description" : "Reference to unused volumes." 5445 "description" : "Enable/disable Template." , 5455 "description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning" , 5463 "description" : "Select BIOS implementation." , 5466 "default" : "seabios" 5472 "description" : "Sets the protection flag of the VM. This will prevent the remove operation." 5475 "description" : "Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device." , 5482 "description" : "Arbitrary arguments passed to kvm, for example: \n\n args: -no-reboot -no-hpet \n\n NOTE: this option is for experts only. \n " , 5486 "background_delay" : { 5488 "description" : "Time to wait for the task to finish. We return 'null' if the task finish within that time." , 5494 "description" : "Emulated CPU type." , 5499 "description" : "Emulated CPU type." , 5530 "default" : "kvm64" , 5532 "format_description" : "cputype" , 5536 "description" : "Do not identify as a KVM virtual machine." , 5551 "virtio-scsi-single" , 5555 "description" : "scsi controller model" 5560 "format_description" : "yes|no" , 5561 "description" : "Specifies whether if given host option is a USB3 device or port" , 5566 "description" : "The Host USB device or port or the value spice" , 5568 "format_description" : "HOSTUSBDEVICE|spice" , 5569 "format" : "pve-qm-usb-device" , 5573 "description" : "Configure an USB device (n is 0 to 4). This can be used to \n pass-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\n You can use the 'lsusb -t' command to list existing usb devices. \n\n NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care. \n\n The value 'spice' can be used to add a usb redirection devices for spice. \n\n The '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 " , 5578 "description" : "This is an alias for option -ide2" , 5581 "format" : "pve-qm-drive" , 5582 "typetext" : "volume" 5587 "description" : "Ignore locks - only root is allowed to use this option." 5590 "format" : "pve-qm-net" , 5593 "description" : "Specify network devices. \n\n MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3 \n\n XX:XX:XX:XX:XX:XX should be an unique MAC address. This is \n automatically generated if not specified. \n\n The bridge parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'. \n\n Option '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\n If you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services. The following addresses are used: \n\n 10.0.2.2 Gateway \n 10.0.2.3 DNS Server \n 10.0.2.4 SMB Server \n\n The DHCP server assign addresses to the guest starting from 10.0.2.15. \n\n " 5598 "format_description" : "cdrom|disk" , 5603 "description" : "The drive's media type." , 5609 "format_description" : "off|on" , 5612 "description" : "Whether to use iothreads for this drive" 5624 "description" : "The drive's cache mode" , 5625 "format_description" : "none|writethrough|writeback|unsafe|directsync" 5628 "description" : "Force the drive's physical geometry to have a specific sector count." , 5631 "format_description" : "count" 5634 "description" : "Maximum write I/O speed in operations per second." , 5637 "format_description" : "iops" 5640 "description" : "Controls whether to detect and try to optimize writes of zeroes." , 5645 "format_description" : "iops" , 5648 "description" : "Maximum unthrottled r/w I/O pool speed in operations per second." 5653 "description" : "Whether the drive should be included when making snapshots." , 5654 "format_description" : "on|off" 5659 "description" : "Maximum write speed speed in bytes per second." , 5660 "format_description" : "bps" 5663 "description" : "Maximum unthrottled r/w pool speed in megabytes per second." , 5666 "format_description" : "mbps" 5669 "format_description" : "iops" , 5672 "description" : "Maximum read I/O speed in operations per second." 5675 "format" : "disk-size" , 5676 "description" : "Disk size. This is purely informational and has no effect." , 5681 "format_description" : "iops" , 5684 "description" : "Maximum unthrottled read I/O pool speed in operations per second." 5698 "description" : "The drive's backing file's data format." , 5699 "format_description" : "drive format" 5702 "format_description" : "mbps" , 5705 "description" : "Maximum unthrottled write pool speed in megabytes per second." 5708 "description" : "Maximum r/w speed speed in bytes per second." , 5711 "format_description" : "bps" 5714 "format_description" : "count" , 5715 "description" : "Force the drive's physical geometry to have a specific head count." , 5722 "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long." , 5723 "format_description" : "serial" , 5725 "format" : "urlencoded" 5732 "description" : "Controls whether to pass discard/trim requests to the underlying storage." , 5735 "format_description" : "ignore|on" 5738 "description" : "Maximum unthrottled read pool speed in megabytes per second." , 5741 "format_description" : "mbps" 5746 "description" : "Maximum read speed speed in megabytes per second." , 5747 "format_description" : "mbps" 5750 "format_description" : "mbps" , 5753 "description" : "Maximum write speed speed in megabytes per second." 5756 "format" : "pve-volume-id-or-qm-path" , 5757 "format_description" : "volume" , 5759 "description" : "The drive's backing volume." , 5765 "description" : "Maximum r/w I/O speed in operations per second." , 5766 "format_description" : "iops" 5769 "format_description" : "enospc|ignore|report|stop" , 5770 "description" : "Write error action." , 5781 "format_description" : "native|threads" , 5786 "description" : "AIO type to use." , 5791 "description" : "Maximum unthrottled write I/O pool speed in operations per second." , 5794 "format_description" : "iops" 5797 "format_description" : "on|off" , 5800 "description" : "Whether the drive should be included when making backups." 5805 "description" : "Maximum read speed speed in bytes per second." , 5806 "format_description" : "bps" 5810 "format_description" : "nbqueues" , 5813 "description" : "Number of queues." 5816 "format_description" : "count" , 5817 "description" : "Force the drive's physical geometry to have a specific cylinder count." , 5822 "format_description" : "mbps" , 5823 "description" : "Maximum r/w speed speed in megabytes per second." , 5831 "format_description" : "none|lba|auto" , 5834 "description" : "Force disk geometry bios translation mode." , 5844 "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13)." 5849 "description" : "Use volume as VIRTIO hard disk (n is 0 to 15)." , 5852 "description" : "Force the drive's physical geometry to have a specific cylinder count." , 5855 "format_description" : "count" 5858 "description" : "Maximum r/w speed speed in megabytes per second." , 5861 "format_description" : "mbps" 5864 "description" : "Maximum read speed speed in bytes per second." , 5867 "format_description" : "bps" 5870 "format_description" : "none|lba|auto" , 5878 "description" : "Force disk geometry bios translation mode." 5885 "format" : "pve-volume-id-or-qm-path" , 5886 "format_description" : "volume" , 5888 "description" : "The drive's backing volume." 5891 "format_description" : "iops" , 5892 "description" : "Maximum r/w I/O speed in operations per second." , 5899 "description" : "Maximum read speed speed in megabytes per second." , 5900 "format_description" : "mbps" 5905 "description" : "Maximum write speed speed in megabytes per second." , 5906 "format_description" : "mbps" 5909 "format_description" : "iops" , 5910 "description" : "Maximum unthrottled write I/O pool speed in operations per second." , 5917 "description" : "Whether the drive should be included when making backups." , 5918 "format_description" : "on|off" 5923 "description" : "AIO type to use." , 5928 "format_description" : "native|threads" 5939 "description" : "Write error action." , 5940 "format_description" : "enospc|ignore|report|stop" 5943 "description" : "Maximum read I/O speed in operations per second." , 5946 "format_description" : "iops" 5951 "description" : "Disk size. This is purely informational and has no effect." , 5952 "format" : "disk-size" 5955 "description" : "Maximum unthrottled r/w pool speed in megabytes per second." , 5958 "format_description" : "mbps" 5961 "format_description" : "bps" , 5964 "description" : "Maximum write speed speed in bytes per second." 5971 "description" : "Controls whether to pass discard/trim requests to the underlying storage." , 5974 "format_description" : "ignore|on" 5979 "description" : "Maximum unthrottled read pool speed in megabytes per second." , 5980 "format_description" : "mbps" 5983 "format_description" : "count" , 5986 "description" : "Force the drive's physical geometry to have a specific head count." 5989 "format_description" : "serial" , 5990 "format" : "urlencoded" , 5992 "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long." , 5999 "description" : "Maximum unthrottled read I/O pool speed in operations per second." , 6000 "format_description" : "iops" 6003 "description" : "Maximum unthrottled write pool speed in megabytes per second." , 6006 "format_description" : "mbps" 6009 "format_description" : "bps" , 6012 "description" : "Maximum r/w speed speed in bytes per second." 6015 "format_description" : "drive format" , 6027 "description" : "The drive's backing file's data format." 6030 "format_description" : "count" , 6031 "description" : "Force the drive's physical geometry to have a specific sector count." , 6036 "format_description" : "iops" , 6037 "description" : "Maximum write I/O speed in operations per second." , 6044 "description" : "Controls whether to detect and try to optimize writes of zeroes." 6047 "description" : "Read error action." , 6055 "format_description" : "ignore|report|stop" 6058 "description" : "The drive's cache mode" , 6068 "format_description" : "none|writethrough|writeback|unsafe|directsync" 6071 "format_description" : "off|on" , 6072 "description" : "Whether to use iothreads for this drive" , 6081 "description" : "The drive's media type." , 6085 "format_description" : "cdrom|disk" 6088 "description" : "Whether the drive should be included when making snapshots." , 6091 "format_description" : "on|off" 6094 "format_description" : "iops" , 6097 "description" : "Maximum unthrottled r/w I/O pool speed in operations per second." 6117 "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." 6122 "description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver." , 6126 "description" : "The number of CPUs. Please use option -sockets instead." , 6133 "description" : "Specific the Qemu machine type." , 6134 "pattern" : "(pc|pc(-i440fx)?- \\ d+ \\ . \\ d+( \\ .pxe)?|q35|pc-q35- \\ d+ \\ . \\ d+( \\ .pxe)?)" , 6140 "format" : "pve-configid-list" , 6143 "description" : "A list of settings you want to delete." 6147 "description" : "The number of cores per socket." , 6153 "description" : "Set a name for the VM. Only used on the configuration web interface." , 6156 "format" : "dns-name" 6162 "description" : "Enable/disable Qemu GuestAgent." 6166 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 6173 "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped." , 6174 "typetext" : "[[order=] \\ d+] [,up= \\ d+] [,down= \\ d+] " , 6175 "format" : "pve-startup-order" 6181 "description" : "Specifies whether a VM will be started during system bootup." 6184 "description" : "Freeze CPU at startup (use 'c' monitor command to start execution)." , 6192 "description" : "The number of CPU sockets." , 6196 "description" : "Number of hotplugged vcpus." , 6205 "pattern" : "(/dev/.+|socket)" , 6206 "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\n NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care. \n\n Experimental: user reported problems with this option. \n " 6211 "description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file." 6214 "description" : "Enable/disable ACPI." , 6219 "migrate_downtime" : { 6220 "description" : "Set maximum tolerated downtime (in seconds) for migrations." , 6227 "description" : "Map host parallel devices (n is 0 to 2). \n\n NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care. \n\n Experimental: user reported problems with this option. \n " , 6228 "pattern" : "/dev/parport \\ d+|/dev/usb/lp \\ d+" , 6233 "format" : "pve-hotplug-features" , 6234 "default" : "network,disk,usb" , 6237 "description" : "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'." 6242 "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)" , 6243 "format" : "pve-qm-watchdog" 6248 "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3)." , 6254 "format_description" : "none|lba|auto" , 6260 "description" : "Force disk geometry bios translation mode." , 6265 "format_description" : "bps" , 6266 "description" : "Maximum read speed speed in bytes per second." , 6271 "format_description" : "count" , 6272 "description" : "Force the drive's physical geometry to have a specific cylinder count." , 6277 "format_description" : "mbps" , 6278 "description" : "Maximum r/w speed speed in megabytes per second." , 6283 "format_description" : "enospc|ignore|report|stop" , 6292 "description" : "Write error action." 6297 "description" : "AIO type to use." , 6302 "format_description" : "native|threads" 6305 "description" : "Maximum unthrottled write I/O pool speed in operations per second." , 6308 "format_description" : "iops" 6311 "format_description" : "on|off" , 6314 "description" : "Whether the drive should be included when making backups." 6317 "format_description" : "mbps" , 6318 "description" : "Maximum read speed speed in megabytes per second." , 6323 "format_description" : "mbps" , 6324 "description" : "Maximum write speed speed in megabytes per second." , 6331 "description" : "The drive's reported model name, url-encoded, up to 40 bytes long." , 6332 "format_description" : "model" , 6333 "format" : "urlencoded" , 6338 "description" : "The drive's backing volume." , 6340 "format" : "pve-volume-id-or-qm-path" , 6341 "format_description" : "volume" 6344 "description" : "Maximum r/w I/O speed in operations per second." , 6347 "format_description" : "iops" 6350 "description" : "Maximum unthrottled write pool speed in megabytes per second." , 6353 "format_description" : "mbps" 6356 "format_description" : "drive format" , 6357 "description" : "The drive's backing file's data format." , 6373 "description" : "Maximum r/w speed speed in bytes per second." , 6374 "format_description" : "bps" 6377 "format_description" : "iops" , 6380 "description" : "Maximum unthrottled read I/O pool speed in operations per second." 6383 "format_description" : "count" , 6384 "description" : "Force the drive's physical geometry to have a specific head count." , 6389 "format_description" : "serial" , 6390 "format" : "urlencoded" , 6394 "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long." 6397 "description" : "Controls whether to pass discard/trim requests to the underlying storage." , 6404 "format_description" : "ignore|on" 6407 "format_description" : "mbps" , 6410 "description" : "Maximum unthrottled read pool speed in megabytes per second." 6413 "format_description" : "bps" , 6414 "description" : "Maximum write speed speed in bytes per second." , 6419 "format_description" : "mbps" , 6420 "description" : "Maximum unthrottled r/w pool speed in megabytes per second." , 6425 "description" : "Maximum read I/O speed in operations per second." , 6428 "format_description" : "iops" 6431 "description" : "Disk size. This is purely informational and has no effect." , 6434 "format" : "disk-size" 6439 "description" : "Maximum unthrottled r/w I/O pool speed in operations per second." , 6440 "format_description" : "iops" 6443 "description" : "Whether the drive should be included when making snapshots." , 6446 "format_description" : "on|off" 6449 "format_description" : "cdrom|disk" , 6457 "description" : "The drive's media type." 6465 "description" : "Read error action." , 6468 "format_description" : "ignore|report|stop" 6471 "format_description" : "none|writethrough|writeback|unsafe|directsync" , 6472 "description" : "The drive's cache mode" , 6486 "description" : "Maximum write I/O speed in operations per second." , 6487 "format_description" : "iops" 6490 "description" : "Force the drive's physical geometry to have a specific sector count." , 6493 "format_description" : "count" 6498 "description" : "Controls whether to detect and try to optimize writes of zeroes." 6511 "description" : "Lock/unlock the VM." 6514 "format" : "pve-qm-hostpci" , 6517 "description" : "Map host pci devices. HOSTPCIDEVICE syntax is: \n\n 'bus:dev.func' (hexadecimal numbers) \n\n You can us the 'lspci' command to list existing pci devices. \n\n The 'rombar' option determines whether or not the device's ROM will be visible in the guest's memory map (default is 'on'). \n\n NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care. \n\n Experimental: user reported problems with this option. \n " 6520 "description" : "Keybord layout for vnc server. Default is read from the datacenter configuration file." , 6548 "default" : "en-us" , 6555 "pattern" : "(ide|sata|scsi|virtio) \\ d+" , 6556 "description" : "Enable booting from specified disk." , 6557 "format" : "pve-qm-bootdisk" 6560 "description" : "Revert a pending change." , 6563 "format" : "pve-configid-list" 6566 "description" : "Allow reboot. If set to '0' the VM exit on reboot." , 6572 "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\n NOTE: You can disable fair-scheduler configuration by setting this to 0." , 6580 "description" : "Enable/disable NUMA." , 6586 "description" : "Specify SMBIOS type 1 fields." , 6589 "format" : "pve-qm-smbios1" , 6593 "description" : "The (unique) ID of the VM." , 6595 "format" : "pve-vmid" , 6599 "additionalProperties" : 0 6601 "name" : "update_vm_async" , 6609 "description" : "SHA1 digest of configuration file. This can be used to prevent concurrent modifications." , 6615 "name" : "vm_config" , 6619 "description" : "The cluster node name." , 6621 "format" : "pve-node" 6624 "description" : "Get current values (instead of pending values)." , 6630 "format" : "pve-vmid" , 6633 "description" : "The (unique) ID of the VM." 6636 "additionalProperties" : 0 6648 "description" : "Get current virtual machine configuration. This does not include pending configuration changes (see 'pending' API)." 6652 "additionalProperties" : 0 , 6655 "description" : "Enable/disable NUMA." , 6665 "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\n NOTE: You can disable fair-scheduler configuration by setting this to 0." , 6670 "description" : "The (unique) ID of the VM." , 6671 "format" : "pve-vmid" , 6675 "format" : "pve-qm-smbios1" , 6679 "description" : "Specify SMBIOS type 1 fields." 6682 "format" : "pve-qm-bootdisk" , 6683 "description" : "Enable booting from specified disk." , 6684 "pattern" : "(ide|sata|scsi|virtio) \\ d+" , 6689 "format" : "pve-configid-list" , 6690 "description" : "Revert a pending change." , 6695 "description" : "Allow reboot. If set to '0' the VM exit on reboot." , 6707 "description" : "Lock/unlock the VM." , 6712 "description" : "Map host pci devices. HOSTPCIDEVICE syntax is: \n\n 'bus:dev.func' (hexadecimal numbers) \n\n You can us the 'lspci' command to list existing pci devices. \n\n The 'rombar' option determines whether or not the device's ROM will be visible in the guest's memory map (default is 'on'). \n\n NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care. \n\n Experimental: user reported problems with this option. \n " , 6715 "format" : "pve-qm-hostpci" 6745 "description" : "Keybord layout for vnc server. Default is read from the datacenter configuration file." , 6751 "format" : "pve-hotplug-features" , 6752 "description" : "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'." , 6753 "default" : "network,disk,usb" , 6760 "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3)." , 6763 "format_description" : "mbps" , 6764 "description" : "Maximum unthrottled r/w pool speed in megabytes per second." , 6769 "format" : "disk-size" , 6772 "description" : "Disk size. This is purely informational and has no effect." 6775 "format_description" : "iops" , 6778 "description" : "Maximum read I/O speed in operations per second." 6781 "format_description" : "bps" , 6782 "description" : "Maximum write speed speed in bytes per second." , 6789 "description" : "Maximum unthrottled read pool speed in megabytes per second." , 6790 "format_description" : "mbps" 6793 "format_description" : "ignore|on" , 6794 "description" : "Controls whether to pass discard/trim requests to the underlying storage." , 6805 "description" : "Maximum r/w speed speed in bytes per second." , 6806 "format_description" : "bps" 6809 "format_description" : "mbps" , 6812 "description" : "Maximum unthrottled write pool speed in megabytes per second." 6815 "format_description" : "drive format" , 6825 "description" : "The drive's backing file's data format." , 6830 "description" : "Maximum unthrottled read I/O pool speed in operations per second." , 6833 "format_description" : "iops" 6836 "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long." , 6839 "format" : "urlencoded" , 6841 "format_description" : "serial" 6844 "format_description" : "count" , 6847 "description" : "Force the drive's physical geometry to have a specific head count." 6850 "format_description" : "none|writethrough|writeback|unsafe|directsync" , 6858 "description" : "The drive's cache mode" , 6863 "format_description" : "ignore|report|stop" , 6864 "description" : "Read error action." , 6876 "description" : "Controls whether to detect and try to optimize writes of zeroes." 6881 "description" : "Maximum write I/O speed in operations per second." , 6882 "format_description" : "iops" 6885 "description" : "Force the drive's physical geometry to have a specific sector count." , 6888 "format_description" : "count" 6891 "format_description" : "cdrom|disk" , 6896 "description" : "The drive's media type." , 6904 "description" : "Maximum unthrottled r/w I/O pool speed in operations per second." , 6905 "format_description" : "iops" 6908 "format_description" : "on|off" , 6909 "description" : "Whether the drive should be included when making snapshots." , 6914 "format_description" : "mbps" , 6917 "description" : "Maximum r/w speed speed in megabytes per second." 6922 "description" : "Force the drive's physical geometry to have a specific cylinder count." , 6923 "format_description" : "count" 6928 "description" : "Maximum read speed speed in bytes per second." , 6929 "format_description" : "bps" 6937 "description" : "Force disk geometry bios translation mode." , 6943 "format_description" : "none|lba|auto" 6946 "format" : "urlencoded" , 6948 "format_description" : "model" , 6951 "description" : "The drive's reported model name, url-encoded, up to 40 bytes long." 6954 "format_description" : "iops" , 6957 "description" : "Maximum r/w I/O speed in operations per second." 6960 "description" : "The drive's backing volume." , 6962 "format" : "pve-volume-id-or-qm-path" , 6963 "format_description" : "volume" , 6967 "format_description" : "mbps" , 6970 "description" : "Maximum write speed speed in megabytes per second." 6973 "description" : "Maximum read speed speed in megabytes per second." , 6976 "format_description" : "mbps" 6979 "format_description" : "on|off" , 6982 "description" : "Whether the drive should be included when making backups." 6985 "format_description" : "iops" , 6988 "description" : "Maximum unthrottled write I/O pool speed in operations per second." 6997 "description" : "Write error action." , 7000 "format_description" : "enospc|ignore|report|stop" 7003 "format_description" : "native|threads" , 7008 "description" : "AIO type to use." , 7015 "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)" , 7018 "format" : "pve-qm-watchdog" 7024 "description" : "Enable/disable ACPI." 7026 "migrate_downtime" : { 7031 "description" : "Set maximum tolerated downtime (in seconds) for migrations." 7034 "description" : "Map host parallel devices (n is 0 to 2). \n\n NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care. \n\n Experimental: user reported problems with this option. \n " , 7035 "pattern" : "/dev/parport \\ d+|/dev/usb/lp \\ d+" , 7040 "description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file." , 7048 "description" : "Number of hotplugged vcpus." , 7054 "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\n NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care. \n\n Experimental: user reported problems with this option. \n " , 7055 "pattern" : "(/dev/.+|socket)" 7058 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 7066 "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped." , 7067 "typetext" : "[[order=] \\ d+] [,up= \\ d+] [,down= \\ d+] " , 7068 "format" : "pve-startup-order" 7074 "description" : "Enable/disable Qemu GuestAgent." 7081 "description" : "The number of CPU sockets." 7084 "description" : "Specifies whether a VM will be started during system bootup." , 7090 "description" : "Freeze CPU at startup (use 'c' monitor command to start execution)." , 7098 "description" : "The number of cores per socket." , 7102 "description" : "A list of settings you want to delete." , 7105 "format" : "pve-configid-list" 7108 "format" : "dns-name" , 7109 "description" : "Set a name for the VM. Only used on the configuration web interface." , 7114 "description" : "The number of CPUs. Please use option -sockets instead." , 7124 "description" : "Specific the Qemu machine type." , 7125 "pattern" : "(pc|pc(-i440fx)?- \\ d+ \\ . \\ d+( \\ .pxe)?|q35|pc-q35- \\ d+ \\ . \\ d+( \\ .pxe)?)" 7128 "description" : "Specify network devices. \n\n MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3 \n\n XX:XX:XX:XX:XX:XX should be an unique MAC address. This is \n automatically generated if not specified. \n\n The bridge parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'. \n\n Option '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\n If you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services. The following addresses are used: \n\n 10.0.2.2 Gateway \n 10.0.2.3 DNS Server \n 10.0.2.4 SMB Server \n\n The DHCP server assign addresses to the guest starting from 10.0.2.15. \n\n " , 7131 "format" : "pve-qm-net" 7136 "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." , 7154 "description" : "Use volume as VIRTIO hard disk (n is 0 to 15)." , 7157 "format_description" : "bps" , 7158 "description" : "Maximum write speed speed in bytes per second." , 7165 "description" : "Maximum unthrottled r/w pool speed in megabytes per second." , 7166 "format_description" : "mbps" 7169 "format_description" : "iops" , 7172 "description" : "Maximum read I/O speed in operations per second." 7177 "description" : "Disk size. This is purely informational and has no effect." , 7178 "format" : "disk-size" 7183 "description" : "Maximum unthrottled write pool speed in megabytes per second." , 7184 "format_description" : "mbps" 7187 "format_description" : "bps" , 7188 "description" : "Maximum r/w speed speed in bytes per second." , 7193 "description" : "Maximum unthrottled read I/O pool speed in operations per second." , 7196 "format_description" : "iops" 7199 "format_description" : "drive format" , 7200 "description" : "The drive's backing file's data format." , 7216 "description" : "Force the drive's physical geometry to have a specific head count." , 7217 "format_description" : "count" 7222 "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long." , 7223 "format_description" : "serial" , 7224 "format" : "urlencoded" , 7234 "description" : "Controls whether to pass discard/trim requests to the underlying storage." , 7235 "format_description" : "ignore|on" 7240 "description" : "Maximum unthrottled read pool speed in megabytes per second." , 7241 "format_description" : "mbps" 7244 "format_description" : "cdrom|disk" , 7245 "description" : "The drive's media type." , 7255 "format_description" : "off|on" , 7256 "description" : "Whether to use iothreads for this drive" , 7261 "format_description" : "ignore|report|stop" , 7264 "description" : "Read error action." , 7272 "format_description" : "none|writethrough|writeback|unsafe|directsync" , 7275 "description" : "The drive's cache mode" , 7285 "format_description" : "count" , 7288 "description" : "Force the drive's physical geometry to have a specific sector count." 7291 "format_description" : "iops" , 7294 "description" : "Maximum write I/O speed in operations per second." 7297 "description" : "Controls whether to detect and try to optimize writes of zeroes." , 7304 "description" : "Maximum unthrottled r/w I/O pool speed in operations per second." , 7305 "format_description" : "iops" 7308 "format_description" : "on|off" , 7309 "description" : "Whether the drive should be included when making snapshots." , 7314 "format_description" : "bps" , 7317 "description" : "Maximum read speed speed in bytes per second." 7322 "description" : "Force the drive's physical geometry to have a specific cylinder count." , 7323 "format_description" : "count" 7326 "format_description" : "mbps" , 7329 "description" : "Maximum r/w speed speed in megabytes per second." 7335 "description" : "Force disk geometry bios translation mode." , 7343 "format_description" : "none|lba|auto" 7348 "description" : "Maximum read speed speed in megabytes per second." , 7349 "format_description" : "mbps" 7354 "description" : "Maximum write speed speed in megabytes per second." , 7355 "format_description" : "mbps" 7358 "description" : "The drive's backing volume." , 7360 "format" : "pve-volume-id-or-qm-path" , 7361 "format_description" : "volume" , 7365 "format_description" : "iops" , 7368 "description" : "Maximum r/w I/O speed in operations per second." 7379 "description" : "Write error action." , 7380 "format_description" : "enospc|ignore|report|stop" 7383 "format_description" : "native|threads" , 7386 "description" : "AIO type to use." , 7395 "description" : "Maximum unthrottled write I/O pool speed in operations per second." , 7396 "format_description" : "iops" 7401 "description" : "Whether the drive should be included when making backups." , 7402 "format_description" : "on|off" 7407 "description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver." , 7415 "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13)." , 7420 "description" : "Force the drive's physical geometry to have a specific head count." , 7421 "format_description" : "count" 7426 "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long." , 7427 "format_description" : "serial" , 7429 "format" : "urlencoded" 7432 "description" : "Maximum unthrottled read I/O pool speed in operations per second." , 7435 "format_description" : "iops" 7440 "description" : "Maximum r/w speed speed in bytes per second." , 7441 "format_description" : "bps" 7446 "description" : "Maximum unthrottled write pool speed in megabytes per second." , 7447 "format_description" : "mbps" 7459 "description" : "The drive's backing file's data format." , 7462 "format_description" : "drive format" 7465 "format_description" : "ignore|on" , 7468 "description" : "Controls whether to pass discard/trim requests to the underlying storage." , 7475 "format_description" : "mbps" , 7478 "description" : "Maximum unthrottled read pool speed in megabytes per second." 7481 "format_description" : "bps" , 7482 "description" : "Maximum write speed speed in bytes per second." , 7487 "format_description" : "iops" , 7490 "description" : "Maximum read I/O speed in operations per second." 7493 "description" : "Disk size. This is purely informational and has no effect." , 7496 "format" : "disk-size" 7499 "format_description" : "mbps" , 7502 "description" : "Maximum unthrottled r/w pool speed in megabytes per second." 7507 "description" : "Whether the drive should be included when making snapshots." , 7508 "format_description" : "on|off" 7511 "format_description" : "iops" , 7512 "description" : "Maximum unthrottled r/w I/O pool speed in operations per second." , 7517 "format_description" : "off|on" , 7520 "description" : "Whether to use iothreads for this drive" 7523 "format_description" : "cdrom|disk" , 7528 "description" : "The drive's media type." , 7534 "description" : "Force the drive's physical geometry to have a specific sector count." , 7537 "format_description" : "count" 7540 "format_description" : "iops" , 7541 "description" : "Maximum write I/O speed in operations per second." , 7548 "description" : "Controls whether to detect and try to optimize writes of zeroes." 7553 "description" : "The drive's cache mode" , 7561 "format_description" : "none|writethrough|writeback|unsafe|directsync" 7566 "description" : "Force disk geometry bios translation mode." , 7572 "format_description" : "none|lba|auto" 7578 "format_description" : "bps" , 7581 "description" : "Maximum read speed speed in bytes per second." 7584 "format_description" : "nbqueues" , 7586 "description" : "Number of queues." , 7591 "description" : "Force the drive's physical geometry to have a specific cylinder count." , 7594 "format_description" : "count" 7597 "description" : "Maximum r/w speed speed in megabytes per second." , 7600 "format_description" : "mbps" 7609 "description" : "AIO type to use." , 7610 "format_description" : "native|threads" 7613 "format_description" : "enospc|ignore|report|stop" , 7616 "description" : "Write error action." , 7625 "format_description" : "iops" , 7626 "description" : "Maximum unthrottled write I/O pool speed in operations per second." , 7631 "format_description" : "on|off" , 7632 "description" : "Whether the drive should be included when making backups." , 7637 "format_description" : "mbps" , 7640 "description" : "Maximum read speed speed in megabytes per second." 7643 "format_description" : "mbps" , 7646 "description" : "Maximum write speed speed in megabytes per second." 7649 "format_description" : "volume" , 7650 "format" : "pve-volume-id-or-qm-path" , 7652 "description" : "The drive's backing volume." , 7658 "description" : "Maximum r/w I/O speed in operations per second." , 7659 "format_description" : "iops" 7667 "description" : "Sets the protection flag of the VM. This will prevent the remove operation." 7672 "description" : "Configure an USB device (n is 0 to 4). This can be used to \n pass-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\n You can use the 'lsusb -t' command to list existing usb devices. \n\n NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care. \n\n The value 'spice' can be used to add a usb redirection devices for spice. \n\n The '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 " , 7675 "description" : "The Host USB device or port or the value spice" , 7677 "format_description" : "HOSTUSBDEVICE|spice" , 7678 "format" : "pve-qm-usb-device" , 7682 "description" : "Specifies whether if given host option is a USB3 device or port" , 7685 "format_description" : "yes|no" 7690 "description" : "scsi controller model" , 7695 "virtio-scsi-single" , 7706 "description" : "This is an alias for option -ide2" , 7707 "typetext" : "volume" , 7708 "format" : "pve-qm-drive" 7711 "description" : "Emulated CPU type." , 7716 "default" : "kvm64" , 7718 "description" : "Emulated CPU type." , 7750 "format_description" : "cputype" 7753 "description" : "Do not identify as a KVM virtual machine." , 7761 "description" : "Ignore locks - only root is allowed to use this option." , 7770 "description" : "Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device." 7773 "description" : "Arbitrary arguments passed to kvm, for example: \n\n args: -no-reboot -no-hpet \n\n NOTE: this option is for experts only. \n " , 7781 "description" : "Enable/disable Template." 7788 "description" : "Select BIOS implementation." , 7791 "default" : "seabios" 7798 "description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning" , 7815 "description" : "Used to enable special optimization/features for specific \n operating systems: \n\n other => unspecified OS \n wxp => Microsoft Windows XP \n w2k => Microsoft Windows 2000 \n w2k3 => Microsoft Windows 2003 \n w2k8 => Microsoft Windows 2008 \n wvista => Microsoft Windows Vista \n win7 => Microsoft Windows 7 \n win8 => Microsoft Windows 8/2012 \n l24 => Linux 2.4 Kernel \n l26 => Linux 2.6/3.X Kernel \n solaris => solaris/opensolaris/openindiania kernel \n\n other|l24|l26|solaris ... no special behaviour \n wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch \n " , 7822 "description" : "Reference to unused volumes." , 7823 "format" : "pve-volume-id" 7826 "description" : "Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n)." , 7827 "pattern" : "[acdn]{1,4}" , 7833 "description" : "numa topology" , 7838 "format_description" : "id[-id];..." , 7841 "pattern" : "(?^: \\ d+(?:- \\ d+)?(?:; \\ d+(?:- \\ d+)?)*)" , 7842 "description" : "host numa nodes to use" 7845 "format_description" : "id[-id];..." , 7847 "description" : "CPUs accessing this numa node." , 7848 "pattern" : "(?^: \\ d+(?:- \\ d+)?(?:; \\ d+(?:- \\ d+)?)*)" 7858 "description" : "numa allocation policy." , 7859 "format_description" : "preferred|bind|interleave" 7862 "format_description" : "mb" , 7863 "description" : "Amount of memory this numa node provides." , 7873 "description" : "Automatic restart after crash (currently ignored)." 7879 "description" : "Enable/disable time drift fix." 7882 "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)." , 7888 "description" : "Limit of CPU usage. \n\n NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit." , 7899 "description" : "Enable/disable KVM hardware virtualization." 7905 "description" : "The drive's backing volume." , 7907 "format" : "pve-volume-id-or-qm-path" , 7908 "format_description" : "volume" 7911 "description" : "Maximum r/w I/O speed in operations per second." , 7914 "format_description" : "iops" 7917 "format_description" : "mbps" , 7920 "description" : "Maximum read speed speed in megabytes per second." 7923 "description" : "Maximum write speed speed in megabytes per second." , 7926 "format_description" : "mbps" 7931 "description" : "Maximum unthrottled write I/O pool speed in operations per second." , 7932 "format_description" : "iops" 7935 "format_description" : "on|off" , 7936 "description" : "Whether the drive should be included when making backups." , 7941 "format_description" : "native|threads" , 7944 "description" : "AIO type to use." , 7953 "description" : "Write error action." , 7960 "format_description" : "enospc|ignore|report|stop" 7965 "description" : "Force the drive's physical geometry to have a specific cylinder count." , 7966 "format_description" : "count" 7969 "format_description" : "mbps" , 7972 "description" : "Maximum r/w speed speed in megabytes per second." 7975 "description" : "Maximum read speed speed in bytes per second." , 7978 "format_description" : "bps" 7981 "format_description" : "none|lba|auto" , 7987 "description" : "Force disk geometry bios translation mode." , 7995 "format_description" : "iops" , 7996 "description" : "Maximum write I/O speed in operations per second." , 8001 "format_description" : "count" , 8002 "description" : "Force the drive's physical geometry to have a specific sector count." , 8007 "description" : "Controls whether to detect and try to optimize writes of zeroes." , 8012 "format_description" : "ignore|report|stop" , 8020 "description" : "Read error action." 8030 "description" : "The drive's cache mode" , 8033 "format_description" : "none|writethrough|writeback|unsafe|directsync" 8036 "description" : "The drive's media type." , 8044 "format_description" : "cdrom|disk" 8047 "description" : "Whether the drive should be included when making snapshots." , 8050 "format_description" : "on|off" 8055 "description" : "Maximum unthrottled r/w I/O pool speed in operations per second." , 8056 "format_description" : "iops" 8059 "format_description" : "iops" , 8062 "description" : "Maximum read I/O speed in operations per second." 8065 "description" : "Disk size. This is purely informational and has no effect." , 8068 "format" : "disk-size" 8071 "description" : "Maximum unthrottled r/w pool speed in megabytes per second." , 8074 "format_description" : "mbps" 8077 "description" : "Maximum write speed speed in bytes per second." , 8080 "format_description" : "bps" 8083 "description" : "Controls whether to pass discard/trim requests to the underlying storage." , 8090 "format_description" : "ignore|on" 8093 "description" : "Maximum unthrottled read pool speed in megabytes per second." , 8096 "format_description" : "mbps" 8101 "description" : "Force the drive's physical geometry to have a specific head count." , 8102 "format_description" : "count" 8105 "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long." , 8108 "format" : "urlencoded" , 8110 "format_description" : "serial" 8113 "format_description" : "drive format" , 8114 "description" : "The drive's backing file's data format." , 8130 "description" : "Maximum r/w speed speed in bytes per second." , 8131 "format_description" : "bps" 8134 "description" : "Maximum unthrottled read I/O pool speed in operations per second." , 8137 "format_description" : "iops" 8142 "description" : "Maximum unthrottled write pool speed in megabytes per second." , 8143 "format_description" : "mbps" 8148 "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5)." 8151 "description" : "Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS." , 8156 "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit." , 8163 "typetext" : "(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)" , 8167 "pattern" : "(now| \\ d{4}- \\ d{1,2}- \\ d{1,2}(T \\ d{1,2}: \\ d{1,2}: \\ d{1,2})?)" , 8168 "description" : "Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'." 8171 "requires" : "delete" , 8172 "description" : "Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal." , 8178 "description" : "The cluster node name." , 8179 "format" : "pve-node" 8183 "name" : "update_vm" , 8195 "VM.Config.Network" , 8204 "description" : "Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation." , 8220 "description" : "Configuration option name." , 8224 "description" : "Current value." , 8229 "description" : "Indicates a pending delete request if present and not 0. The value 2 indicates a force-delete request." , 8238 "description" : "Pending value." 8248 "format" : "pve-node" , 8249 "description" : "The cluster node name." , 8254 "format" : "pve-vmid" , 8256 "description" : "The (unique) ID of the VM." 8259 "additionalProperties" : 0 8270 "name" : "vm_pending" , 8272 "description" : "Get virtual machine configuration, including pending changes." 8277 "path" : "/nodes/{node}/qemu/{vmid}/pending" 8286 "description" : "Unlink/delete disk images." , 8304 "description" : "The cluster node name." , 8305 "format" : "pve-node" 8310 "description" : "Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal." 8313 "description" : "A list of disk IDs you want to delete." , 8315 "format" : "pve-configid-list" 8319 "description" : "The (unique) ID of the VM." , 8321 "format" : "pve-vmid" 8324 "additionalProperties" : 0 8328 "path" : "/nodes/{node}/qemu/{vmid}/unlink" , 8333 "path" : "/nodes/{node}/qemu/{vmid}/vncproxy" , 8337 "description" : "Creates a TCP VNC proxy connections." , 8350 "description" : "The (unique) ID of the VM." , 8353 "format" : "pve-vmid" 8357 "description" : "The cluster node name." , 8358 "format" : "pve-node" 8361 "description" : "starts websockify instead of vncproxy" , 8366 "additionalProperties" : 0 8368 "name" : "vncproxy" , 8371 "additionalProperties" : 0 , 8405 "description" : "You also need to pass a valid ticket (vncticket)." 8411 "description" : "Port number returned by previous vncproxy call." , 8416 "format" : "pve-node" , 8417 "description" : "The cluster node name." , 8422 "description" : "Ticket from previous call to vncproxy." , 8426 "format" : "pve-vmid" , 8429 "description" : "The (unique) ID of the VM." 8432 "additionalProperties" : 0 8434 "name" : "vncwebsocket" , 8435 "description" : "Opens a weksocket for VNC traffic." , 8447 "text" : "vncwebsocket" , 8449 "path" : "/nodes/{node}/qemu/{vmid}/vncwebsocket" 8453 "path" : "/nodes/{node}/qemu/{vmid}/spiceproxy" , 8457 "name" : "spiceproxy" , 8461 "format" : "address" , 8464 "description" : "SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As resonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI)." 8467 "format" : "pve-vmid" , 8470 "description" : "The (unique) ID of the VM." 8473 "format" : "pve-node" , 8475 "description" : "The cluster node name." 8478 "additionalProperties" : 0 8481 "description" : "Returns a SPICE configuration to connect to the VM." , 8510 "description" : "Returned values can be directly passed to the 'remote-viewer' application." , 8511 "additionalProperties" : 1 8515 "text" : "spiceproxy" 8524 "href" : "{subdir}" , 8538 "description" : "Directory index" , 8547 "format" : "pve-vmid" , 8549 "description" : "The (unique) ID of the VM." 8552 "description" : "The cluster node name." , 8554 "format" : "pve-node" 8557 "additionalProperties" : 0 8569 "format" : "pve-vmid" , 8571 "description" : "The (unique) ID of the VM." , 8576 "description" : "The cluster node name." , 8577 "format" : "pve-node" 8580 "additionalProperties" : 0 8582 "name" : "vm_status" , 8595 "description" : "Get virtual machine status." , 8603 "path" : "/nodes/{node}/qemu/{vmid}/status/current" 8606 "path" : "/nodes/{node}/qemu/{vmid}/status/start" , 8616 "description" : "Some command save/restore state from this location." , 8623 "description" : "The cluster node name." , 8624 "format" : "pve-node" 8627 "pattern" : "(pc|pc(-i440fx)?- \\ d+ \\ . \\ d+( \\ .pxe)?|q35|pc-q35- \\ d+ \\ . \\ d+( \\ .pxe)?)" , 8628 "description" : "Specific the Qemu machine type." , 8636 "description" : "Ignore locks - only root is allowed to use this option." 8640 "format" : "pve-vmid" , 8641 "description" : "The (unique) ID of the VM." , 8645 "description" : "The cluster node name." , 8648 "format" : "pve-node" 8651 "additionalProperties" : 0 8653 "name" : "vm_start" , 8658 "description" : "Start virtual machine." , 8675 "description" : "Stop virtual machine. The qemu process will exit immediately. Thisis akin to pulling the power plug of a running computer and may damage the VM data" , 8696 "description" : "Wait maximal timeout seconds." 8699 "description" : "The cluster node name." , 8702 "format" : "pve-node" 8706 "format" : "pve-vmid" , 8707 "description" : "The (unique) ID of the VM." , 8711 "description" : "Ignore locks - only root is allowed to use this option." , 8716 "description" : "Do not decativate storage volumes." , 8722 "format" : "pve-node" , 8724 "description" : "The cluster node name." 8727 "additionalProperties" : 0 8733 "path" : "/nodes/{node}/qemu/{vmid}/status/stop" , 8737 "path" : "/nodes/{node}/qemu/{vmid}/status/reset" , 8743 "description" : "Reset virtual machine." , 8758 "additionalProperties" : 0 , 8762 "description" : "The cluster node name." , 8763 "format" : "pve-node" 8768 "description" : "Ignore locks - only root is allowed to use this option." 8771 "format" : "pve-vmid" , 8774 "description" : "The (unique) ID of the VM." 8778 "name" : "vm_reset" , 8784 "text" : "shutdown" , 8796 "description" : "Shutdown virtual machine. This is similar to pressing the power button on a physical machine.This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown." , 8801 "name" : "vm_shutdown" , 8803 "additionalProperties" : 0 , 8806 "format" : "pve-node" , 8807 "description" : "The cluster node name." , 8814 "description" : "Make sure the VM stops." 8820 "description" : "Do not decativate storage volumes." 8824 "description" : "Wait maximal timeout seconds." , 8830 "format" : "pve-vmid" , 8831 "description" : "The (unique) ID of the VM." , 8835 "description" : "Ignore locks - only root is allowed to use this option." , 8845 "path" : "/nodes/{node}/qemu/{vmid}/status/shutdown" , 8857 "description" : "The cluster node name." , 8858 "format" : "pve-node" 8862 "format" : "pve-vmid" , 8863 "description" : "The (unique) ID of the VM." , 8867 "description" : "Ignore locks - only root is allowed to use this option." , 8872 "additionalProperties" : 0 8874 "name" : "vm_suspend" , 8888 "description" : "Suspend virtual machine." , 8892 "path" : "/nodes/{node}/qemu/{vmid}/status/suspend" , 8897 "path" : "/nodes/{node}/qemu/{vmid}/status/resume" , 8901 "name" : "vm_resume" , 8903 "additionalProperties" : 0 , 8906 "format" : "pve-node" , 8908 "description" : "The cluster node name." 8911 "description" : "Ignore locks - only root is allowed to use this option." , 8917 "description" : "The (unique) ID of the VM." , 8918 "format" : "pve-vmid" , 8928 "description" : "Resume virtual machine." , 8949 "path" : "/nodes/{node}/qemu/{vmid}/status" 8956 "description" : "Send key event to virtual machine." , 8973 "description" : "The key (qemu monitor encoding)." , 8979 "description" : "Ignore locks - only root is allowed to use this option." 8983 "format" : "pve-vmid" , 8984 "description" : "The (unique) ID of the VM." , 8988 "format" : "pve-node" , 8989 "description" : "The cluster node name." , 8993 "additionalProperties" : 0 8995 "name" : "vm_sendkey" , 8999 "path" : "/nodes/{node}/qemu/{vmid}/sendkey" , 9019 "description" : "Check if feature for virtual machine is available." , 9032 "name" : "vm_feature" , 9037 "format" : "pve-vmid" , 9039 "description" : "The (unique) ID of the VM." 9047 "description" : "Feature to check." , 9052 "format" : "pve-configid" , 9053 "description" : "The name of the snapshot." , 9059 "description" : "The cluster node name." , 9060 "format" : "pve-node" 9063 "additionalProperties" : 0 9069 "path" : "/nodes/{node}/qemu/{vmid}/feature" 9073 "path" : "/nodes/{node}/qemu/{vmid}/clone" , 9078 "name" : "clone_vm" , 9080 "additionalProperties" : 0 , 9084 "format" : "pve-vmid" , 9085 "description" : "VMID for the clone." , 9089 "format" : "pve-storage-id" , 9090 "description" : "Target storage for full clone." , 9091 "requires" : "full" , 9096 "format" : "pve-node" , 9097 "description" : "Target node. Only allowed if the original VM is on shared storage." , 9102 "format" : "pve-configid" , 9104 "description" : "The name of the snapshot." , 9109 "format" : "pve-node" , 9110 "description" : "The cluster node name." , 9116 "description" : "Set a name for the new VM." , 9117 "format" : "dns-name" 9120 "description" : "Add the new VM to the specified pool." , 9123 "format" : "pve-poolid" 9127 "description" : "The (unique) ID of the VM." , 9129 "format" : "pve-vmid" 9137 "description" : "Target format for file storage." , 9138 "requires" : "full" , 9146 "description" : "Create a full copy of all disk. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default." 9149 "description" : "Description for the new VM." , 9158 "description" : "Create a copy of virtual machine/template." , 9161 "description" : "You need 'VM.Clone' permissions on /vms/{vmid}, and 'VM.Allocate' permissions on /vms/{newid} (or on the VM pool /pool/{pool}). You also need 'Datastore.AllocateSpace' on any used storage." , 9197 "text" : "move_disk" , 9201 "description" : "Move volume to different storage." , 9214 "/storage/{storage}" , 9216 "Datastore.AllocateSpace" 9220 "description" : "You need 'VM.Config.Disk' permissions on /vms/{vmid}, and 'Datastore.AllocateSpace' permissions on the storage." 9224 "description" : "the task ID." 9228 "additionalProperties" : 0 , 9231 "format" : "pve-node" , 9232 "description" : "The cluster node name." , 9236 "description" : "Delete the original disk after successful copy. By default the original disk is kept as unused disk." , 9243 "description" : "Target storage." , 9244 "format" : "pve-storage-id" 9247 "description" : "The (unique) ID of the VM." , 9249 "format" : "pve-vmid" , 9254 "description" : "The disk you want to move." , 9302 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 9305 "description" : "Target Format." , 9316 "name" : "move_vm_disk" , 9320 "path" : "/nodes/{node}/qemu/{vmid}/move_disk" , 9325 "path" : "/nodes/{node}/qemu/{vmid}/migrate" , 9338 "description" : "Migrate virtual machine. Creates a new migration task." , 9341 "description" : "the task ID." 9343 "name" : "migrate_vm" , 9347 "format" : "pve-node" , 9349 "description" : "The cluster node name." 9354 "description" : "Use online/live migration." 9359 "description" : "Allow to migrate VMs which use local devices. Only root may use this option." 9363 "description" : "The (unique) ID of the VM." , 9365 "format" : "pve-vmid" 9369 "description" : "Target node." , 9370 "format" : "pve-node" 9373 "additionalProperties" : 0 9382 "path" : "/nodes/{node}/qemu/{vmid}/monitor" , 9389 "additionalProperties" : 0 , 9392 "format" : "pve-node" , 9394 "description" : "The cluster node name." 9398 "description" : "The monitor command." 9401 "format" : "pve-vmid" , 9404 "description" : "The (unique) ID of the VM." 9422 "description" : "Execute Qemu monitor commands." , 9429 "path" : "/nodes/{node}/qemu/{vmid}/resize" , 9436 "format" : "pve-node" , 9438 "description" : "The cluster node name." 9441 "description" : "The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported." , 9442 "pattern" : " \\ +? \\ d+( \\ . \\ d+)?[KMGT]?" , 9447 "description" : "The disk you want to resize." , 9495 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 9499 "description" : "The (unique) ID of the VM." , 9501 "format" : "pve-vmid" 9504 "description" : "Ignore locks - only root is allowed to use this option." , 9509 "additionalProperties" : 0 9511 "name" : "resize_vm" , 9513 "description" : "Extend volume size." , 9533 "path" : "/nodes/{node}/qemu/{vmid}/snapshot" , 9537 "name" : "snapshot" , 9539 "additionalProperties" : 0 , 9542 "description" : "Save the vmstate" , 9548 "description" : "The (unique) ID of the VM." , 9549 "format" : "pve-vmid" , 9554 "description" : "The name of the snapshot." , 9555 "format" : "pve-configid" , 9559 "format" : "pve-node" , 9560 "description" : "The cluster node name." , 9564 "description" : "A textual description or comment." , 9572 "description" : "Snapshot a VM." , 9584 "description" : "the task ID." 9589 "name" : "snapshot_list" , 9594 "description" : "The (unique) ID of the VM." , 9595 "format" : "pve-vmid" , 9600 "description" : "The cluster node name." , 9601 "format" : "pve-node" 9604 "additionalProperties" : 0 9630 "description" : "List all snapshots." 9636 "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}" , 9653 "name" : "snapshot_cmd_idx" , 9661 "format" : "pve-vmid" , 9663 "description" : "The (unique) ID of the VM." 9666 "format" : "pve-node" , 9668 "description" : "The cluster node name." 9671 "format" : "pve-configid" , 9673 "description" : "The name of the snapshot." , 9677 "additionalProperties" : 0 9683 "description" : "Delete a VM snapshot." , 9695 "description" : "the task ID." 9701 "description" : "The (unique) ID of the VM." , 9703 "format" : "pve-vmid" , 9707 "description" : "The cluster node name." , 9709 "format" : "pve-node" 9713 "format" : "pve-configid" , 9714 "description" : "The name of the snapshot." , 9718 "description" : "For removal from config file, even if removing disk snapshots fails." , 9723 "additionalProperties" : 0 9725 "name" : "delsnapshot" , 9729 "text" : "{snapname}" , 9741 "description" : "A textual description or comment." 9744 "format" : "pve-node" , 9746 "description" : "The cluster node name." 9750 "format" : "pve-configid" , 9752 "description" : "The name of the snapshot." 9755 "format" : "pve-vmid" , 9758 "description" : "The (unique) ID of the VM." 9761 "additionalProperties" : 0 9763 "name" : "update_snapshot_config" , 9766 "description" : "Update snapshot metadata." , 9786 "description" : "Get snapshot configuration" , 9791 "description" : "The cluster node name." , 9792 "format" : "pve-node" 9795 "description" : "The name of the snapshot." , 9798 "format" : "pve-configid" 9801 "description" : "The (unique) ID of the VM." , 9804 "format" : "pve-vmid" 9807 "additionalProperties" : 0 9809 "name" : "get_snapshot_config" , 9821 "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config" , 9826 "path" : "/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/rollback" , 9831 "additionalProperties" : 0 , 9834 "format" : "pve-configid" , 9837 "description" : "The name of the snapshot." 9840 "format" : "pve-node" , 9841 "description" : "The cluster node name." , 9845 "description" : "The (unique) ID of the VM." , 9848 "format" : "pve-vmid" 9852 "name" : "rollback" , 9856 "description" : "the task ID." 9868 "description" : "Rollback VM state to specified snapshot." 9879 "text" : "template" , 9882 "name" : "template" , 9884 "additionalProperties" : 0 , 9887 "format" : "pve-node" , 9889 "description" : "The cluster node name." 9892 "description" : "If you want to convert only 1 disk to base image." , 9939 "description" : "The (unique) ID of the VM." , 9941 "format" : "pve-vmid" , 9956 "description" : "You need 'VM.Allocate' permissions on /vms/{vmid}" 9959 "description" : "Create a Template." , 9965 "path" : "/nodes/{node}/qemu/{vmid}/template" , 9982 "href" : "{subdir}" , 9992 "name" : "vmdiridx" , 9996 "format" : "pve-node" , 9998 "description" : "The cluster node name." 10002 "format" : "pve-vmid" , 10003 "type" : "integer" , 10004 "description" : "The (unique) ID of the VM." 10007 "additionalProperties" : 0 10009 "description" : "Directory index" , 10013 "proxyto" : "node" , 10014 "description" : "Destroy the vm (also delete all used/owned volumes)." , 10032 "format" : "pve-vmid" , 10033 "type" : "integer" , 10034 "description" : "The (unique) ID of the VM." 10038 "type" : "boolean" , 10039 "description" : "Ignore locks - only root is allowed to use this option." 10043 "description" : "The cluster node name." , 10044 "format" : "pve-node" 10047 "additionalProperties" : 0 10049 "name" : "destroy_vm" , 10050 "method" : "DELETE" 10064 "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\n NOTE: If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care. \n\n Experimental: user reported problems with this option. \n " , 10065 "pattern" : "(/dev/.+|socket)" 10070 "type" : "integer" , 10072 "description" : "Number of hotplugged vcpus." 10075 "description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file." , 10080 "pattern" : "/dev/parport \\ d+|/dev/usb/lp \\ d+" , 10081 "description" : "Map host parallel devices (n is 0 to 2). \n\n NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care. \n\n Experimental: user reported problems with this option. \n " , 10086 "description" : "Enable/disable ACPI." , 10091 "migrate_downtime" : { 10096 "description" : "Set maximum tolerated downtime (in seconds) for migrations." 10099 "description" : "Set a name for the VM. Only used on the configuration web interface." , 10102 "format" : "dns-name" 10105 "format" : "pve-poolid" , 10106 "description" : "Add the VM to the specified pool." , 10114 "type" : "integer" , 10115 "description" : "The number of cores per socket." 10118 "description" : "The number of CPU sockets." , 10121 "type" : "integer" , 10127 "description" : "Default storage." , 10128 "format" : "pve-storage-id" 10132 "type" : "boolean" , 10133 "description" : "Freeze CPU at startup (use 'c' monitor command to start execution)." 10137 "type" : "boolean" , 10139 "description" : "Specifies whether a VM will be started during system bootup." 10142 "typetext" : "[[order=] \\ d+] [,up= \\ d+] [,down= \\ d+] " , 10143 "format" : "pve-startup-order" , 10146 "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped." 10150 "type" : "boolean" , 10152 "description" : "Enable/disable Qemu GuestAgent." 10155 "description" : "Allow reboot. If set to '0' the VM exit on reboot." , 10156 "type" : "boolean" , 10161 "description" : "Enable booting from specified disk." , 10162 "pattern" : "(ide|sata|scsi|virtio) \\ d+" , 10165 "format" : "pve-qm-bootdisk" 10168 "format" : "pve-vmid" , 10170 "description" : "The (unique) ID of the VM." , 10174 "description" : "Specify SMBIOS type 1 fields." , 10178 "format" : "pve-qm-smbios1" 10181 "description" : "Enable/disable NUMA." , 10189 "maximum" : 500000 , 10190 "type" : "integer" , 10192 "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\n NOTE: You can disable fair-scheduler configuration by setting this to 0." 10197 "format_description" : "bps" , 10198 "type" : "integer" , 10200 "description" : "Maximum read speed speed in bytes per second." 10203 "description" : "Force the drive's physical geometry to have a specific cylinder count." , 10205 "type" : "integer" , 10206 "format_description" : "count" 10209 "description" : "Maximum r/w speed speed in megabytes per second." , 10212 "format_description" : "mbps" 10220 "description" : "Force disk geometry bios translation mode." , 10223 "format_description" : "none|lba|auto" 10229 "description" : "Maximum read speed speed in megabytes per second." , 10232 "format_description" : "mbps" 10235 "format_description" : "mbps" , 10238 "description" : "Maximum write speed speed in megabytes per second." 10241 "description" : "The drive's backing volume." , 10243 "format" : "pve-volume-id-or-qm-path" , 10244 "format_description" : "volume" , 10248 "format_description" : "iops" , 10249 "description" : "Maximum r/w I/O speed in operations per second." , 10250 "type" : "integer" , 10255 "format" : "urlencoded" , 10256 "format_description" : "model" , 10257 "description" : "The drive's reported model name, url-encoded, up to 40 bytes long." , 10262 "format_description" : "native|threads" , 10267 "description" : "AIO type to use." , 10272 "format_description" : "enospc|ignore|report|stop" , 10281 "description" : "Write error action." 10284 "format_description" : "iops" , 10285 "type" : "integer" , 10287 "description" : "Maximum unthrottled write I/O pool speed in operations per second." 10290 "type" : "boolean" , 10292 "description" : "Whether the drive should be included when making backups." , 10293 "format_description" : "on|off" 10296 "format_description" : "bps" , 10297 "description" : "Maximum write speed speed in bytes per second." , 10298 "type" : "integer" , 10302 "format_description" : "iops" , 10303 "description" : "Maximum read I/O speed in operations per second." , 10304 "type" : "integer" , 10308 "format" : "disk-size" , 10309 "description" : "Disk size. This is purely informational and has no effect." , 10314 "format_description" : "mbps" , 10317 "description" : "Maximum unthrottled r/w pool speed in megabytes per second." 10320 "description" : "Force the drive's physical geometry to have a specific head count." , 10322 "type" : "integer" , 10323 "format_description" : "count" 10328 "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long." , 10329 "format" : "urlencoded" , 10331 "format_description" : "serial" 10334 "format_description" : "mbps" , 10337 "description" : "Maximum unthrottled write pool speed in megabytes per second." 10342 "description" : "The drive's backing file's data format." , 10352 "format_description" : "drive format" 10356 "type" : "integer" , 10357 "description" : "Maximum unthrottled read I/O pool speed in operations per second." , 10358 "format_description" : "iops" 10361 "description" : "Maximum r/w speed speed in bytes per second." , 10362 "type" : "integer" , 10364 "format_description" : "bps" 10367 "format_description" : "ignore|on" , 10370 "description" : "Controls whether to pass discard/trim requests to the underlying storage." , 10377 "description" : "Maximum unthrottled read pool speed in megabytes per second." , 10380 "format_description" : "mbps" 10387 "description" : "The drive's media type." , 10390 "default" : "disk" , 10391 "format_description" : "cdrom|disk" 10395 "type" : "integer" , 10396 "description" : "Force the drive's physical geometry to have a specific sector count." , 10397 "format_description" : "count" 10400 "type" : "integer" , 10402 "description" : "Maximum write I/O speed in operations per second." , 10403 "format_description" : "iops" 10405 "detect_zeroes" : { 10407 "type" : "boolean" , 10408 "description" : "Controls whether to detect and try to optimize writes of zeroes." 10411 "format_description" : "ignore|report|stop" , 10414 "description" : "Read error action." , 10422 "format_description" : "none|writethrough|writeback|unsafe|directsync" , 10425 "description" : "The drive's cache mode" , 10435 "format_description" : "on|off" , 10437 "type" : "boolean" , 10438 "description" : "Whether the drive should be included when making snapshots." 10442 "type" : "integer" , 10443 "description" : "Maximum unthrottled r/w I/O pool speed in operations per second." , 10444 "format_description" : "iops" 10447 "description" : "Use volume as IDE hard disk or CD-ROM (n is 0 to 3)." , 10453 "description" : "The backup file." , 10458 "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)" , 10461 "format" : "pve-qm-watchdog" 10466 "default" : "network,disk,usb" , 10467 "description" : "Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory' and 'usb'. Use '0' to disable hotplug completely. Value '1' is an alias for the default 'network,disk,usb'." , 10468 "format" : "pve-hotplug-features" 10471 "description" : "Keybord layout for vnc server. Default is read from the datacenter configuration file." , 10499 "default" : "en-us" , 10504 "format" : "pve-qm-hostpci" , 10507 "description" : "Map host pci devices. HOSTPCIDEVICE syntax is: \n\n 'bus:dev.func' (hexadecimal numbers) \n\n You can us the 'lspci' command to list existing pci devices. \n\n The 'rombar' option determines whether or not the device's ROM will be visible in the guest's memory map (default is 'on'). \n\n NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care. \n\n Experimental: user reported problems with this option. \n " 10518 "description" : "Lock/unlock the VM." 10521 "description" : "Automatic restart after crash (currently ignored)." , 10527 "description" : "Enable/disable time drift fix." , 10529 "type" : "boolean" , 10535 "description" : "host numa nodes to use" , 10536 "pattern" : "(?^: \\ d+(?:- \\ d+)?(?:; \\ d+(?:- \\ d+)?)*)" , 10539 "format_description" : "id[-id];..." 10542 "format_description" : "id[-id];..." , 10544 "description" : "CPUs accessing this numa node." , 10545 "pattern" : "(?^: \\ d+(?:- \\ d+)?(?:; \\ d+(?:- \\ d+)?)*)" 10548 "description" : "numa allocation policy." , 10556 "format_description" : "preferred|bind|interleave" 10559 "format_description" : "mb" , 10562 "description" : "Amount of memory this numa node provides." 10567 "description" : "numa topology" 10573 "pattern" : "[acdn]{1,4}" , 10574 "description" : "Boot on floppy (a), hard disk (c), CD-ROM (d), or network (n)." 10577 "format" : "pve-volume-id" , 10578 "description" : "Reference to unused volumes." , 10585 "description" : "Used to enable special optimization/features for specific \n operating systems: \n\n other => unspecified OS \n wxp => Microsoft Windows XP \n w2k => Microsoft Windows 2000 \n w2k3 => Microsoft Windows 2003 \n w2k8 => Microsoft Windows 2008 \n wvista => Microsoft Windows Vista \n win7 => Microsoft Windows 7 \n win8 => Microsoft Windows 8/2012 \n l24 => Linux 2.4 Kernel \n l26 => Linux 2.6/3.X Kernel \n solaris => solaris/opensolaris/openindiania kernel \n\n other|l24|l26|solaris ... no special behaviour \n wxp|w2k|w2k3|w2k8|wvista|win7|win8 ... use --localtime switch \n " , 10601 "requires" : "archive" , 10602 "description" : "Assign a unique random ethernet address." , 10606 "migrate_speed" : { 10607 "description" : "Set maximum speed (in MB/s) for migrations. Value 0 is no limit." , 10610 "type" : "integer" , 10614 "pattern" : "(now| \\ d{4}- \\ d{1,2}- \\ d{1,2}(T \\ d{1,2}: \\ d{1,2}: \\ d{1,2})?)" , 10615 "description" : "Set the initial date of the real time clock. Valid format for date are: 'now' or '2006-06-17T16:01:21' or '2006-06-17'." , 10619 "typetext" : "(now | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS)" 10623 "type" : "boolean" , 10624 "description" : "Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS." 10627 "description" : "Enable/disable KVM hardware virtualization." , 10629 "type" : "boolean" , 10635 "format_description" : "mbps" , 10636 "description" : "Maximum read speed speed in megabytes per second." , 10643 "description" : "Maximum write speed speed in megabytes per second." , 10644 "format_description" : "mbps" 10647 "description" : "The drive's backing volume." , 10649 "format" : "pve-volume-id-or-qm-path" , 10650 "format_description" : "volume" , 10654 "type" : "integer" , 10656 "description" : "Maximum r/w I/O speed in operations per second." , 10657 "format_description" : "iops" 10660 "description" : "Write error action." , 10669 "format_description" : "enospc|ignore|report|stop" 10676 "description" : "AIO type to use." , 10679 "format_description" : "native|threads" 10682 "format_description" : "iops" , 10684 "type" : "integer" , 10685 "description" : "Maximum unthrottled write I/O pool speed in operations per second." 10688 "type" : "boolean" , 10690 "description" : "Whether the drive should be included when making backups." , 10691 "format_description" : "on|off" 10694 "type" : "integer" , 10696 "description" : "Maximum read speed speed in bytes per second." , 10697 "format_description" : "bps" 10701 "type" : "integer" , 10702 "description" : "Force the drive's physical geometry to have a specific cylinder count." , 10703 "format_description" : "count" 10708 "description" : "Maximum r/w speed speed in megabytes per second." , 10709 "format_description" : "mbps" 10715 "format_description" : "none|lba|auto" , 10723 "description" : "Force disk geometry bios translation mode." 10726 "format_description" : "cdrom|disk" , 10729 "default" : "disk" , 10734 "description" : "The drive's media type." 10737 "description" : "Read error action." , 10745 "format_description" : "ignore|report|stop" 10750 "description" : "The drive's cache mode" , 10758 "format_description" : "none|writethrough|writeback|unsafe|directsync" 10761 "format_description" : "count" , 10762 "description" : "Force the drive's physical geometry to have a specific sector count." , 10763 "type" : "integer" , 10767 "format_description" : "iops" , 10768 "description" : "Maximum write I/O speed in operations per second." , 10772 "detect_zeroes" : { 10773 "description" : "Controls whether to detect and try to optimize writes of zeroes." , 10778 "format_description" : "iops" , 10779 "description" : "Maximum unthrottled r/w I/O pool speed in operations per second." , 10780 "type" : "integer" , 10784 "format_description" : "on|off" , 10785 "description" : "Whether the drive should be included when making snapshots." , 10790 "format_description" : "bps" , 10791 "type" : "integer" , 10793 "description" : "Maximum write speed speed in bytes per second." 10796 "format_description" : "mbps" , 10797 "description" : "Maximum unthrottled r/w pool speed in megabytes per second." , 10802 "format_description" : "iops" , 10804 "type" : "integer" , 10805 "description" : "Maximum read I/O speed in operations per second." 10808 "format" : "disk-size" , 10811 "description" : "Disk size. This is purely informational and has no effect." 10814 "format_description" : "iops" , 10816 "type" : "integer" , 10817 "description" : "Maximum unthrottled read I/O pool speed in operations per second." 10820 "format_description" : "mbps" , 10823 "description" : "Maximum unthrottled write pool speed in megabytes per second." 10826 "format_description" : "bps" , 10827 "description" : "Maximum r/w speed speed in bytes per second." , 10841 "description" : "The drive's backing file's data format." , 10844 "format_description" : "drive format" 10848 "type" : "integer" , 10849 "description" : "Force the drive's physical geometry to have a specific head count." , 10850 "format_description" : "count" 10853 "format_description" : "serial" , 10854 "format" : "urlencoded" , 10856 "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long." , 10861 "description" : "Controls whether to pass discard/trim requests to the underlying storage." , 10868 "format_description" : "ignore|on" 10871 "format_description" : "mbps" , 10874 "description" : "Maximum unthrottled read pool speed in megabytes per second." 10877 "description" : "Use volume as SATA hard disk or CD-ROM (n is 0 to 5)." , 10883 "description" : "The cluster node name." , 10884 "format" : "pve-node" 10887 "requires" : "archive" , 10888 "description" : "Allow to overwrite existing VM." , 10889 "type" : "boolean" , 10898 "description" : "Limit of CPU usage. \n\n NOTE: If the computer has 2 CPUs, it has total of '2' CPU time. Value '0' indicates no CPU limit." 10901 "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)." , 10903 "type" : "boolean" , 10909 "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." , 10925 "description" : "Use volume as VIRTIO hard disk (n is 0 to 15)." , 10930 "description" : "Whether the drive should be included when making snapshots." , 10931 "type" : "boolean" , 10933 "format_description" : "on|off" 10936 "format_description" : "iops" , 10938 "type" : "integer" , 10939 "description" : "Maximum unthrottled r/w I/O pool speed in operations per second." 10942 "format_description" : "off|on" , 10943 "type" : "boolean" , 10945 "description" : "Whether to use iothreads for this drive" 10948 "format_description" : "cdrom|disk" , 10949 "default" : "disk" , 10952 "description" : "The drive's media type." , 10959 "format_description" : "count" , 10960 "description" : "Force the drive's physical geometry to have a specific sector count." , 10965 "type" : "integer" , 10967 "description" : "Maximum write I/O speed in operations per second." , 10968 "format_description" : "iops" 10970 "detect_zeroes" : { 10972 "type" : "boolean" , 10973 "description" : "Controls whether to detect and try to optimize writes of zeroes." 10983 "description" : "Read error action." , 10984 "format_description" : "ignore|report|stop" 10987 "format_description" : "none|writethrough|writeback|unsafe|directsync" , 10995 "description" : "The drive's cache mode" , 11000 "type" : "integer" , 11002 "description" : "Force the drive's physical geometry to have a specific head count." , 11003 "format_description" : "count" 11006 "format_description" : "serial" , 11008 "format" : "urlencoded" , 11009 "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long." , 11014 "format_description" : "mbps" , 11015 "description" : "Maximum unthrottled write pool speed in megabytes per second." , 11020 "description" : "Maximum unthrottled read I/O pool speed in operations per second." , 11021 "type" : "integer" , 11023 "format_description" : "iops" 11035 "description" : "The drive's backing file's data format." , 11038 "format_description" : "drive format" 11041 "format_description" : "bps" , 11043 "type" : "integer" , 11044 "description" : "Maximum r/w speed speed in bytes per second." 11047 "format_description" : "ignore|on" , 11052 "description" : "Controls whether to pass discard/trim requests to the underlying storage." , 11059 "description" : "Maximum unthrottled read pool speed in megabytes per second." , 11060 "format_description" : "mbps" 11063 "description" : "Maximum write speed speed in bytes per second." , 11064 "type" : "integer" , 11066 "format_description" : "bps" 11069 "format_description" : "iops" , 11070 "description" : "Maximum read I/O speed in operations per second." , 11071 "type" : "integer" , 11075 "description" : "Disk size. This is purely informational and has no effect." , 11078 "format" : "disk-size" 11081 "description" : "Maximum unthrottled r/w pool speed in megabytes per second." , 11084 "format_description" : "mbps" 11093 "description" : "AIO type to use." , 11094 "format_description" : "native|threads" 11099 "description" : "Write error action." , 11106 "format_description" : "enospc|ignore|report|stop" 11109 "format_description" : "iops" , 11110 "description" : "Maximum unthrottled write I/O pool speed in operations per second." , 11115 "format_description" : "on|off" , 11116 "type" : "boolean" , 11118 "description" : "Whether the drive should be included when making backups." 11121 "format_description" : "mbps" , 11122 "description" : "Maximum read speed speed in megabytes per second." , 11127 "format_description" : "mbps" , 11130 "description" : "Maximum write speed speed in megabytes per second." 11134 "description" : "The drive's backing volume." , 11136 "format_description" : "volume" , 11137 "format" : "pve-volume-id-or-qm-path" 11140 "format_description" : "iops" , 11141 "type" : "integer" , 11143 "description" : "Maximum r/w I/O speed in operations per second." 11148 "description" : "Force disk geometry bios translation mode." , 11154 "format_description" : "none|lba|auto" 11160 "description" : "Maximum read speed speed in bytes per second." , 11161 "type" : "integer" , 11163 "format_description" : "bps" 11166 "type" : "integer" , 11168 "description" : "Force the drive's physical geometry to have a specific cylinder count." , 11169 "format_description" : "count" 11172 "description" : "Maximum r/w speed speed in megabytes per second." , 11175 "format_description" : "mbps" 11181 "type" : "integer" , 11182 "description" : "Amount of target RAM for the VM in MB. Using zero disables the ballon driver." , 11198 "description" : "Force disk geometry bios translation mode." , 11199 "format_description" : "none|lba|auto" 11203 "format_description" : "nbqueues" , 11205 "type" : "integer" , 11206 "description" : "Number of queues." 11209 "format_description" : "bps" , 11210 "type" : "integer" , 11212 "description" : "Maximum read speed speed in bytes per second." 11215 "format_description" : "mbps" , 11216 "description" : "Maximum r/w speed speed in megabytes per second." , 11221 "description" : "Force the drive's physical geometry to have a specific cylinder count." , 11223 "type" : "integer" , 11224 "format_description" : "count" 11233 "description" : "Write error action." , 11236 "format_description" : "enospc|ignore|report|stop" 11239 "format_description" : "native|threads" , 11246 "description" : "AIO type to use." 11249 "format_description" : "on|off" , 11251 "type" : "boolean" , 11252 "description" : "Whether the drive should be included when making backups." 11255 "format_description" : "iops" , 11256 "type" : "integer" , 11258 "description" : "Maximum unthrottled write I/O pool speed in operations per second." 11261 "format_description" : "mbps" , 11262 "description" : "Maximum write speed speed in megabytes per second." , 11267 "format_description" : "mbps" , 11270 "description" : "Maximum read speed speed in megabytes per second." 11273 "format_description" : "iops" , 11274 "description" : "Maximum r/w I/O speed in operations per second." , 11279 "format" : "pve-volume-id-or-qm-path" , 11280 "format_description" : "volume" , 11282 "description" : "The drive's backing volume." , 11286 "type" : "integer" , 11288 "description" : "Maximum r/w speed speed in bytes per second." , 11289 "format_description" : "bps" 11294 "description" : "Maximum unthrottled write pool speed in megabytes per second." , 11295 "format_description" : "mbps" 11309 "description" : "The drive's backing file's data format." , 11310 "format_description" : "drive format" 11313 "format_description" : "iops" , 11314 "type" : "integer" , 11316 "description" : "Maximum unthrottled read I/O pool speed in operations per second." 11319 "description" : "The drive's reported serial number, url-encoded, up to 20 bytes long." , 11322 "format_description" : "serial" , 11323 "format" : "urlencoded" , 11327 "description" : "Force the drive's physical geometry to have a specific head count." , 11328 "type" : "integer" , 11330 "format_description" : "count" 11333 "format_description" : "mbps" , 11334 "description" : "Maximum unthrottled read pool speed in megabytes per second." , 11343 "description" : "Controls whether to pass discard/trim requests to the underlying storage." , 11346 "format_description" : "ignore|on" 11349 "format_description" : "bps" , 11350 "description" : "Maximum write speed speed in bytes per second." , 11355 "description" : "Maximum unthrottled r/w pool speed in megabytes per second." , 11358 "format_description" : "mbps" 11361 "format" : "disk-size" , 11362 "description" : "Disk size. This is purely informational and has no effect." , 11367 "format_description" : "iops" , 11368 "description" : "Maximum read I/O speed in operations per second." , 11373 "format_description" : "iops" , 11375 "type" : "integer" , 11376 "description" : "Maximum unthrottled r/w I/O pool speed in operations per second." 11379 "description" : "Whether the drive should be included when making snapshots." , 11381 "type" : "boolean" , 11382 "format_description" : "on|off" 11385 "format_description" : "cdrom|disk" , 11386 "description" : "The drive's media type." , 11391 "default" : "disk" , 11396 "format_description" : "off|on" , 11397 "description" : "Whether to use iothreads for this drive" , 11398 "type" : "boolean" , 11402 "description" : "The drive's cache mode" , 11412 "format_description" : "none|writethrough|writeback|unsafe|directsync" 11414 "detect_zeroes" : { 11415 "description" : "Controls whether to detect and try to optimize writes of zeroes." , 11416 "type" : "boolean" , 11420 "format_description" : "iops" , 11421 "description" : "Maximum write I/O speed in operations per second." , 11422 "type" : "integer" , 11426 "format_description" : "count" , 11427 "description" : "Force the drive's physical geometry to have a specific sector count." , 11428 "type" : "integer" , 11434 "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13)." 11439 "description" : "Specify network devices. \n\n MODEL is one of: e1000 e1000-82540em e1000-82544gc e1000-82545em i82551 i82557b i82559er ne2k_isa ne2k_pci pcnet rtl8139 virtio vmxnet3 \n\n XX:XX:XX:XX:XX:XX should be an unique MAC address. This is \n automatically generated if not specified. \n\n The bridge parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'. \n\n Option '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\n If you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services. The following addresses are used: \n\n 10.0.2.2 Gateway \n 10.0.2.3 DNS Server \n 10.0.2.4 SMB Server \n\n The DHCP server assign addresses to the guest starting from 10.0.2.15. \n\n " , 11440 "format" : "pve-qm-net" 11444 "description" : "Specific the Qemu machine type." , 11445 "pattern" : "(pc|pc(-i440fx)?- \\ d+ \\ . \\ d+( \\ .pxe)?|q35|pc-q35- \\ d+ \\ . \\ d+( \\ .pxe)?)" , 11450 "description" : "The number of CPUs. Please use option -sockets instead." , 11452 "type" : "integer" , 11457 "description" : "Select BIOS implementation." , 11462 "default" : "seabios" , 11467 "description" : "Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning" , 11468 "type" : "integer" , 11475 "description" : "Enable/disable Template." , 11485 "virtio-scsi-single" , 11489 "description" : "scsi controller model" , 11497 "description" : "Configure an USB device (n is 0 to 4). This can be used to \n pass-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\n You can use the 'lsusb -t' command to list existing usb devices. \n\n NOTE: This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care. \n\n The value 'spice' can be used to add a usb redirection devices for spice. \n\n The '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 " , 11501 "format_description" : "HOSTUSBDEVICE|spice" , 11502 "format" : "pve-qm-usb-device" , 11504 "description" : "The Host USB device or port or the value spice" 11507 "format_description" : "yes|no" , 11508 "description" : "Specifies whether if given host option is a USB3 device or port" , 11517 "description" : "Do not identify as a KVM virtual machine." , 11518 "type" : "boolean" , 11523 "description" : "Emulated CPU type." , 11554 "default" : "kvm64" , 11556 "format_description" : "cputype" , 11562 "description" : "Emulated CPU type." 11565 "format" : "pve-qm-drive" , 11566 "typetext" : "volume" , 11567 "description" : "This is an alias for option -ide2" , 11572 "description" : "Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device." , 11575 "type" : "integer" , 11579 "description" : "Arbitrary arguments passed to kvm, for example: \n\n args: -no-reboot -no-hpet \n\n NOTE: this option is for experts only. \n " , 11584 "description" : "Sets the protection flag of the VM. This will prevent the remove operation." , 11586 "type" : "boolean" , 11590 "additionalProperties" : 0 11592 "name" : "create_vm" , 11598 "description" : "You need 'VM.Allocate' permissions on /vms/{vmid} or on the VM pool /pool/{pool}. For restore (option 'archive'), it is enough if the user has 'VM.Backup' permission and the VM already exists. If you create disks you need 'Datastore.AllocateSpace' on any used storage." , 11601 "description" : "Create or restore a virtual machine." , 11609 "format" : "pve-node" , 11611 "description" : "The cluster node name." 11615 "type" : "boolean" , 11616 "description" : "Determine the full status of active VMs." 11619 "additionalProperties" : 0 11623 "description" : "Virtual machine index (per node)." , 11624 "proxyto" : "node" , 11627 "description" : "Only list VMs where you have VM.Audit permissons on /vms/<vmid>." 11644 "path" : "/nodes/{node}/qemu" , 11648 "path" : "/nodes/{node}/lxc" , 11653 "path" : "/nodes/{node}/lxc/{vmid}" , 11672 "description" : "Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login)." 11677 "description" : "Container description. Only used on the configuration web interface." 11681 "description" : "Amount of SWAP for the VM in MB." , 11683 "type" : "integer" , 11687 "description" : "OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup." , 11702 "description" : "Makes the container run as unprivileged user. (Should not be modified manually.)" , 11703 "type" : "boolean" , 11710 "description" : "Reference to unused volumes." , 11711 "format" : "pve-volume-id" 11714 "format" : "pve-configid-list" , 11717 "description" : "A list of settings you want to delete." 11720 "description" : "Attach a console device (/dev/console) to the container." , 11728 "format_description" : "ro" , 11729 "description" : "Read-only mountpoint (not supported with bind mounts)" , 11730 "type" : "boolean" , 11734 "description" : "Explicitly enable or disable ACL support." , 11735 "type" : "boolean" , 11737 "format_description" : "acl" 11740 "format_description" : "DiskSize" , 11741 "format" : "disk-size" , 11744 "description" : "Volume size (read only value)." 11747 "description" : "Whether to include the mountpoint in backups." , 11749 "type" : "boolean" , 11750 "format_description" : "[1|0]" 11753 "type" : "boolean" , 11755 "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)" , 11756 "format_description" : "[0|1]" 11760 "format_description" : "volume" , 11761 "format" : "pve-lxc-mp-string" , 11763 "description" : "Volume, device or directory to mount into the container." 11766 "description" : "Path to the mountpoint as seen from inside the container." , 11768 "format" : "pve-lxc-mp-string" , 11769 "format_description" : "Path" 11774 "description" : "Use volume as container mount point (experimental feature)." 11781 "description" : "Limit of CPU usage. \n\n NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit." , 11786 "description" : "The cluster node name." , 11787 "format" : "pve-node" 11790 "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped." , 11793 "format" : "pve-startup-order" , 11794 "typetext" : "[[order=] \\ d+] [,up= \\ d+] [,down= \\ d+] " 11799 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 11803 "description" : "Specifies whether a VM will be started during system bootup." , 11805 "type" : "boolean" , 11810 "type" : "integer" , 11814 "description" : "Specify the number of tty available to the container" 11817 "description" : "OS architecture type." , 11822 "default" : "amd64" , 11829 "format_description" : "[1|0]" , 11831 "type" : "boolean" , 11832 "description" : "Controls whether this interface's firewall rules should be used." 11840 "description" : "Network interface type." 11843 "description" : "IPv4 address in CIDR format." , 11846 "format_description" : "IPv4Format/CIDR" , 11847 "format" : "pve-ipv4-config" 11852 "description" : "VLAN ids to pass through the interface" , 11853 "pattern" : "(?^: \\ d+(?:; \\ d+)*)" , 11854 "format_description" : "vlanid[;vlanid...]" 11857 "format_description" : "GatewayIPv6" , 11859 "description" : "Default gateway for IPv6 traffic." , 11864 "format_description" : "VlanNo" , 11866 "description" : "VLAN tag for this interface." , 11868 "type" : "integer" , 11874 "description" : "IPv6 address in CIDR format." , 11875 "format" : "pve-ipv6-config" , 11876 "format_description" : "IPv6Format/CIDR" 11880 "format_description" : "GatewayIPv4" , 11883 "description" : "Default gateway for IPv4 traffic." 11886 "format_description" : "vmbr<Number>" , 11889 "description" : "Bridge to attach the network device to." , 11890 "pattern" : "[-_. \\ w \\ d]+" 11893 "format_description" : "String" , 11895 "pattern" : "[-_. \\ w \\ d]+" , 11896 "description" : "Name of the network device as seen from inside the container. (lxc.network.name)" 11899 "description" : "Bridge to attach the network device to. (lxc.network.hwaddr)" , 11900 "pattern" : "(?^i:(?:[a-f0-9]{2}:){5}[a-f0-9]{2})" , 11903 "format_description" : "MAC" 11907 "format_description" : "Number" , 11908 "description" : "Maximum transfer unit of the interface. (lxc.network.mtu)" , 11913 "description" : "Apply rate limiting to the interface" , 11916 "format_description" : "mbps" 11919 "description" : "Specifies network interfaces for the container." , 11926 "description" : "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver." , 11927 "format" : "dns-name-list" 11931 "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 the weights of all the other running VMs. \n\n NOTE: You can disable fair-scheduler configuration by setting this to 0." , 11932 "type" : "integer" , 11938 "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." , 11941 "format" : "address-list" 11944 "description" : "The (unique) ID of the VM." , 11945 "type" : "integer" , 11946 "format" : "pve-vmid" , 11951 "format" : "dns-name" , 11954 "description" : "Set a host name for the container." 11957 "description" : "Use volume as container root." , 11962 "format_description" : "acl" , 11963 "type" : "boolean" , 11965 "description" : "Explicitly enable or disable ACL support." 11968 "format_description" : "ro" , 11969 "description" : "Read-only mountpoint (not supported with bind mounts)" , 11974 "format_description" : "[1|0]" , 11975 "description" : "Whether to include the mountpoint in backups." , 11982 "description" : "Volume size (read only value)." , 11983 "format_description" : "DiskSize" , 11984 "format" : "disk-size" 11987 "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)" , 11989 "type" : "boolean" , 11990 "format_description" : "[0|1]" 11993 "format" : "pve-lxc-mp-string" , 11994 "format_description" : "volume" , 11996 "description" : "Volume, device or directory to mount into the container." , 12002 "description" : "Enable/disable Template." , 12004 "type" : "boolean" , 12008 "description" : "Lock/unlock the VM." , 12019 "description" : "Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation." , 12020 "type" : "boolean" , 12025 "description" : "Amount of RAM for the VM in MB." , 12027 "type" : "integer" , 12032 "additionalProperties" : 0 12034 "name" : "update_vm" , 12036 "proxyto" : "node" , 12037 "description" : "Set container options." , 12045 "VM.Config.Memory" , 12046 "VM.Config.Network" , 12047 "VM.Config.Options" 12063 "description" : "SHA1 digest of configuration file. This can be used to prevent concurrent modifications." , 12069 "additionalProperties" : 0 , 12072 "format" : "pve-node" , 12073 "description" : "The cluster node name." , 12077 "description" : "The (unique) ID of the VM." , 12078 "type" : "integer" , 12080 "format" : "pve-vmid" 12093 "name" : "vm_config" , 12094 "description" : "Get container configuration." , 12098 "path" : "/nodes/{node}/lxc/{vmid}/config" , 12102 "path" : "/nodes/{node}/lxc/{vmid}/status" , 12108 "path" : "/nodes/{node}/lxc/{vmid}/status/current" , 12115 "format" : "pve-node" , 12117 "description" : "The cluster node name." 12120 "description" : "The (unique) ID of the VM." , 12121 "type" : "integer" , 12123 "format" : "pve-vmid" 12126 "additionalProperties" : 0 12128 "name" : "vm_status" , 12142 "proxyto" : "node" , 12143 "description" : "Get virtual machine status." 12151 "proxyto" : "node" , 12152 "description" : "Start the container." , 12166 "name" : "vm_start" , 12168 "additionalProperties" : 0 , 12172 "description" : "The cluster node name." , 12173 "format" : "pve-node" 12177 "type" : "boolean" , 12178 "description" : "Ignore locks - only root is allowed to use this option." 12181 "description" : "The (unique) ID of the VM." , 12182 "type" : "integer" , 12184 "format" : "pve-vmid" 12193 "path" : "/nodes/{node}/lxc/{vmid}/status/start" 12210 "description" : "Stop the container. This will abruptly stop all processes running in the container." , 12211 "proxyto" : "node" , 12213 "name" : "vm_stop" , 12217 "description" : "Ignore locks - only root is allowed to use this option." , 12218 "type" : "boolean" , 12222 "format" : "pve-vmid" , 12224 "description" : "The (unique) ID of the VM." , 12228 "format" : "pve-node" , 12229 "description" : "The cluster node name." , 12233 "additionalProperties" : 0 12240 "path" : "/nodes/{node}/lxc/{vmid}/status/stop" 12244 "path" : "/nodes/{node}/lxc/{vmid}/status/shutdown" , 12248 "name" : "vm_shutdown" , 12252 "format" : "pve-node" , 12253 "description" : "The cluster node name." , 12257 "description" : "Make sure the Container stops." , 12259 "type" : "boolean" , 12263 "description" : "Wait maximal timeout seconds." , 12265 "type" : "integer" , 12271 "format" : "pve-vmid" , 12272 "description" : "The (unique) ID of the VM." , 12276 "additionalProperties" : 0 12279 "description" : "Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details." , 12280 "proxyto" : "node" , 12295 "text" : "shutdown" 12299 "path" : "/nodes/{node}/lxc/{vmid}/status/suspend" , 12305 "proxyto" : "node" , 12306 "description" : "Suspend the container." , 12318 "name" : "vm_suspend" , 12320 "additionalProperties" : 0 , 12323 "type" : "integer" , 12324 "description" : "The (unique) ID of the VM." , 12325 "format" : "pve-vmid" , 12329 "description" : "The cluster node name." , 12331 "format" : "pve-node" 12341 "path" : "/nodes/{node}/lxc/{vmid}/status/resume" , 12347 "description" : "Resume the container." , 12348 "proxyto" : "node" , 12364 "description" : "The cluster node name." , 12365 "format" : "pve-node" 12368 "type" : "integer" , 12369 "description" : "The (unique) ID of the VM." , 12370 "format" : "pve-vmid" , 12374 "additionalProperties" : 0 12376 "name" : "vm_resume" 12384 "proxyto" : "node" , 12385 "description" : "Directory index" , 12386 "name" : "vmcmdidx" , 12391 "additionalProperties" : 0 , 12394 "description" : "The cluster node name." , 12396 "format" : "pve-node" 12399 "format" : "pve-vmid" , 12401 "type" : "integer" , 12402 "description" : "The (unique) ID of the VM." 12420 "href" : "{subdir}" 12428 "path" : "/nodes/{node}/lxc/{vmid}/snapshot" , 12430 "text" : "snapshot" , 12433 "text" : "{snapname}" , 12440 "description" : "the task ID." 12442 "proxyto" : "node" , 12443 "description" : "Rollback LXC state to specified snapshot." , 12458 "format" : "pve-configid" , 12460 "description" : "The name of the snapshot." , 12464 "description" : "The cluster node name." , 12466 "format" : "pve-node" 12470 "format" : "pve-vmid" , 12471 "type" : "integer" , 12472 "description" : "The (unique) ID of the VM." 12475 "additionalProperties" : 0 12477 "name" : "rollback" 12480 "text" : "rollback" , 12482 "path" : "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}/rollback" 12492 "description" : "Get snapshot configuration" , 12493 "proxyto" : "node" , 12495 "additionalProperties" : 0 , 12498 "type" : "integer" , 12499 "description" : "The (unique) ID of the VM." , 12501 "format" : "pve-vmid" 12504 "format" : "pve-node" , 12505 "description" : "The cluster node name." , 12509 "format" : "pve-configid" , 12512 "description" : "The name of the snapshot." 12525 "name" : "get_snapshot_config" 12529 "name" : "update_snapshot_config" , 12531 "additionalProperties" : 0 , 12535 "description" : "The cluster node name." , 12536 "format" : "pve-node" 12539 "description" : "The name of the snapshot." , 12541 "format" : "pve-configid" , 12545 "description" : "A textual description or comment." , 12551 "format" : "pve-vmid" , 12552 "type" : "integer" , 12553 "description" : "The (unique) ID of the VM." 12558 "description" : "Update snapshot metadata." , 12559 "proxyto" : "node" , 12574 "path" : "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config" , 12583 "description" : "The (unique) ID of the VM." , 12584 "type" : "integer" , 12586 "format" : "pve-vmid" 12590 "description" : "The name of the snapshot." , 12591 "format" : "pve-configid" , 12595 "format" : "pve-node" , 12596 "description" : "The cluster node name." , 12600 "additionalProperties" : 0 12602 "name" : "snapshot_cmd_idx" , 12606 "description" : "" , 12632 "proxyto" : "node" , 12633 "description" : "Delete a LXC snapshot." , 12635 "description" : "the task ID." , 12638 "name" : "delsnapshot" , 12640 "additionalProperties" : 0 , 12643 "type" : "integer" , 12644 "description" : "The (unique) ID of the VM." , 12646 "format" : "pve-vmid" 12649 "format" : "pve-node" , 12651 "description" : "The cluster node name." 12654 "description" : "For removal from config file, even if removing disk snapshots fails." , 12655 "type" : "boolean" , 12660 "format" : "pve-configid" , 12662 "description" : "The name of the snapshot." 12667 "method" : "DELETE" 12670 "path" : "/nodes/{node}/lxc/{vmid}/snapshot/{snapname}" , 12685 "description" : "List all snapshots." , 12686 "proxyto" : "node" , 12703 "format" : "pve-node" , 12705 "description" : "The cluster node name." 12708 "format" : "pve-vmid" , 12710 "description" : "The (unique) ID of the VM." , 12714 "additionalProperties" : 0 12722 "additionalProperties" : 0 , 12725 "description" : "The (unique) ID of the VM." , 12726 "type" : "integer" , 12727 "format" : "pve-vmid" , 12733 "description" : "A textual description or comment." 12736 "description" : "The name of the snapshot." , 12739 "format" : "pve-configid" 12742 "format" : "pve-node" , 12744 "description" : "The cluster node name." 12748 "name" : "snapshot" , 12760 "description" : "Snapshot a container." , 12761 "proxyto" : "node" , 12763 "description" : "the task ID." , 12775 "path" : "/nodes/{node}/lxc/{vmid}/firewall/rules/{pos}" , 12792 "type" : "integer" , 12793 "description" : "The (unique) ID of the VM." , 12794 "format" : "pve-vmid" , 12798 "type" : "integer" , 12800 "description" : "Update rule at position <pos>." , 12804 "format" : "pve-node" , 12806 "description" : "The cluster node name." 12809 "additionalProperties" : 0 12811 "name" : "get_rule" , 12822 "description" : "Get single rule data." 12830 "description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." , 12831 "format" : "pve-fw-addr-spec" 12835 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 12840 "format" : "pve-fw-addr-spec" , 12843 "description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." 12847 "type" : "integer" , 12849 "description" : "Move rule to new position <moveto>. Other arguments are ignored." 12853 "description" : "The cluster node name." , 12854 "format" : "pve-node" 12863 "description" : "A list of settings you want to delete." , 12864 "format" : "pve-configid-list" 12867 "format" : "pve-fw-dport-spec" , 12870 "description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." 12882 "description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 12885 "format" : "pve-fw-sport-spec" 12888 "format" : "pve-iface" , 12891 "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." , 12897 "type" : "integer" , 12898 "description" : "Update rule at position <pos>." , 12904 "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'." , 12905 "format" : "pve-fw-protocol-spec" 12908 "format" : "pve-vmid" , 12910 "description" : "The (unique) ID of the VM." , 12920 "type" : "integer" , 12927 "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name." , 12928 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 12932 "additionalProperties" : 0 12934 "name" : "update_rule" , 12942 "VM.Config.Network" 12946 "description" : "Modify rule data." , 12953 "name" : "delete_rule" , 12955 "additionalProperties" : 0 , 12958 "description" : "The cluster node name." , 12960 "format" : "pve-node" 12964 "type" : "integer" , 12966 "description" : "Update rule at position <pos>." 12970 "format" : "pve-vmid" , 12971 "type" : "integer" , 12972 "description" : "The (unique) ID of the VM." 12978 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 12983 "method" : "DELETE" , 12989 "VM.Config.Network" 12994 "description" : "Delete rule." , 13008 "description" : "The cluster node name." , 13009 "format" : "pve-node" 13012 "description" : "The (unique) ID of the VM." , 13013 "type" : "integer" , 13015 "format" : "pve-vmid" 13018 "additionalProperties" : 0 13029 "name" : "get_rules" , 13031 "description" : "List rules." , 13053 "name" : "create_rule" , 13057 "format" : "pve-vmid" , 13059 "description" : "The (unique) ID of the VM." , 13065 "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'." , 13066 "format" : "pve-fw-protocol-spec" 13070 "description" : "Update rule at position <pos>." , 13083 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 13084 "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name." , 13097 "type" : "integer" , 13102 "format" : "pve-fw-dport-spec" , 13105 "description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." 13108 "format" : "pve-fw-sport-spec" , 13111 "description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." 13116 "description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." , 13117 "format" : "pve-fw-addr-spec" 13123 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 13126 "format" : "pve-fw-addr-spec" , 13127 "description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." , 13136 "description" : "The cluster node name." , 13138 "format" : "pve-node" 13142 "format" : "pve-iface" , 13143 "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." , 13149 "additionalProperties" : 0 13152 "description" : "Create new rule." , 13159 "VM.Config.Network" 13168 "path" : "/nodes/{node}/lxc/{vmid}/firewall/rules" , 13174 "path" : "/nodes/{node}/lxc/{vmid}/firewall/aliases/{name}" , 13195 "description" : "The (unique) ID of the VM." , 13196 "type" : "integer" , 13197 "format" : "pve-vmid" , 13201 "format" : "pve-node" , 13203 "description" : "The cluster node name." 13208 "description" : "Alias name." , 13209 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 13213 "additionalProperties" : 0 13215 "name" : "read_alias" , 13216 "description" : "Read alias." 13220 "description" : "Update IP or Network alias." , 13229 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 13230 "description" : "Rename an existing alias." , 13239 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 13240 "description" : "Alias name." 13243 "format" : "pve-node" , 13245 "description" : "The cluster node name." 13250 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 13255 "description" : "Network/IP specification in CIDR format." , 13256 "format" : "IPorCIDR" 13260 "format" : "pve-vmid" , 13261 "type" : "integer" , 13262 "description" : "The (unique) ID of the VM." 13265 "additionalProperties" : 0 13267 "name" : "update_alias" , 13273 "VM.Config.Network" 13286 "method" : "DELETE" , 13292 "VM.Config.Network" 13297 "additionalProperties" : 0 , 13302 "description" : "Alias name." , 13303 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 13307 "description" : "The cluster node name." , 13309 "format" : "pve-node" 13312 "type" : "integer" , 13313 "description" : "The (unique) ID of the VM." , 13315 "format" : "pve-vmid" 13321 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 13325 "name" : "remove_alias" , 13327 "description" : "Remove IP or Network alias." 13332 "text" : "aliases" , 13344 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 13366 "description" : "List aliases" , 13377 "additionalProperties" : 0 , 13381 "description" : "The cluster node name." , 13382 "format" : "pve-node" 13385 "type" : "integer" , 13386 "description" : "The (unique) ID of the VM." , 13387 "format" : "pve-vmid" , 13392 "name" : "get_aliases" 13404 "VM.Config.Network" 13409 "additionalProperties" : 0 , 13417 "description" : "Alias name." , 13418 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 13423 "description" : "The cluster node name." , 13425 "format" : "pve-node" 13428 "description" : "The (unique) ID of the VM." , 13429 "type" : "integer" , 13430 "format" : "pve-vmid" , 13435 "description" : "Network/IP specification in CIDR format." , 13436 "format" : "IPorCIDR" 13440 "name" : "create_alias" , 13441 "description" : "Create IP or Network Alias." , 13445 "path" : "/nodes/{node}/lxc/{vmid}/firewall/aliases" , 13450 "path" : "/nodes/{node}/lxc/{vmid}/firewall/ipset" , 13462 "name" : "ipset_index" , 13464 "additionalProperties" : 0 , 13467 "format" : "pve-node" , 13469 "description" : "The cluster node name." 13472 "type" : "integer" , 13473 "description" : "The (unique) ID of the VM." , 13475 "format" : "pve-vmid" 13479 "description" : "List IPSets" , 13498 "description" : "IP set name." , 13499 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 13506 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 13519 "description" : "Create new IPSet" , 13525 "VM.Config.Network" 13530 "additionalProperties" : 0 , 13533 "description" : "The (unique) ID of the VM." , 13534 "type" : "integer" , 13535 "format" : "pve-vmid" , 13540 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 13550 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 13551 "description" : "Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet." , 13557 "format" : "pve-node" , 13559 "description" : "The cluster node name." 13563 "description" : "IP set name." , 13564 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 13570 "name" : "create_ipset" 13576 "path" : "/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}" , 13585 "method" : "DELETE" , 13591 "VM.Config.Network" 13596 "additionalProperties" : 0 , 13599 "description" : "The (unique) ID of the VM." , 13600 "type" : "integer" , 13602 "format" : "pve-vmid" 13608 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 13612 "description" : "Network/IP specification in CIDR format." , 13613 "format" : "IPorCIDRorAlias" 13618 "description" : "IP set name." , 13619 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 13624 "description" : "The cluster node name." , 13625 "format" : "pve-node" 13629 "name" : "remove_ip" , 13631 "description" : "Remove IP or Network from IPSet." 13639 "additionalProperties" : 0 , 13642 "format" : "IPorCIDRorAlias" , 13643 "description" : "Network/IP specification in CIDR format." , 13649 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 13653 "type" : "integer" , 13654 "description" : "The (unique) ID of the VM." , 13656 "format" : "pve-vmid" 13664 "description" : "The cluster node name." , 13665 "format" : "pve-node" 13670 "description" : "IP set name." , 13671 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 13685 "VM.Config.Network" 13689 "name" : "update_ip" , 13690 "description" : "Update IP or Network settings" , 13698 "name" : "read_ip" , 13711 "format" : "IPorCIDRorAlias" , 13713 "description" : "Network/IP specification in CIDR format." 13717 "format" : "pve-vmid" , 13718 "type" : "integer" , 13719 "description" : "The (unique) ID of the VM." 13722 "format" : "pve-node" , 13723 "description" : "The cluster node name." , 13729 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 13730 "description" : "IP set name." , 13734 "additionalProperties" : 0 13737 "description" : "Read IP or Network settings from IPSet." 13742 "path" : "/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr}" 13748 "description" : "List IPSet content" , 13750 "additionalProperties" : 0 , 13753 "description" : "IP set name." , 13754 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 13760 "format" : "pve-node" , 13761 "description" : "The cluster node name." , 13765 "description" : "The (unique) ID of the VM." , 13766 "type" : "integer" , 13768 "format" : "pve-vmid" 13772 "name" : "get_ipset" , 13791 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 13801 "type" : "boolean" , 13819 "method" : "DELETE" , 13820 "name" : "delete_ipset" , 13824 "format" : "pve-vmid" , 13826 "description" : "The (unique) ID of the VM." , 13831 "description" : "The cluster node name." , 13832 "format" : "pve-node" 13836 "description" : "IP set name." , 13837 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 13842 "additionalProperties" : 0 13849 "VM.Config.Network" 13854 "description" : "Delete IPSet" 13857 "description" : "Add IP or Network to IPSet." , 13859 "name" : "create_ip" , 13865 "VM.Config.Network" 13872 "type" : "boolean" , 13877 "description" : "IP set name." , 13878 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 13884 "description" : "The cluster node name." , 13885 "format" : "pve-node" 13892 "description" : "Network/IP specification in CIDR format." , 13894 "format" : "IPorCIDRorAlias" 13897 "format" : "pve-vmid" , 13899 "description" : "The (unique) ID of the VM." , 13903 "additionalProperties" : 0 13915 "text" : "options" , 13925 "description" : "Log level for incoming traffic." , 13944 "description" : "Output policy." , 13949 "description" : "Allow sending Router Advertisement." , 13950 "type" : "boolean" , 13955 "type" : "boolean" , 13956 "description" : "Enable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added." 13959 "description" : "Input policy." , 13969 "description" : "Enable/disable MAC address filter." , 13975 "type" : "boolean" , 13976 "description" : "Enable NDP." 13979 "description" : "Enable DHCP." , 13983 "log_level_out" : { 13995 "description" : "Log level for outgoing traffic." , 14000 "description" : "Enable/disable firewall rules." , 14018 "type" : "integer" , 14019 "description" : "The (unique) ID of the VM." , 14020 "format" : "pve-vmid" , 14025 "description" : "The cluster node name." , 14026 "format" : "pve-node" 14029 "additionalProperties" : 0 14031 "name" : "get_options" , 14032 "description" : "Get VM firewall options." , 14037 "name" : "set_options" , 14041 "description" : "Enable/disable firewall rules." , 14045 "log_level_out" : { 14046 "description" : "Log level for outgoing traffic." , 14062 "type" : "integer" , 14063 "description" : "The (unique) ID of the VM." , 14064 "format" : "pve-vmid" , 14070 "description" : "A list of settings you want to delete." , 14071 "format" : "pve-configid-list" 14079 "description" : "Output policy." , 14095 "description" : "Log level for incoming traffic." , 14100 "description" : "Enable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added." , 14105 "description" : "The cluster node name." , 14107 "format" : "pve-node" 14110 "description" : "Allow sending Router Advertisement." , 14111 "type" : "boolean" , 14115 "type" : "boolean" , 14117 "description" : "Enable/disable MAC address filter." 14125 "description" : "Input policy." , 14130 "description" : "Enable NDP." , 14131 "type" : "boolean" , 14136 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 14141 "type" : "boolean" , 14143 "description" : "Enable DHCP." 14146 "additionalProperties" : 0 14149 "proxyto" : "node" , 14150 "description" : "Set Firewall options." , 14156 "VM.Config.Network" 14165 "path" : "/nodes/{node}/lxc/{vmid}/firewall/options" , 14174 "additionalProperties" : 0 , 14177 "description" : "The cluster node name." , 14179 "format" : "pve-node" 14183 "type" : "integer" , 14187 "format" : "pve-vmid" , 14189 "description" : "The (unique) ID of the VM." , 14204 "description" : "Line text" , 14208 "description" : "Line number" , 14225 "proxyto" : "node" , 14226 "description" : "Read firewall log" 14231 "path" : "/nodes/{node}/lxc/{vmid}/firewall/log" 14237 "description" : "Lists possible IPSet/Alias reference which are allowed in source/dest properties." , 14248 "additionalProperties" : 0 , 14251 "format" : "pve-vmid" , 14253 "description" : "The (unique) ID of the VM." , 14263 "description" : "Only list references of specified type." 14267 "description" : "The cluster node name." , 14268 "format" : "pve-node" 14298 "path" : "/nodes/{node}/lxc/{vmid}/firewall/refs" , 14302 "text" : "firewall" , 14305 "description" : "Directory index." , 14313 "format" : "pve-vmid" , 14314 "type" : "integer" , 14315 "description" : "The (unique) ID of the VM." 14318 "format" : "pve-node" , 14320 "description" : "The cluster node name." 14323 "additionalProperties" : 0 14342 "path" : "/nodes/{node}/lxc/{vmid}/firewall" , 14349 "description" : "Read VM RRD statistics (returns PNG)" , 14353 "additionalProperties" : 0 , 14356 "description" : "The cluster node name." , 14358 "format" : "pve-node" 14362 "description" : "Specify the time frame you are interested in." , 14372 "description" : "The list of datasources you want to display." , 14374 "format" : "pve-configid-list" 14383 "description" : "The RRD consolidation function" 14386 "format" : "pve-vmid" , 14388 "description" : "The (unique) ID of the VM." , 14413 "path" : "/nodes/{node}/lxc/{vmid}/rrd" , 14417 "text" : "rrddata" , 14421 "additionalProperties" : 0 , 14424 "format" : "pve-node" , 14426 "description" : "The cluster node name." 14430 "description" : "Specify the time frame you are interested in." , 14440 "description" : "The (unique) ID of the VM." , 14441 "type" : "integer" , 14443 "format" : "pve-vmid" 14450 "description" : "The RRD consolidation function" , 14465 "name" : "rrddata" , 14466 "description" : "Read VM RRD statistics" , 14478 "path" : "/nodes/{node}/lxc/{vmid}/rrddata" , 14482 "text" : "vncproxy" , 14486 "description" : "Creates a TCP VNC proxy connections." , 14490 "format" : "pve-vmid" , 14492 "description" : "The (unique) ID of the VM." , 14496 "type" : "boolean" , 14498 "description" : "use websocket instead of standard VNC." 14502 "description" : "The cluster node name." , 14503 "format" : "pve-node" 14506 "additionalProperties" : 0 14517 "name" : "vncproxy" , 14520 "additionalProperties" : 0 , 14541 "path" : "/nodes/{node}/lxc/{vmid}/vncproxy" , 14545 "text" : "vncwebsocket" , 14552 "description" : "Ticket from previous call to vncproxy." , 14558 "type" : "integer" , 14559 "description" : "Port number returned by previous vncproxy call." 14562 "format" : "pve-node" , 14563 "description" : "The cluster node name." , 14567 "description" : "The (unique) ID of the VM." , 14568 "type" : "integer" , 14569 "format" : "pve-vmid" , 14573 "additionalProperties" : 0 14575 "name" : "vncwebsocket" , 14584 "description" : "You also need to pass a valid ticket (vncticket)." 14586 "description" : "Opens a weksocket for VNC traffic." , 14598 "path" : "/nodes/{node}/lxc/{vmid}/vncwebsocket" , 14602 "path" : "/nodes/{node}/lxc/{vmid}/spiceproxy" , 14604 "text" : "spiceproxy" , 14609 "additionalProperties" : 0 , 14612 "format" : "pve-vmid" , 14614 "type" : "integer" , 14615 "description" : "The (unique) ID of the VM." 14620 "description" : "SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As resonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI)." , 14621 "format" : "address" 14624 "format" : "pve-node" , 14625 "description" : "The cluster node name." , 14630 "name" : "spiceproxy" , 14632 "description" : "Returns a SPICE configuration to connect to the CT." , 14633 "proxyto" : "node" , 14644 "description" : "Returned values can be directly passed to the 'remote-viewer' application." , 14645 "additionalProperties" : 1 , 14669 "path" : "/nodes/{node}/lxc/{vmid}/migrate" , 14676 "format" : "pve-node" , 14677 "description" : "Target node." , 14682 "format" : "pve-vmid" , 14683 "description" : "The (unique) ID of the VM." , 14687 "description" : "Use online/live migration." , 14688 "type" : "boolean" , 14692 "format" : "pve-node" , 14694 "description" : "The cluster node name." 14698 "type" : "boolean" , 14699 "description" : "Force migration despite local bind / device mounts. WARNING: identical bind / device mounts need to be available on the target node." 14702 "additionalProperties" : 0 14704 "name" : "migrate_vm" , 14708 "description" : "the task ID." 14719 "proxyto" : "node" , 14720 "description" : "Migrate the container to another node. Creates a new migration task." 14728 "name" : "vm_feature" , 14730 "additionalProperties" : 0 , 14733 "format" : "pve-node" , 14735 "description" : "The cluster node name." 14740 "description" : "The name of the snapshot." , 14741 "format" : "pve-configid" , 14748 "description" : "Feature to check." , 14752 "description" : "The (unique) ID of the VM." , 14753 "type" : "integer" , 14755 "format" : "pve-vmid" 14770 "proxyto" : "node" , 14771 "description" : "Check if feature for virtual machine is available." , 14782 "text" : "feature" , 14784 "path" : "/nodes/{node}/lxc/{vmid}/feature" 14787 "text" : "template" , 14790 "name" : "template" , 14792 "additionalProperties" : 0 , 14796 "format" : "pve-vmid" , 14797 "type" : "integer" , 14798 "description" : "The (unique) ID of the VM." 14801 "format" : "pve-node" , 14802 "description" : "The cluster node name." , 14807 "type" : "boolean" , 14808 "description" : "The template feature is experimental, set this flag if you know what you are doing." 14815 "description" : "You need 'VM.Allocate' permissions on /vms/{vmid}" , 14824 "description" : "Create a Template." , 14825 "proxyto" : "node" , 14831 "path" : "/nodes/{node}/lxc/{vmid}/template" , 14835 "path" : "/nodes/{node}/lxc/{vmid}/clone" , 14840 "name" : "clone_vm" , 14842 "additionalProperties" : 0 , 14846 "type" : "boolean" , 14848 "description" : "Create a full copy of all disk. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default." 14851 "type" : "boolean" , 14853 "description" : "The clone feature is experimental, set this flag if you know what you are doing." 14856 "description" : "Description for the new CT." , 14861 "format" : "dns-name" , 14864 "description" : "Set a hostname for the new CT." 14868 "format" : "pve-vmid" , 14869 "description" : "The (unique) ID of the VM." , 14873 "description" : "The cluster node name." , 14875 "format" : "pve-node" 14878 "format" : "pve-configid" , 14882 "description" : "The name of the snapshot." 14887 "description" : "Add the new CT to the specified pool." , 14888 "format" : "pve-poolid" 14892 "format" : "pve-vmid" , 14893 "type" : "integer" , 14894 "description" : "VMID for the clone." 14897 "format" : "pve-storage-id" , 14900 "requires" : "full" , 14901 "description" : "Target storage for full clone." 14937 "description" : "You need 'VM.Clone' permissions on /vms/{vmid}, and 'VM.Allocate' permissions on /vms/{newid} (or on the VM pool /pool/{pool}). You also need 'Datastore.AllocateSpace' on any used storage." 14939 "proxyto" : "node" , 14940 "description" : "Create a container clone/copy" , 14954 "format" : "pve-node" , 14956 "description" : "The cluster node name." 14960 "description" : "The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported." , 14961 "pattern" : " \\ +? \\ d+( \\ . \\ d+)?[KMGT]?" 14964 "format" : "pve-vmid" , 14966 "description" : "The (unique) ID of the VM." , 14970 "description" : "The disk you want to resize." , 14989 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 14993 "additionalProperties" : 0 14995 "name" : "resize_vm" , 15009 "description" : "Resize a container mountpoint." , 15010 "proxyto" : "node" , 15012 "description" : "the task ID." , 15017 "path" : "/nodes/{node}/lxc/{vmid}/resize" , 15024 "description" : "Destroy the container (also delete all uses files)." , 15025 "proxyto" : "node" , 15039 "name" : "destroy_vm" , 15043 "format" : "pve-vmid" , 15045 "type" : "integer" , 15046 "description" : "The (unique) ID of the VM." 15049 "format" : "pve-node" , 15051 "description" : "The cluster node name." 15054 "additionalProperties" : 0 15056 "method" : "DELETE" 15064 "href" : "{subdir}" 15077 "proxyto" : "node" , 15078 "description" : "Directory index" , 15079 "name" : "vmdiridx" , 15081 "additionalProperties" : 0 , 15085 "description" : "The cluster node name." , 15086 "format" : "pve-node" 15089 "description" : "The (unique) ID of the VM." , 15090 "type" : "integer" , 15091 "format" : "pve-vmid" , 15106 "name" : "create_vm" , 15108 "additionalProperties" : 0 , 15111 "description" : "Default Storage." , 15112 "default" : "local" , 15115 "format" : "pve-storage-id" 15118 "type" : "boolean" , 15121 "description" : "Specifies whether a VM will be started during system bootup." 15124 "description" : "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped." , 15127 "format" : "pve-startup-order" , 15128 "typetext" : "[[order=] \\ d+] [,up= \\ d+] [,down= \\ d+] " 15131 "description" : "Attach a console device (/dev/console) to the container." , 15139 "description" : "Add the VM to the specified pool." , 15140 "format" : "pve-poolid" 15148 "description" : "Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login)." , 15156 "description" : "Container description. Only used on the configuration web interface." 15167 "description" : "Lock/unlock the VM." 15172 "description" : "Use volume as container root." , 15175 "type" : "boolean" , 15177 "description" : "Read-only mountpoint (not supported with bind mounts)" , 15178 "format_description" : "ro" 15181 "description" : "Explicitly enable or disable ACL support." , 15183 "type" : "boolean" , 15184 "format_description" : "acl" 15187 "description" : "Whether to include the mountpoint in backups." , 15188 "type" : "boolean" , 15190 "format_description" : "[1|0]" 15193 "format" : "disk-size" , 15194 "format_description" : "DiskSize" , 15195 "description" : "Volume size (read only value)." , 15201 "format" : "pve-lxc-mp-string" , 15202 "format_description" : "volume" , 15204 "description" : "Volume, device or directory to mount into the container." 15207 "format_description" : "[0|1]" , 15209 "type" : "boolean" , 15210 "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)" 15215 "format" : "pve-vmid" , 15217 "description" : "The (unique) ID of the VM." , 15222 "maximum" : 500000 , 15224 "type" : "integer" , 15226 "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 the weights of all the other running VMs. \n\n NOTE: You can disable fair-scheduler configuration by setting this to 0." 15230 "description" : "Specify the number of tty available to the container" , 15237 "default" : "amd64" , 15240 "description" : "OS architecture type." , 15248 "description" : "The OS template or backup file." , 15252 "type" : "boolean" , 15254 "description" : "Allow to overwrite existing container." 15257 "format" : "pve-node" , 15259 "description" : "The cluster node name." 15267 "description" : "Limit of CPU usage. \n\n NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit." 15273 "type" : "boolean" , 15274 "description" : "Whether to include the mountpoint in backups." , 15275 "format_description" : "[1|0]" 15278 "format_description" : "DiskSize" , 15279 "format" : "disk-size" , 15282 "description" : "Volume size (read only value)." 15285 "description" : "Explicitly enable or disable ACL support." , 15286 "type" : "boolean" , 15288 "format_description" : "acl" 15291 "format_description" : "ro" , 15292 "description" : "Read-only mountpoint (not supported with bind mounts)" , 15293 "type" : "boolean" , 15297 "format_description" : "volume" , 15298 "format" : "pve-lxc-mp-string" , 15300 "description" : "Volume, device or directory to mount into the container." , 15305 "type" : "boolean" , 15306 "description" : "Enable user quotas inside the container (not supported with zfs subvolumes)" , 15307 "format_description" : "[0|1]" 15311 "description" : "Path to the mountpoint as seen from inside the container." , 15312 "format_description" : "Path" , 15313 "format" : "pve-lxc-mp-string" 15316 "description" : "Use volume as container mount point (experimental feature)." , 15321 "type" : "boolean" , 15324 "description" : "Makes the container run as unprivileged user. (Should not be modified manually.)" 15327 "description" : "Reference to unused volumes." , 15330 "format" : "pve-volume-id" 15333 "description" : "Amount of SWAP for the VM in MB." , 15336 "type" : "integer" , 15342 "description" : "OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup." , 15355 "description" : "Amount of RAM for the VM in MB." , 15356 "type" : "integer" , 15361 "ssh-public-keys" : { 15362 "description" : "Setup public SSH keys (one key per line, OpenSSH format)." , 15367 "type" : "boolean" , 15370 "description" : "Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation." 15372 "ignore-unpack-errors" : { 15373 "type" : "boolean" , 15375 "description" : "Ignore errors when extracting the template." 15378 "description" : "Enable/disable Template." , 15380 "type" : "boolean" , 15385 "type" : "boolean" , 15386 "description" : "Mark this as restore task." 15389 "format" : "dns-name" , 15391 "description" : "Set a host name for the container." , 15398 "description" : "Sets root password inside container." , 15402 "format" : "dns-name-list" , 15405 "description" : "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver." 15408 "format" : "address-list" , 15409 "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." , 15417 "format_description" : "GatewayIPv6" , 15418 "description" : "Default gateway for IPv6 traffic." , 15423 "description" : "VLAN tag for this interface." , 15424 "type" : "integer" , 15426 "maximum" : "4094" , 15427 "format_description" : "VlanNo" , 15431 "format_description" : "[1|0]" , 15432 "description" : "Controls whether this interface's firewall rules should be used." , 15439 "description" : "Network interface type." , 15445 "format_description" : "vlanid[;vlanid...]" , 15448 "pattern" : "(?^: \\ d+(?:; \\ d+)*)" , 15449 "description" : "VLAN ids to pass through the interface" 15452 "format" : "pve-ipv4-config" , 15453 "format_description" : "IPv4Format/CIDR" , 15454 "description" : "IPv4 address in CIDR format." , 15459 "description" : "Apply rate limiting to the interface" , 15462 "format_description" : "mbps" 15467 "description" : "IPv6 address in CIDR format." , 15468 "format" : "pve-ipv6-config" , 15469 "format_description" : "IPv6Format/CIDR" 15473 "format_description" : "GatewayIPv4" , 15474 "description" : "Default gateway for IPv4 traffic." , 15479 "format_description" : "vmbr<Number>" , 15482 "description" : "Bridge to attach the network device to." , 15483 "pattern" : "[-_. \\ w \\ d]+" 15487 "description" : "Name of the network device as seen from inside the container. (lxc.network.name)" , 15488 "pattern" : "[-_. \\ w \\ d]+" , 15489 "format_description" : "String" 15492 "description" : "Maximum transfer unit of the interface. (lxc.network.mtu)" , 15493 "type" : "integer" , 15495 "format_description" : "Number" , 15499 "format_description" : "MAC" , 15500 "description" : "Bridge to attach the network device to. (lxc.network.hwaddr)" , 15501 "pattern" : "(?^i:(?:[a-f0-9]{2}:){5}[a-f0-9]{2})" , 15506 "description" : "Specifies network interfaces for the container." , 15517 "description" : "You need 'VM.Allocate' permissions on /vms/{vmid} or on the VM pool /pool/{pool}. For restore, it is enough if the user has 'VM.Backup' permission and the VM already exists. You also need 'Datastore.AllocateSpace' permissions on the storage." , 15520 "proxyto" : "node" , 15521 "description" : "Create or restore a container." 15526 "additionalProperties" : 0 , 15530 "description" : "The cluster node name." , 15531 "format" : "pve-node" 15538 "description" : "Only list CTs where you have VM.Audit permissons on /vms/<vmid>." , 15541 "proxyto" : "node" , 15542 "description" : "LXC container index (per node)." , 15562 "description" : "Directory index." , 15566 "format" : "pve-node" , 15568 "description" : "The cluster node name." 15571 "additionalProperties" : 0 15606 "name" : "createosd" , 15608 "additionalProperties" : 0 , 15611 "format" : "pve-node" , 15612 "description" : "The cluster node name." , 15621 "description" : "File system type." , 15629 "description" : "Block device name for journal." 15632 "description" : "Block device name." , 15637 "proxyto" : "node" , 15638 "description" : "Create OSD" , 15658 "proxyto" : "node" , 15659 "description" : "Get Ceph osd list/tree." , 15667 "format" : "pve-node" , 15668 "description" : "The cluster node name." , 15672 "additionalProperties" : 0 15681 "path" : "/nodes/{node}/ceph/osd/{osdid}" , 15684 "name" : "destroyosd" , 15686 "additionalProperties" : 0 , 15689 "type" : "integer" , 15690 "description" : "OSD ID" 15693 "description" : "If set, we remove partition table entries." , 15695 "type" : "boolean" , 15699 "format" : "pve-node" , 15701 "description" : "The cluster node name." 15706 "description" : "Destroy OSD" , 15707 "proxyto" : "node" , 15708 "method" : "DELETE" , 15728 "description" : "ceph osd in" , 15729 "proxyto" : "node" , 15737 "type" : "integer" , 15738 "description" : "OSD ID" 15741 "format" : "pve-node" , 15742 "description" : "The cluster node name." , 15746 "additionalProperties" : 0 15752 "path" : "/nodes/{node}/ceph/osd/{osdid}/in" , 15757 "path" : "/nodes/{node}/ceph/osd/{osdid}/out" , 15769 "proxyto" : "node" , 15770 "description" : "ceph osd out" , 15777 "format" : "pve-node" , 15779 "description" : "The cluster node name." 15782 "type" : "integer" , 15783 "description" : "OSD ID" 15786 "additionalProperties" : 0 15801 "path" : "/nodes/{node}/ceph/osd" 15804 "path" : "/nodes/{node}/ceph/disks" , 15809 "proxyto" : "node" , 15810 "description" : "List local disks." , 15862 "additionalProperties" : 0 , 15866 "description" : "The cluster node name." , 15867 "format" : "pve-node" 15872 "description" : "Only list specific types of disks." , 15885 "path" : "/nodes/{node}/ceph/config" , 15894 "description" : "Get Ceph configuration." , 15896 "additionalProperties" : 0 , 15899 "format" : "pve-node" , 15900 "description" : "The cluster node name." , 15922 "path" : "/nodes/{node}/ceph/mon" , 15927 "path" : "/nodes/{node}/ceph/mon/{monid}" , 15929 "text" : "{monid}" , 15932 "proxyto" : "node" , 15933 "description" : "Destroy Ceph monitor." , 15948 "additionalProperties" : 0 , 15952 "description" : "The cluster node name." , 15953 "format" : "pve-node" 15956 "description" : "Monitor ID" , 15961 "name" : "destroymon" , 15962 "method" : "DELETE" 15971 "additionalProperties" : 0 , 15975 "description" : "The cluster node name." , 15976 "format" : "pve-node" 15980 "name" : "listmon" , 16014 "description" : "Get Ceph monitor list." , 16027 "description" : "Create Ceph Monitor" , 16028 "proxyto" : "node" , 16035 "format" : "pve-node" , 16037 "description" : "The cluster node name." 16040 "additionalProperties" : 0 16042 "name" : "createmon" , 16054 "proxyto" : "node" , 16055 "description" : "Create initial ceph default configuration and setup symlinks." , 16071 "description" : "Placement group bits, used to specify the default number of placement groups. \n\n NOTE: 'osd pool default pg num' does not work for default pools." , 16075 "type" : "integer" , 16082 "type" : "integer" , 16084 "description" : "Number of replicas per object" 16087 "description" : "The cluster node name." , 16089 "format" : "pve-node" 16094 "description" : "Use specific network for all ceph related traffic" , 16099 "additionalProperties" : 0 16105 "path" : "/nodes/{node}/ceph/init" 16108 "path" : "/nodes/{node}/ceph/stop" , 16118 "format" : "pve-node" , 16119 "description" : "The cluster node name." , 16125 "description" : "Ceph service name." , 16126 "pattern" : "(mon|mds|osd) \\ .[A-Za-z0-9]{1,32}" 16129 "additionalProperties" : 0 16144 "description" : "Stop ceph services." , 16150 "path" : "/nodes/{node}/ceph/start" , 16164 "proxyto" : "node" , 16165 "description" : "Start ceph services." , 16171 "additionalProperties" : 0 , 16174 "format" : "pve-node" , 16175 "description" : "The cluster node name." , 16179 "description" : "Ceph service name." , 16180 "pattern" : "(mon|mds|osd) \\ .[A-Za-z0-9]{1,32}" , 16197 "additionalProperties" : 0 , 16200 "format" : "pve-node" , 16201 "description" : "The cluster node name." , 16208 "description" : "Get ceph status." , 16209 "proxyto" : "node" , 16227 "path" : "/nodes/{node}/ceph/status" , 16235 "additionalProperties" : 0 , 16239 "description" : "The cluster node name." , 16240 "format" : "pve-node" 16244 "name" : "lspools" , 16246 "proxyto" : "node" , 16247 "description" : "List all pools." , 16264 "href" : "{pool_name}" 16288 "proxyto" : "node" , 16289 "description" : "Create POOL" , 16301 "name" : "createpool" , 16303 "additionalProperties" : 0 , 16309 "type" : "integer" , 16310 "description" : "Number of replicas per object" , 16314 "format" : "pve-node" , 16316 "description" : "The cluster node name." 16319 "description" : "The name of the pool. It must be unique." , 16322 "crush_ruleset" : { 16325 "type" : "integer" , 16328 "description" : "The ruleset to use for mapping object placement in the cluster." 16332 "type" : "integer" , 16335 "description" : "Number of placement groups." , 16340 "type" : "integer" , 16343 "description" : "Minimum number of replicas per object" , 16352 "path" : "/nodes/{node}/ceph/pools/{name}" , 16357 "method" : "DELETE" , 16362 "format" : "pve-node" , 16363 "description" : "The cluster node name." , 16368 "description" : "The name of the pool. It must be unique." 16371 "additionalProperties" : 0 16373 "name" : "destroypool" , 16377 "proxyto" : "node" , 16378 "description" : "Destroy pool" , 16394 "path" : "/nodes/{node}/ceph/pools" 16398 "path" : "/nodes/{node}/ceph/crush" , 16413 "description" : "Get OSD crush map" , 16414 "proxyto" : "node" , 16421 "format" : "pve-node" , 16422 "description" : "The cluster node name." , 16426 "additionalProperties" : 0 16444 "description" : "Line text" 16447 "type" : "integer" , 16448 "description" : "Line number" 16454 "description" : "Read ceph log" , 16455 "proxyto" : "node" , 16472 "type" : "integer" , 16476 "description" : "The cluster node name." , 16478 "format" : "pve-node" 16481 "type" : "integer" , 16486 "additionalProperties" : 0 16492 "path" : "/nodes/{node}/ceph/log" 16497 "path" : "/nodes/{node}/ceph" 16505 "description" : "The user needs 'VM.Backup' permissions on any VM, and 'Datastore.AllocateSpace' on the backup storage." 16507 "description" : "Create backup." , 16508 "proxyto" : "node" , 16516 "format" : "pve-vmid-list" , 16517 "description" : "Exclude specified guest systems (assumes --all)" , 16522 "format" : "pve-node" , 16525 "description" : "Only run if executed on this node." 16528 "description" : "Unused, will be removed in a future release." , 16529 "type" : "integer" , 16535 "type" : "integer" , 16538 "description" : "Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count." 16541 "format" : "pve-storage-id" , 16542 "description" : "Store resulting file to this storage." , 16548 "type" : "boolean" , 16550 "description" : "Exclude temporary files and logs." 16553 "format" : "string-alist" , 16556 "description" : "Exclude certain files/directories (shell globs)." 16559 "description" : "Be quiet." , 16561 "type" : "boolean" , 16566 "type" : "integer" , 16568 "description" : "Maximal time to wait until a guest system is stopped (minutes)." , 16572 "description" : "Remove old backup files if there are more than 'maxfiles' backup files." , 16573 "type" : "boolean" , 16578 "description" : "Write tar to stdout, not to a file." , 16579 "type" : "boolean" , 16584 "type" : "boolean" , 16586 "description" : "Backup all known guest systems on this host." 16588 "mailnotification" : { 16589 "description" : "Specify when to send an email" , 16594 "default" : "always" , 16600 "type" : "integer" , 16603 "description" : "Maximal time to wait for the global lock (minutes)." 16608 "description" : "Use specified hook script." 16613 "description" : "Store resulting files to specified directory." 16618 "description" : "Comma-separated list of email addresses that should receive email notifications." , 16619 "format" : "string-list" 16625 "description" : "Compress dump file." , 16636 "description" : "Store temporary files to specified directory." 16639 "description" : "Backup mode." , 16645 "default" : "snapshot" , 16652 "type" : "integer" , 16653 "description" : "Maximal number of backup files per guest system." , 16657 "type" : "boolean" , 16660 "description" : "Stop runnig backup jobs on this host." 16665 "type" : "integer" , 16668 "description" : "Set CFQ ionice priority." 16672 "type" : "integer" , 16674 "description" : "Limit I/O bandwidth (KBytes per second)." , 16678 "format" : "pve-vmid-list" , 16679 "description" : "The ID of the guest system you want to backup." , 16684 "additionalProperties" : 0 16690 "path" : "/nodes/{node}/vzdump" , 16697 "additionalProperties" : 0 , 16701 "description" : "The cluster node name." , 16702 "format" : "pve-node" 16718 "proxyto" : "node" , 16719 "description" : "Service list." , 16724 "href" : "{service}" 16735 "text" : "services" , 16739 "path" : "/nodes/{node}/services/{service}" , 16747 "href" : "{subdir}" 16760 "description" : "Directory index" , 16761 "name" : "srvcmdidx" , 16781 "systemd-timesyncd" 16783 "description" : "Service ID" , 16787 "description" : "The cluster node name." , 16789 "format" : "pve-node" 16792 "additionalProperties" : 0 16808 "path" : "/nodes/{node}/services/{service}/state" , 16824 "proxyto" : "node" , 16825 "description" : "Read service properties" , 16827 "name" : "service_state" , 16832 "description" : "The cluster node name." , 16833 "format" : "pve-node" 16852 "systemd-timesyncd" 16854 "description" : "Service ID" , 16858 "additionalProperties" : 0 16881 "description" : "Start service." , 16882 "proxyto" : "node" , 16884 "name" : "service_start" , 16905 "systemd-timesyncd" 16907 "description" : "Service ID" 16910 "format" : "pve-node" , 16911 "description" : "The cluster node name." , 16915 "additionalProperties" : 0 16920 "path" : "/nodes/{node}/services/{service}/start" , 16930 "description" : "Stop service." , 16931 "proxyto" : "node" , 16943 "name" : "service_stop" , 16945 "additionalProperties" : 0 , 16948 "format" : "pve-node" , 16950 "description" : "The cluster node name." 16969 "systemd-timesyncd" 16971 "description" : "Service ID" , 16978 "path" : "/nodes/{node}/services/{service}/stop" , 16982 "path" : "/nodes/{node}/services/{service}/restart" , 16984 "text" : "restart" , 16987 "proxyto" : "node" , 16988 "description" : "Restart service." , 17003 "additionalProperties" : 0 , 17006 "description" : "The cluster node name." , 17008 "format" : "pve-node" 17027 "systemd-timesyncd" 17029 "description" : "Service ID" , 17034 "name" : "service_restart" , 17040 "path" : "/nodes/{node}/services/{service}/reload" , 17045 "name" : "service_reload" , 17047 "additionalProperties" : 0 , 17051 "description" : "Service ID" , 17068 "systemd-timesyncd" 17073 "description" : "The cluster node name." , 17074 "format" : "pve-node" 17089 "description" : "Reload service." , 17090 "proxyto" : "node" , 17098 "text" : "{service}" 17102 "path" : "/nodes/{node}/services" 17105 "text" : "subscription" , 17114 "description" : "The cluster node name." , 17116 "format" : "pve-node" 17119 "additionalProperties" : 0 17122 "description" : "Read subscription info." , 17123 "proxyto" : "node" , 17135 "additionalProperties" : 0 , 17138 "format" : "pve-node" , 17139 "description" : "The cluster node name." , 17143 "description" : "Proxmox VE subscription key" , 17150 "description" : "Set subscription key." , 17154 "proxyto" : "node" , 17156 "description" : "Update subscription info." , 17158 "additionalProperties" : 0 , 17161 "description" : "Always connect to server, even if we have up to date info inside local cache." , 17163 "type" : "boolean" , 17168 "description" : "The cluster node name." , 17169 "format" : "pve-node" 17180 "path" : "/nodes/{node}/subscription" , 17184 "path" : "/nodes/{node}/network" , 17202 "proxyto" : "node" , 17203 "description" : "Delete network device configuration" , 17204 "method" : "DELETE" , 17208 "format" : "pve-node" , 17210 "description" : "The cluster node name." 17214 "format" : "pve-iface" , 17215 "description" : "Network interface name." , 17220 "additionalProperties" : 0 17222 "name" : "delete_network" , 17238 "proxyto" : "node" , 17239 "description" : "Update network device configuration" , 17241 "name" : "update_network" , 17243 "additionalProperties" : 0 , 17248 "description" : "Specify the interfaces used by the bonding device." , 17249 "format" : "pve-iface-list" 17252 "format" : "ipv4mask" , 17255 "description" : "Network mask." , 17256 "requires" : "address" 17260 "requires" : "netmask" , 17261 "description" : "IP address." , 17266 "format" : "pve-iface-list" , 17267 "description" : "Specify the iterfaces you want to add to your bridge." , 17273 "type" : "boolean" , 17274 "description" : "Automatically start interface on boot." 17278 "description" : "Network interface type" , 17295 "description" : "Default ipv6 gateway address." , 17302 "description" : "Default gateway address." 17307 "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port." , 17308 "format" : "pve-iface" 17313 "description" : "A list of settings you want to delete." , 17314 "format" : "pve-configid-list" 17317 "description" : "Comments" , 17323 "type" : "integer" , 17325 "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)" , 17329 "description" : "OVS interface options." , 17336 "description" : "The cluster node name." , 17337 "format" : "pve-node" 17342 "description" : "Comments" 17344 "bridge_vlan_aware" : { 17346 "type" : "boolean" , 17347 "description" : "Enable bridge vlan support." 17353 "description" : "IP address." , 17354 "requires" : "netmask6" 17356 "bond_xmit_hash_policy" : { 17357 "description" : "Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes." , 17367 "format" : "pve-iface-list" , 17368 "description" : "Specify the interfaces used by the bonding device." , 17375 "description" : "Bonding mode." , 17385 "lacp-balance-slb" , 17390 "format" : "pve-iface" , 17393 "description" : "Network interface name." , 17397 "format" : "pve-iface-list" , 17400 "description" : "Specify the iterfaces you want to add to your bridge." 17404 "type" : "integer" , 17406 "requires" : "address6" , 17407 "description" : "Network mask." , 17415 "description" : "Read network device configuration" , 17416 "proxyto" : "node" , 17418 "additionalProperties" : 0 , 17421 "format" : "pve-node" , 17423 "description" : "The cluster node name." 17427 "description" : "Network interface name." , 17430 "format" : "pve-iface" 17434 "name" : "network_config" , 17458 "text" : "{iface}" , 17460 "path" : "/nodes/{node}/network/{iface}" 17463 "text" : "network" , 17480 "proxyto" : "node" , 17481 "description" : "List available networks" , 17487 "additionalProperties" : 0 , 17492 "description" : "Only list specific interface types." , 17507 "format" : "pve-node" , 17508 "description" : "The cluster node name." , 17515 "proxyto" : "node" , 17516 "description" : "Revert network configuration changes." , 17531 "additionalProperties" : 0 , 17534 "description" : "The cluster node name." , 17536 "format" : "pve-node" 17540 "name" : "revert_network_changes" , 17541 "method" : "DELETE" 17545 "name" : "create_network" , 17549 "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port." , 17552 "format" : "pve-iface" 17557 "description" : "Default gateway address." , 17562 "description" : "Default ipv6 gateway address." , 17567 "format" : "pve-node" , 17569 "description" : "The cluster node name." 17572 "maxLength" : 1024 , 17573 "description" : "OVS interface options." , 17580 "description" : "Comments" 17584 "type" : "integer" , 17586 "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)" , 17592 "requires" : "address" , 17593 "description" : "Network mask." , 17594 "format" : "ipv4mask" 17599 "description" : "Specify the interfaces used by the bonding device." , 17600 "format" : "pve-iface-list" 17615 "description" : "Network interface type" , 17619 "description" : "Automatically start interface on boot." , 17620 "type" : "boolean" , 17624 "format" : "pve-iface-list" , 17627 "description" : "Specify the iterfaces you want to add to your bridge." 17630 "requires" : "netmask" , 17631 "description" : "IP address." , 17637 "description" : "Bonding mode." , 17647 "lacp-balance-slb" , 17654 "format" : "pve-iface-list" , 17657 "description" : "Specify the interfaces used by the bonding device." 17662 "type" : "integer" , 17664 "description" : "Network mask." , 17665 "requires" : "address6" 17670 "description" : "Specify the iterfaces you want to add to your bridge." , 17671 "format" : "pve-iface-list" 17674 "format" : "pve-iface" , 17677 "description" : "Network interface name." , 17683 "description" : "Comments" 17685 "bridge_vlan_aware" : { 17686 "description" : "Enable bridge vlan support." , 17692 "description" : "IP address." , 17693 "requires" : "netmask6" , 17697 "bond_xmit_hash_policy" : { 17705 "description" : "Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes." 17708 "additionalProperties" : 0 17711 "proxyto" : "node" , 17712 "description" : "Create network device configuration" , 17729 "path" : "/nodes/{node}/tasks" , 17735 "path" : "/nodes/{node}/tasks/{upid}" , 17743 "description" : "The user needs 'Sys.Modify' permissions on '/nodes/<node>' if the task does not belong to him." 17745 "description" : "Stop a task." , 17746 "proxyto" : "node" , 17747 "method" : "DELETE" , 17748 "name" : "stop_task" , 17750 "additionalProperties" : 0 , 17754 "description" : "The cluster node name." , 17755 "format" : "pve-node" 17779 "description" : "" , 17781 "additionalProperties" : 0 , 17784 "format" : "pve-node" , 17785 "description" : "The cluster node name." , 17793 "name" : "upid_index" , 17804 "name" : "read_task_log" , 17809 "type" : "integer" , 17816 "description" : "The cluster node name." , 17818 "format" : "pve-node" 17821 "type" : "integer" , 17826 "additionalProperties" : 0 17835 "type" : "integer" , 17836 "description" : "Line number" 17840 "description" : "Line text" 17846 "description" : "The user needs 'Sys.Audit' permissions on '/nodes/<node>' if the task does not belong to him." , 17849 "proxyto" : "node" , 17850 "description" : "Read task log." 17855 "path" : "/nodes/{node}/tasks/{upid}/log" 17858 "path" : "/nodes/{node}/tasks/{upid}/status" , 17863 "name" : "read_task_status" , 17865 "additionalProperties" : 0 , 17868 "format" : "pve-node" , 17869 "description" : "The cluster node name." , 17880 "description" : "The user needs 'Sys.Audit' permissions on '/nodes/<node>' if the task does not belong to him." , 17883 "proxyto" : "node" , 17884 "description" : "Read task status." , 17927 "proxyto" : "node" , 17928 "description" : "Read task list for one node (finished tasks)." , 17931 "description" : "List task associated with the current user, or all task the user has 'Sys.Audit' permissions on /nodes/<node> (the <node> the task runs on)." 17934 "additionalProperties" : 0 , 17937 "description" : "Only list tasks for this VM." , 17938 "type" : "integer" , 17940 "format" : "pve-vmid" , 17953 "description" : "The cluster node name." , 17955 "format" : "pve-node" 17959 "type" : "integer" , 17968 "name" : "node_tasks" 17974 "path" : "/nodes/{node}/scan" , 17978 "additionalProperties" : 0 , 17981 "description" : "The cluster node name." , 17983 "format" : "pve-node" 17991 "description" : "Index of available scan methods" , 18006 "href" : "{method}" 18016 "proxyto" : "node" , 18017 "description" : "Scan zfs pool list on local node." , 18023 "Datastore.Allocate" 18042 "description" : "The cluster node name." , 18044 "format" : "pve-node" 18047 "additionalProperties" : 0 18049 "name" : "zfsscan" , 18055 "path" : "/nodes/{node}/scan/zfs" 18059 "path" : "/nodes/{node}/scan/nfs" , 18062 "description" : "Scan remote NFS server." , 18063 "proxyto" : "node" , 18069 "Datastore.Allocate" 18088 "name" : "nfsscan" , 18092 "format" : "pve-node" , 18093 "description" : "The cluster node name." , 18097 "format" : "pve-storage-server" , 18101 "additionalProperties" : 0 18110 "path" : "/nodes/{node}/scan/glusterfs" , 18129 "Datastore.Allocate" 18133 "description" : "Scan remote GlusterFS server." , 18134 "proxyto" : "node" , 18136 "name" : "glusterfsscan" , 18140 "format" : "pve-node" , 18142 "description" : "The cluster node name." 18145 "format" : "pve-storage-server" , 18149 "additionalProperties" : 0 18154 "text" : "glusterfs" 18160 "proxyto" : "node" , 18161 "description" : "Scan remote iSCSI server." , 18167 "Datastore.Allocate" 18190 "format" : "pve-storage-portal-dns" 18194 "description" : "The cluster node name." , 18195 "format" : "pve-node" 18198 "additionalProperties" : 0 18200 "name" : "iscsiscan" , 18204 "path" : "/nodes/{node}/scan/iscsi" , 18221 "proxyto" : "node" , 18222 "description" : "List local LVM volume groups." , 18228 "Datastore.Allocate" 18234 "name" : "lvmscan" , 18236 "additionalProperties" : 0 , 18239 "format" : "pve-node" , 18240 "description" : "The cluster node name." , 18249 "path" : "/nodes/{node}/scan/lvm" 18257 "format" : "pve-node" , 18259 "description" : "The cluster node name." 18262 "pattern" : "[a-zA-Z0-9 \\ . \\ + \\ _][a-zA-Z0-9 \\ . \\ + \\ _ \\ -]+" , 18267 "additionalProperties" : 0 18269 "name" : "lvmthinscan" , 18277 "Datastore.Allocate" 18281 "description" : "List local LVM Thin Pools." , 18282 "proxyto" : "node" , 18296 "text" : "lvmthin" , 18298 "path" : "/nodes/{node}/scan/lvmthin" 18301 "path" : "/nodes/{node}/scan/usb" , 18315 "proxyto" : "node" , 18316 "description" : "List local USB devices." , 18365 "name" : "usbscan" , 18367 "additionalProperties" : 0 , 18370 "format" : "pve-node" , 18372 "description" : "The cluster node name." 18385 "path" : "/nodes/{node}/storage" , 18387 "text" : "storage" , 18391 "path" : "/nodes/{node}/storage/{storage}" , 18397 "href" : "{subdir}" , 18413 "additionalProperties" : 0 , 18416 "description" : "The cluster node name." , 18418 "format" : "pve-node" 18421 "description" : "The storage identifier." , 18423 "format" : "pve-storage-id" 18430 "/storage/{storage}" , 18433 "Datastore.AllocateSpace" 18443 "text" : "{storage}" , 18450 "additionalProperties" : 0 , 18453 "description" : "The storage identifier." , 18455 "format" : "pve-storage-id" 18458 "format" : "pve-vmid" , 18460 "description" : "Only list images for this VM" , 18465 "format" : "pve-node" , 18467 "description" : "The cluster node name." 18470 "description" : "Only list content of this type." , 18473 "format" : "pve-storage-content" 18491 "href" : "{volid}" , 18499 "/storage/{storage}" , 18502 "Datastore.AllocateSpace" 18508 "proxyto" : "node" , 18509 "description" : "List storage content." 18513 "description" : "Volume identifier" , 18516 "description" : "Allocate disk images." , 18517 "proxyto" : "node" , 18521 "/storage/{storage}" , 18523 "Datastore.AllocateSpace" 18530 "additionalProperties" : 0 , 18533 "requires" : "size" , 18543 "format" : "pve-vmid" , 18545 "description" : "Specify owner VM" , 18549 "format" : "pve-storage-id" , 18550 "description" : "The storage identifier." , 18554 "pattern" : " \\ d+[MG]?" , 18555 "description" : "Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)" , 18560 "description" : "The name of the file to create." 18564 "description" : "The cluster node name." , 18565 "format" : "pve-node" 18579 "proxyto" : "node" , 18580 "description" : "Get volume attributes" , 18582 "description" : "You need read access for the volume." , 18588 "additionalProperties" : 0 , 18593 "description" : "The storage identifier." , 18594 "format" : "pve-storage-id" 18597 "description" : "The cluster node name." , 18599 "format" : "pve-node" 18602 "description" : "Volume identifier" , 18611 "additionalProperties" : 0 , 18615 "description" : "Volume identifier" 18618 "description" : "The cluster node name." , 18620 "format" : "pve-node" 18623 "format" : "pve-storage-id" , 18624 "description" : "The storage identifier." , 18632 "method" : "DELETE" , 18634 "description" : "You need 'Datastore.Allocate' privilege on the storage (or 'Datastore.AllocateSpace' for backup volumes if you have VM.Backup privilege on the VM)." , 18637 "proxyto" : "node" , 18638 "description" : "Delete volume" , 18645 "additionalProperties" : 0 , 18649 "description" : "Target volume identifier" 18654 "description" : "Target node. Default is local node." , 18655 "format" : "pve-node" 18658 "format" : "pve-storage-id" , 18659 "description" : "The storage identifier." , 18665 "description" : "Source volume identifier" 18668 "description" : "The cluster node name." , 18670 "format" : "pve-node" 18675 "description" : "Copy a volume. This is experimental code - do not use." , 18677 "proxyto" : "node" , 18684 "text" : "{volume}" , 18686 "path" : "/nodes/{node}/storage/{storage}/content/{volume}" 18689 "text" : "content" , 18691 "path" : "/nodes/{node}/storage/{storage}/content" 18695 "path" : "/nodes/{node}/storage/{storage}/status" , 18701 "/storage/{storage}" , 18704 "Datastore.AllocateSpace" 18710 "description" : "Read storage status." , 18711 "proxyto" : "node" , 18719 "description" : "The storage identifier." , 18721 "format" : "pve-storage-id" 18724 "description" : "The cluster node name." , 18726 "format" : "pve-node" 18729 "additionalProperties" : 0 18731 "name" : "read_status" , 18746 "description" : "The list of datasources you want to display." , 18747 "format" : "pve-configid-list" 18750 "description" : "The cluster node name." , 18752 "format" : "pve-node" 18763 "description" : "Specify the time frame you are interested in." 18767 "description" : "The storage identifier." , 18768 "format" : "pve-storage-id" 18777 "description" : "The RRD consolidation function" 18780 "additionalProperties" : 0 18784 "proxyto" : "node" , 18785 "description" : "Read storage RRD statistics (returns PNG)." , 18789 "/storage/{storage}" , 18792 "Datastore.AllocateSpace" 18810 "path" : "/nodes/{node}/storage/{storage}/rrd" 18819 "format" : "pve-node" , 18820 "description" : "The cluster node name." , 18825 "description" : "Specify the time frame you are interested in." , 18835 "format" : "pve-storage-id" , 18837 "description" : "The storage identifier." 18846 "description" : "The RRD consolidation function" 18849 "additionalProperties" : 0 18851 "name" : "rrddata" , 18853 "proxyto" : "node" , 18854 "description" : "Read storage RRD statistics." , 18858 "/storage/{storage}" , 18861 "Datastore.AllocateSpace" 18876 "text" : "rrddata" , 18878 "path" : "/nodes/{node}/storage/{storage}/rrddata" 18881 "path" : "/nodes/{node}/storage/{storage}/upload" , 18890 "description" : "Upload templates and ISO images." , 18893 "additionalProperties" : 0 , 18896 "format" : "pve-storage-id" , 18897 "description" : "The storage identifier." , 18903 "description" : "The source file name. This parameter is usually set by the REST handler. You can only overwrite it when connecting to the trustet port on localhost." 18906 "description" : "Content type." , 18908 "format" : "pve-storage-content" 18912 "description" : "The name of the file to create." 18915 "description" : "The cluster node name." , 18917 "format" : "pve-node" 18925 "/storage/{storage}" , 18927 "Datastore.AllocateTemplate" 18940 "description" : "Only list entries where you have 'Datastore.Audit' or 'Datastore.AllocateSpace' permissions on '/storage/<storage>'" , 18943 "proxyto" : "node" , 18944 "description" : "Get status for all datastores." , 18957 "href" : "{storage}" , 18965 "format" : "pve-node" , 18966 "description" : "If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node." , 18971 "format" : "pve-storage-id" , 18974 "description" : "Only list status for specified storage" 18977 "description" : "Only list stores which are enabled (not disabled in config)." , 18978 "type" : "boolean" , 18983 "format" : "pve-storage-content-list" , 18986 "description" : "Only list stores which support this content type." 18989 "format" : "pve-node" , 18990 "description" : "The cluster node name." , 18994 "additionalProperties" : 0 19020 "description" : "This is used to resynchronize the package index files from their sources (apt-get update)." , 19021 "proxyto" : "node" , 19023 "name" : "update_database" , 19025 "additionalProperties" : 0 , 19028 "description" : "Send notification mail about new packages (to email address specified for user 'root@pam')." , 19030 "type" : "boolean" , 19036 "type" : "boolean" , 19037 "description" : "Only produces output suitable for logging, omitting progress indicators." 19040 "format" : "pve-node" , 19041 "description" : "The cluster node name." , 19050 "name" : "list_updates" , 19055 "description" : "The cluster node name." , 19056 "format" : "pve-node" 19059 "additionalProperties" : 0 19078 "description" : "List available updates." , 19084 "path" : "/nodes/{node}/apt/update" 19088 "path" : "/nodes/{node}/apt/changelog" , 19104 "name" : "changelog" , 19108 "format" : "pve-node" , 19110 "description" : "The cluster node name." 19113 "description" : "Package name." , 19117 "description" : "Package version." , 19122 "additionalProperties" : 0 19124 "description" : "Get package changelogs." , 19128 "text" : "changelog" 19131 "text" : "versions" , 19134 "name" : "versions" , 19138 "format" : "pve-node" , 19140 "description" : "The cluster node name." 19143 "additionalProperties" : 0 19154 "proxyto" : "node" , 19155 "description" : "Get package information for important Proxmox packages." , 19166 "path" : "/nodes/{node}/apt/versions" , 19191 "additionalProperties" : 0 , 19194 "format" : "pve-node" , 19196 "description" : "The cluster node name." 19204 "description" : "Directory index for apt (Advanced Package Tool)." 19207 "path" : "/nodes/{node}/apt" , 19219 "method" : "DELETE" , 19222 "additionalProperties" : 0 , 19225 "description" : "The cluster node name." , 19227 "format" : "pve-node" 19231 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 19236 "type" : "integer" , 19238 "description" : "Update rule at position <pos>." , 19243 "name" : "delete_rule" , 19247 "proxyto" : "node" , 19248 "description" : "Delete rule." , 19260 "name" : "update_rule" , 19266 "description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." , 19267 "format" : "pve-fw-addr-spec" 19273 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 19276 "format" : "pve-fw-addr-spec" , 19279 "description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." 19286 "format" : "pve-node" , 19288 "description" : "The cluster node name." 19292 "description" : "Move rule to new position <moveto>. Other arguments are ignored." , 19299 "description" : "A list of settings you want to delete." , 19300 "format" : "pve-configid-list" 19312 "format" : "pve-fw-dport-spec" , 19313 "description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 19320 "description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 19321 "format" : "pve-fw-sport-spec" 19325 "format" : "pve-iface" , 19329 "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." 19332 "format" : "pve-fw-protocol-spec" , 19335 "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'." 19339 "type" : "integer" , 19341 "description" : "Update rule at position <pos>." 19350 "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name." , 19351 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 19358 "type" : "integer" , 19362 "additionalProperties" : 0 19375 "proxyto" : "node" , 19376 "description" : "Modify rule data." , 19394 "description" : "The cluster node name." , 19396 "format" : "pve-node" 19400 "description" : "Update rule at position <pos>." , 19401 "type" : "integer" , 19405 "additionalProperties" : 0 19416 "name" : "get_rule" , 19417 "proxyto" : "node" , 19418 "description" : "Get single rule data." 19421 "path" : "/nodes/{node}/firewall/rules/{pos}" , 19445 "description" : "List rules." , 19446 "proxyto" : "node" , 19457 "additionalProperties" : 0 , 19460 "description" : "The cluster node name." , 19462 "format" : "pve-node" 19466 "name" : "get_rules" 19470 "name" : "create_rule" , 19474 "format" : "pve-fw-dport-spec" , 19477 "description" : "Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." 19494 "pattern" : "[A-Za-z][A-Za-z0-9 \\ - \\ _]+" , 19495 "description" : "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name." , 19503 "description" : "Update rule at position <pos>." , 19504 "type" : "integer" , 19508 "description" : "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'." , 19511 "format" : "pve-fw-protocol-spec" 19520 "description" : "The cluster node name." , 19521 "format" : "pve-node" 19528 "format" : "pve-iface" , 19531 "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." , 19536 "format" : "pve-fw-sport-spec" , 19537 "description" : "Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with ' \\ d+: \\ d+', for example '80:85', and you can use comma separated list to match several ports or ranges." , 19542 "description" : "Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." , 19545 "format" : "pve-fw-addr-spec" 19548 "format" : "pve-fw-addr-spec" , 19549 "description" : "Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists." , 19557 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 19560 "additionalProperties" : 0 19575 "description" : "Create new rule." , 19579 "path" : "/nodes/{node}/firewall/rules" , 19584 "path" : "/nodes/{node}/firewall/options" , 19588 "name" : "set_options" , 19590 "additionalProperties" : 0 , 19595 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 19598 "nf_conntrack_max" : { 19600 "type" : "integer" , 19602 "description" : "Maximum number of tracked connections." 19606 "type" : "boolean" , 19607 "description" : "Enable NDP." 19609 "nf_conntrack_tcp_timeout_established" : { 19612 "type" : "integer" , 19613 "description" : "Conntrack established timeout." 19616 "description" : "Enable SMURFS filter." , 19617 "type" : "boolean" , 19620 "tcp_flags_log_level" : { 19634 "description" : "Log level for illegal tcp flags filter." 19650 "description" : "Log level for incoming traffic." 19652 "smurf_log_level" : { 19664 "description" : "Log level for SMURFS filter." , 19669 "description" : "A list of settings you want to delete." , 19672 "format" : "pve-configid-list" 19675 "format" : "pve-node" , 19677 "description" : "The cluster node name." 19681 "type" : "boolean" , 19682 "description" : "Filter illegal combinations of TCP flags." 19684 "log_level_out" : { 19696 "description" : "Log level for outgoing traffic." , 19701 "type" : "boolean" , 19703 "description" : "Enable host firewall rules." 19708 "proxyto" : "node" , 19709 "description" : "Set Firewall options." , 19724 "proxyto" : "node" , 19725 "description" : "Get host firewall options." , 19738 "description" : "The cluster node name." , 19740 "format" : "pve-node" 19743 "additionalProperties" : 0 19745 "name" : "get_options" , 19749 "nf_conntrack_tcp_timeout_established" : { 19750 "description" : "Conntrack established timeout." , 19751 "type" : "integer" , 19756 "description" : "Enable SMURFS filter." , 19757 "type" : "boolean" , 19760 "tcp_flags_log_level" : { 19763 "description" : "Log level for illegal tcp flags filter." , 19776 "nf_conntrack_max" : { 19777 "description" : "Maximum number of tracked connections." , 19778 "type" : "integer" , 19783 "type" : "boolean" , 19785 "description" : "Enable NDP." 19787 "smurf_log_level" : { 19799 "description" : "Log level for SMURFS filter." , 19806 "description" : "Log level for incoming traffic." , 19820 "description" : "Filter illegal combinations of TCP flags." , 19821 "type" : "boolean" , 19824 "log_level_out" : { 19825 "description" : "Log level for outgoing traffic." , 19841 "description" : "Enable host firewall rules." , 19854 "path" : "/nodes/{node}/firewall/log" , 19862 "type" : "integer" , 19867 "type" : "integer" , 19872 "format" : "pve-node" , 19873 "description" : "The cluster node name." , 19877 "additionalProperties" : 0 19880 "description" : "Read firewall log" , 19881 "proxyto" : "node" , 19896 "type" : "integer" , 19897 "description" : "Line number" 19901 "description" : "Line text" 19912 "text" : "firewall" , 19918 "description" : "The cluster node name." , 19920 "format" : "pve-node" 19923 "additionalProperties" : 0 19929 "description" : "Directory index." , 19946 "path" : "/nodes/{node}/firewall" , 19955 "format" : "pve-node" , 19956 "description" : "The cluster node name." , 19960 "additionalProperties" : 0 19962 "name" : "version" , 19966 "proxyto" : "node" , 19967 "description" : "API version details" , 19985 "text" : "version" , 19987 "path" : "/nodes/{node}/version" 19997 "description" : "Read node status" , 19998 "proxyto" : "node" , 20004 "description" : "The cluster node name." , 20005 "format" : "pve-node" 20008 "additionalProperties" : 0 20021 "name" : "node_cmd" , 20026 "description" : "The cluster node name." , 20027 "format" : "pve-node" 20030 "description" : "Specify the command." , 20038 "additionalProperties" : 0 20051 "proxyto" : "node" , 20052 "description" : "Reboot or shutdown a node." , 20060 "path" : "/nodes/{node}/status" 20064 "path" : "/nodes/{node}/netstat" , 20087 "description" : "The cluster node name." , 20089 "format" : "pve-node" 20092 "additionalProperties" : 0 20094 "name" : "netstat" , 20095 "proxyto" : "node" , 20096 "description" : "Read tap/vm network device interface counters" 20108 "proxyto" : "node" , 20109 "description" : "Execute multiple commands in order." , 20121 "name" : "execute" , 20123 "additionalProperties" : 0 , 20126 "description" : "JSON encoded array of commands." , 20130 "format" : "pve-node" , 20132 "description" : "The cluster node name." 20138 "text" : "execute" , 20140 "path" : "/nodes/{node}/execute" 20148 "additionalProperties" : 0 , 20152 "description" : "The list of datasources you want to display." , 20153 "format" : "pve-configid-list" 20156 "description" : "Specify the time frame you are interested in." , 20167 "description" : "The cluster node name." , 20169 "format" : "pve-node" 20178 "description" : "The RRD consolidation function" 20192 "description" : "Read node RRD statistics (returns PNG)" , 20204 "path" : "/nodes/{node}/rrd" , 20209 "path" : "/nodes/{node}/rrddata" , 20212 "name" : "rrddata" , 20227 "description" : "The RRD consolidation function" , 20234 "format" : "pve-node" , 20236 "description" : "The cluster node name." 20240 "description" : "Specify the time frame you are interested in." , 20250 "additionalProperties" : 0 20253 "description" : "Read node RRD statistics" , 20268 "path" : "/nodes/{node}/syslog" , 20271 "description" : "Read system log" , 20272 "proxyto" : "node" , 20287 "description" : "Line text" 20290 "description" : "Line number" , 20304 "pattern" : "^ \\ d{4}- \\ d{2}- \\ d{2}( \\ d{2}: \\ d{2}(: \\ d{2})?)?$" , 20305 "description" : "Display all log since this date-time string." 20309 "description" : "The cluster node name." , 20310 "format" : "pve-node" 20318 "description" : "Display all log until this date-time string." , 20319 "pattern" : "^ \\ d{4}- \\ d{2}- \\ d{2}( \\ d{2}: \\ d{2}(: \\ d{2})?)?$" , 20325 "type" : "integer" , 20329 "additionalProperties" : 0 20358 "additionalProperties" : 0 20362 "description" : "Restricted to users on realm 'pam'" , 20374 "description" : "Run 'apt-get dist-upgrade' instead of normal shell." , 20376 "type" : "boolean" , 20381 "description" : "The cluster node name." , 20382 "format" : "pve-node" 20386 "type" : "boolean" , 20387 "description" : "use websocket instead of standard vnc." 20390 "additionalProperties" : 0 20392 "name" : "vncshell" , 20394 "description" : "Creates a VNC Shell proxy." 20397 "text" : "vncshell" , 20399 "path" : "/nodes/{node}/vncshell" 20402 "text" : "vncwebsocket" , 20414 "description" : "Opens a weksocket for VNC traffic." , 20419 "description" : "Ticket from previous call to vncproxy." , 20423 "format" : "pve-node" , 20424 "description" : "The cluster node name." , 20429 "description" : "Port number returned by previous vncproxy call." , 20434 "additionalProperties" : 0 20436 "name" : "vncwebsocket" , 20438 "description" : "Restricted to users on realm 'pam'. You also need to pass a valid ticket (vncticket)." , 20449 "path" : "/nodes/{node}/vncwebsocket" , 20458 "additionalProperties" : 0 , 20461 "description" : "Run 'apt-get dist-upgrade' instead of normal shell." , 20463 "type" : "boolean" , 20467 "format" : "address" , 20470 "description" : "SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As resonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI)." 20473 "format" : "pve-node" , 20475 "description" : "The cluster node name." 20479 "name" : "spiceshell" , 20481 "description" : "Returned values can be directly passed to the 'remote-viewer' application." , 20482 "additionalProperties" : 1 , 20501 "proxyto" : "node" , 20502 "description" : "Creates a SPICE shell." , 20511 "description" : "Restricted to users on realm 'pam'" 20515 "text" : "spiceshell" , 20517 "path" : "/nodes/{node}/spiceshell" 20520 "path" : "/nodes/{node}/dns" , 20528 "additionalProperties" : 0 , 20531 "description" : "Search domain for host-name lookup." , 20538 "description" : "Third name server IP address." 20541 "description" : "Second name server IP address." , 20548 "description" : "First name server IP address." 20563 "additionalProperties" : 0 , 20566 "format" : "pve-node" , 20568 "description" : "The cluster node name." 20572 "description" : "Read DNS settings." , 20576 "name" : "update_dns" , 20578 "additionalProperties" : 0 , 20581 "description" : "Search domain for host-name lookup." , 20585 "description" : "Third name server IP address." , 20593 "description" : "Second name server IP address." , 20597 "format" : "pve-node" , 20599 "description" : "The cluster node name." 20602 "description" : "First name server IP address." , 20620 "description" : "Write DNS settings." , 20621 "proxyto" : "node" , 20635 "minimum" : 1297163644 , 20636 "type" : "integer" , 20637 "description" : "Seconds since 1970-01-01 00:00:00 (local time)" 20640 "minimum" : 1297163644 , 20641 "type" : "integer" , 20642 "description" : "Seconds since 1970-01-01 00:00:00 UTC." 20646 "description" : "Time zone" 20650 "additionalProperties" : 0 20652 "proxyto" : "node" , 20653 "description" : "Read server time and time zone settings." , 20657 "format" : "pve-node" , 20659 "description" : "The cluster node name." 20662 "additionalProperties" : 0 20679 "description" : "Set time zone." , 20680 "proxyto" : "node" , 20696 "description" : "Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names." 20699 "description" : "The cluster node name." , 20701 "format" : "pve-node" 20704 "additionalProperties" : 0 20706 "name" : "set_timezone" 20711 "path" : "/nodes/{node}/time" 20717 "name" : "apl_download" , 20719 "additionalProperties" : 0 , 20722 "description" : "Only list status for specified storage" , 20724 "format" : "pve-storage-id" 20727 "format" : "pve-node" , 20729 "description" : "The cluster node name." 20733 "description" : "The template wich will downloaded" , 20739 "proxyto" : "node" , 20740 "description" : "Download appliance templates." , 20744 "/storage/{storage}" , 20746 "Datastore.AllocateTemplate" 20763 "description" : "Get list of appliances." , 20764 "proxyto" : "node" , 20766 "additionalProperties" : 0 , 20769 "format" : "pve-node" , 20770 "description" : "The cluster node name." , 20775 "name" : "aplinfo" , 20781 "text" : "aplinfo" , 20783 "path" : "/nodes/{node}/aplinfo" 20791 "format" : "pve-node" , 20792 "description" : "The cluster node name." , 20796 "additionalProperties" : 0 20810 "description" : "Gather various systems information about a node" , 20811 "proxyto" : "node" , 20819 "path" : "/nodes/{node}/report" 20822 "text" : "startall" , 20831 "type" : "boolean" , 20832 "description" : "force if onboot=0." 20836 "description" : "The cluster node name." , 20837 "format" : "pve-node" 20840 "additionalProperties" : 0 20842 "name" : "startall" , 20846 "proxyto" : "node" , 20847 "description" : "Start all VMs and containers (when onboot=1)." , 20859 "path" : "/nodes/{node}/startall" , 20863 "text" : "stopall" , 20866 "description" : "Stop all VMs and Containers." , 20867 "proxyto" : "node" , 20884 "format" : "pve-node" , 20886 "description" : "The cluster node name." 20889 "additionalProperties" : 0 20891 "name" : "stopall" , 20895 "path" : "/nodes/{node}/stopall" , 20913 "proxyto" : "node" , 20914 "description" : "Migrate all VMs and Containers." , 20920 "type" : "integer" , 20921 "description" : "Maximal number of parallel migration job. If not set use 'max_workers' from datacenter.cfg, one of both must be set!" , 20925 "description" : "The cluster node name." , 20927 "format" : "pve-node" 20930 "description" : "Target node." , 20932 "format" : "pve-node" 20935 "additionalProperties" : 0 20937 "name" : "migrateall" , 20941 "text" : "migrateall" , 20943 "path" : "/nodes/{node}/migrateall" 20948 "path" : "/nodes/{node}" 20957 "additionalProperties" : 0 20960 "description" : "Cluster node index." , 20985 "description" : "Create a new storage." , 20989 "additionalProperties" : 0 , 20993 "description" : "Glusterfs Volume." , 20998 "description" : "use sparse volumes" , 20999 "type" : "boolean" , 21003 "description" : "Storage type." , 21020 "iscsiprovider" : { 21021 "description" : "iscsi provider" , 21027 "type" : "boolean" , 21028 "description" : "Zero-out data when removing LVs." 21032 "description" : "The storage identifier." , 21033 "format" : "pve-storage-id" 21038 "type" : "integer" , 21041 "description" : "The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster." 21046 "description" : "Pool." 21049 "description" : "File system path." , 21052 "format" : "pve-storage-path" 21057 "description" : "Server IP or DNS name." , 21058 "format" : "pve-storage-server" 21063 "description" : "target group for comstar views" 21065 "saferemove_throughput" : { 21068 "description" : "Wipe throughput (cstream -t parameter value)." 21071 "type" : "integer" , 21073 "description" : "Maximal number of backup files per VM. Use '0' for unlimted." , 21079 "description" : "NFS mount options (see 'man nfs')" , 21080 "format" : "pve-storage-options" 21085 "description" : "host group for comstar views" 21088 "description" : "RBD Id." , 21092 "authsupported" : { 21095 "description" : "Authsupported." 21098 "description" : "Backup volfile server IP or DNS name." , 21099 "requires" : "server" , 21102 "format" : "pve-storage-server" 21105 "format" : "pve-storage-content-list" , 21108 "description" : "Allowed content types. \n\n NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. \n " 21111 "description" : "Base volume. This volume is automatically activated." , 21114 "format" : "pve-volume-id" 21117 "description" : "Monitors daemon ips." , 21124 "description" : "Default image format." , 21125 "format" : "pve-storage-format" 21128 "type" : "boolean" , 21130 "description" : "disable write caching on the target" 21133 "description" : "iSCSI target." , 21140 "description" : "LVM thin pool LV name." , 21141 "format" : "pve-storage-vgname" 21144 "type" : "boolean" , 21146 "description" : "Access rbd through krbd kernel module." 21149 "description" : "Mark storage as shared." , 21159 "description" : "Gluster transport: tcp or rdma" , 21164 "description" : "Volume group name." , 21167 "format" : "pve-storage-vgname" 21172 "description" : "block size" 21177 "description" : "NFS export path." , 21178 "format" : "pve-storage-path" 21183 "description" : "iSCSI portal (IP or DNS name with optional port)." , 21184 "format" : "pve-storage-portal-dns" 21187 "format" : "pve-node-list" , 21188 "description" : "List of cluster node names." , 21193 "type" : "boolean" , 21195 "description" : "Flag to disable the storage." 21204 "Datastore.Allocate" 21223 "href" : "{storage}" 21233 "description" : "Only list storage of specific type" , 21250 "additionalProperties" : 0 21253 "description" : "Only list entries where you have 'Datastore.Audit' or 'Datastore.AllocateSpace' permissions on '/storage/<storage>'" , 21257 "description" : "Storage index." 21260 "text" : "storage" , 21264 "path" : "/storage/{storage}" , 21271 "/storage/{storage}" , 21273 "Datastore.Allocate" 21278 "additionalProperties" : 0 , 21281 "format" : "pve-storage-id" , 21282 "description" : "The storage identifier." , 21287 "description" : "Read storage configuration." , 21295 "method" : "DELETE" , 21301 "Datastore.Allocate" 21306 "additionalProperties" : 0 , 21309 "format" : "pve-storage-id" , 21311 "description" : "The storage identifier." 21317 "description" : "Delete storage configuration." 21325 "additionalProperties" : 0 , 21329 "maxLength" : 4096 , 21330 "format" : "pve-configid-list" , 21333 "description" : "A list of settings you want to delete." 21343 "description" : "Gluster transport: tcp or rdma" 21346 "description" : "Mark storage as shared." , 21347 "type" : "boolean" , 21352 "type" : "boolean" , 21353 "description" : "Access rbd through krbd kernel module." 21356 "description" : "Pool." , 21361 "description" : "The redundancy count specifies the number of nodes to which the resource should be deployed. It must be at least 1 and at most the number of nodes in the cluster." , 21362 "type" : "integer" , 21369 "description" : "Server IP or DNS name." , 21372 "format" : "pve-storage-server" 21375 "type" : "boolean" , 21377 "description" : "Zero-out data when removing LVs." 21383 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." 21386 "format" : "pve-storage-id" , 21387 "description" : "The storage identifier." , 21391 "description" : "use sparse volumes" , 21392 "type" : "boolean" , 21396 "description" : "disable write caching on the target" , 21397 "type" : "boolean" , 21401 "description" : "Default image format." , 21404 "format" : "pve-storage-format" 21407 "format" : "pve-storage-content-list" , 21408 "description" : "Allowed content types. \n\n NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. \n " , 21413 "format" : "pve-storage-server" , 21416 "description" : "Backup volfile server IP or DNS name." , 21417 "requires" : "server" 21420 "description" : "Flag to disable the storage." , 21421 "type" : "boolean" , 21425 "format" : "pve-node-list" , 21428 "description" : "List of cluster node names." 21433 "description" : "host group for comstar views" 21436 "format" : "pve-storage-options" , 21437 "description" : "NFS mount options (see 'man nfs')" , 21441 "saferemove_throughput" : { 21444 "description" : "Wipe throughput (cstream -t parameter value)." 21448 "type" : "integer" , 21450 "description" : "Maximal number of backup files per VM. Use '0' for unlimted." 21455 "description" : "block size" 21458 "description" : "RBD Id." , 21463 "description" : "target group for comstar views" , 21474 "Datastore.Allocate" 21479 "description" : "Update storage configuration." , 21483 "text" : "{storage}" 21487 "path" : "/storage" 21491 "path" : "/access" , 21499 "href" : "{subdir}" , 21517 "additionalProperties" : 0 21519 "description" : "Directory index." 21532 "description" : "Create new user." , 21533 "name" : "create_user" , 21539 "Realm.AllocateUser" 21550 "description" : "You need 'Realm.AllocateUser' on '/access/realm/<realm>' on the realm of user <userid>, and 'User.Modify' permissions to '/access/groups/<group>' for any group specified (or 'User.Modify' on '/access/groups' if you pass no groups." 21555 "type" : "boolean" , 21558 "description" : "Enable the account (default). You can set this to '0' to disable the accout" 21567 "description" : "Keys for two factor auth (yubico)." 21576 "format" : "pve-groupid-list" 21581 "description" : "Initial password." , 21586 "format" : "email-opt" , 21596 "description" : "User ID" , 21597 "format" : "pve-userid" , 21602 "description" : "Account expiration date (seconds since epoch). '0' means no expiration date." , 21603 "type" : "integer" , 21607 "additionalProperties" : 0 21622 "href" : "{userid}" , 21631 "additionalProperties" : 0 , 21634 "description" : "Optional filter for enable property." , 21635 "type" : "boolean" , 21641 "description" : "The returned list is restricted to users where you have 'User.Modify' or 'Sys.Audit' permissions on '/access/groups' or on a group the user belongs too. But it always includes the current (authenticated) user." , 21644 "description" : "User index." 21651 "path" : "/access/users/{userid}" , 21655 "description" : "Update user configuration." , 21656 "name" : "update_user" , 21658 "additionalProperties" : 0 , 21662 "type" : "integer" , 21664 "description" : "Account expiration date (seconds since epoch). '0' means no expiration date." 21671 "format" : "email-opt" , 21676 "description" : "User ID" , 21678 "format" : "pve-userid" , 21682 "description" : "Keys for two factor auth (yubico)." , 21687 "format" : "pve-groupid-list" , 21696 "type" : "boolean" , 21698 "description" : "Enable/disable the account." 21702 "type" : "boolean" , 21703 "requires" : "groups" 21728 "description" : "Delete user." , 21730 "additionalProperties" : 0 , 21734 "format" : "pve-userid" , 21736 "description" : "User ID" 21745 "Realm.AllocateUser" 21755 "name" : "delete_user" , 21756 "method" : "DELETE" , 21764 "additionalProperties" : 0 , 21785 "type" : "integer" , 21801 "description" : "User ID" , 21803 "format" : "pve-userid" , 21807 "additionalProperties" : 0 21809 "name" : "read_user" , 21819 "description" : "Get user configuration." 21822 "text" : "{userid}" 21826 "path" : "/access/users" 21834 "description" : "The returned list is restricted to groups where you have 'User.Modify', 'Sys.Audit' or 'Group.Allocate' permissions on /access/groups/<group>." 21837 "additionalProperties" : 0 21839 "description" : "Group index." , 21844 "href" : "{groupid}" , 21864 "name" : "create_group" , 21875 "additionalProperties" : 0 , 21878 "format" : "pve-groupid" , 21887 "description" : "Create new group." , 21904 "name" : "delete_group" , 21909 "format" : "pve-groupid" 21912 "additionalProperties" : 0 21915 "description" : "Delete group." , 21919 "method" : "DELETE" 21926 "description" : "Update group data." , 21937 "name" : "update_group" , 21939 "additionalProperties" : 0 , 21943 "format" : "pve-groupid" 21967 "additionalProperties" : 0 21970 "name" : "read_group" , 21974 "format" : "pve-groupid" , 21978 "additionalProperties" : 0 21992 "description" : "Get group configuration." 21995 "text" : "{groupid}" , 21997 "path" : "/access/groups/{groupid}" 22002 "path" : "/access/groups" 22007 "text" : "{roleid}" , 22012 "name" : "read_role" , 22016 "format" : "pve-roleid" , 22020 "additionalProperties" : 0 22025 "description" : "Get role configuration." 22028 "method" : "DELETE" , 22032 "description" : "Delete role." , 22034 "name" : "delete_role" , 22036 "additionalProperties" : 0 , 22039 "format" : "pve-roleid" , 22065 "additionalProperties" : 0 , 22068 "requires" : "privs" , 22069 "type" : "boolean" , 22073 "format" : "pve-roleid" , 22077 "format" : "pve-priv-list" , 22082 "name" : "update_role" , 22083 "description" : "Create new role." , 22091 "path" : "/access/roles/{roleid}" , 22098 "description" : "Role index." , 22101 "additionalProperties" : 0 22110 "href" : "{roleid}" , 22126 "description" : "Create new role." , 22138 "additionalProperties" : 0 , 22142 "format" : "pve-roleid" 22145 "format" : "pve-priv-list" , 22151 "name" : "create_role" , 22158 "path" : "/access/roles" , 22166 "description" : "The returned list is restricted to objects where you have rights to modify permissions." 22169 "additionalProperties" : 0 22171 "name" : "read_acl" , 22172 "description" : "Get Access Control List (ACLs)." , 22197 "additionalProperties" : 0 22204 "name" : "update_acl" , 22206 "additionalProperties" : 0 , 22209 "type" : "boolean" , 22211 "description" : "Remove permissions (instead of adding it)." 22214 "format" : "pve-userid-list" , 22217 "description" : "List of users." 22220 "description" : "Access control path" , 22224 "description" : "List of roles." , 22226 "format" : "pve-roleid-list" 22229 "description" : "Allow to propagate (inherit) permissions." , 22230 "type" : "boolean" , 22235 "description" : "List of groups." , 22238 "format" : "pve-groupid-list" 22248 "description" : "Update Access Control List (add or remove permissions)." , 22258 "path" : "/access/acl" 22261 "text" : "domains" , 22264 "path" : "/access/domains/{realm}" , 22266 "text" : "{realm}" , 22275 "description" : "LDAP base domain name" , 22276 "pattern" : " \\ w+=[^,]+(, \\ s* \\ w+=[^,]+)*" 22279 "description" : "Authentication domain ID" , 22281 "format" : "pve-realm" , 22286 "pattern" : " \\ S{2,}" , 22287 "description" : "LDAP user attribute name" , 22292 "type" : "boolean" , 22294 "description" : "Use secure LDAPS protocol." 22297 "format" : "address" , 22301 "description" : "Server IP address (or DNS name)" 22305 "description" : "AD domain name" , 22306 "pattern" : " \\ S+" , 22312 "format" : "address" , 22315 "description" : "Fallback Server IP address (or DNS name)" 22320 "description" : "A list of settings you want to delete." , 22321 "maxLength" : 4096 , 22322 "format" : "pve-configid-list" 22325 "maxLength" : 4096 , 22328 "description" : "Description." 22331 "description" : "Use this as default realm" , 22332 "type" : "boolean" , 22336 "description" : "Server port." , 22338 "type" : "integer" , 22345 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications." , 22351 "description" : "Use Two-factor authentication." , 22353 "format" : "pve-tfa-config" 22357 "additionalProperties" : 0 22370 "description" : "Update authentication server settings." , 22377 "method" : "DELETE" , 22382 "description" : "Delete an authentication server." , 22386 "format" : "pve-realm" , 22389 "description" : "Authentication domain ID" 22392 "additionalProperties" : 0 22410 "description" : "Authentication domain ID" , 22411 "format" : "pve-realm" , 22415 "additionalProperties" : 0 22430 "description" : "Get auth server configuration." , 22457 "description" : "Two-factor authentication provider." , 22471 "additionalProperties" : 0 22476 "description" : "Anyone can access that, because we need that list for the login box (before the user is authenticated)." 22478 "description" : "Authentication domain index." 22485 "description" : "Add an authentication server." , 22493 "description" : "Server IP address (or DNS name)" , 22495 "format" : "address" 22498 "description" : "Use secure LDAPS protocol." , 22499 "type" : "boolean" , 22503 "description" : "Realm type." , 22513 "pattern" : " \\ S{2,}" , 22514 "description" : "LDAP user attribute name" , 22520 "format" : "pve-realm" , 22523 "description" : "Authentication domain ID" 22526 "pattern" : " \\ w+=[^,]+(, \\ s* \\ w+=[^,]+)*" , 22527 "description" : "LDAP base domain name" , 22533 "description" : "Use Two-factor authentication." , 22537 "format" : "pve-tfa-config" 22542 "type" : "integer" , 22544 "description" : "Server port." 22548 "type" : "boolean" , 22549 "description" : "Use this as default realm" 22552 "maxLength" : 4096 , 22553 "description" : "Description." , 22561 "pattern" : " \\ S+" , 22562 "description" : "AD domain name" 22566 "format" : "address" , 22569 "description" : "Fallback Server IP address (or DNS name)" 22572 "additionalProperties" : 0 , 22586 "path" : "/access/domains" , 22596 "CSRFPreventionToken" : { 22612 "description" : "The secret password. This can also be a valid ticket." , 22617 "format" : "pve-priv-list" , 22620 "requires" : "path" , 22621 "description" : "Verify ticket, and check if user have access 'privs' on 'path'" 22626 "description" : "One-time password for Two-factor authentication." 22629 "requires" : "privs" , 22630 "description" : "Verify ticket, and check if user have access 'privs' on 'path'" , 22636 "description" : "You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>." , 22640 "format" : "pve-realm" 22643 "description" : "User name" , 22648 "additionalProperties" : 0 22650 "name" : "create_ticket" , 22653 "description" : "You need to pass valid credientials." 22655 "description" : "Create or verify authentication ticket." , 22660 "additionalProperties" : 0 22665 "name" : "get_ticket" , 22666 "description" : "Dummy. Useful for formaters which want to priovde a login page." , 22675 "path" : "/access/ticket" 22685 "description" : "Each user is allowed to change his own password. A user can change the password of another user if he has 'Realm.AllocateUser' (on the realm of user <userid>) and 'User.Modify' permission on /access/groups/<group> on a group where user <userid> is member of." , 22696 "Realm.AllocateUser" 22712 "description" : "The new password." , 22716 "format" : "pve-userid" , 22718 "description" : "User ID" , 22722 "additionalProperties" : 0 22724 "name" : "change_passsword" , 22725 "description" : "Change user password." , 22729 "text" : "password" , 22731 "path" : "/access/password" 22738 "description" : "Pool index." , 22741 "additionalProperties" : 0 22745 "description" : "List all pools where you have Pool.Allocate or VM.Allocate permissions on /pool/<pool>." 22752 "href" : "{poolid}" 22767 "name" : "create_pool" , 22778 "additionalProperties" : 0 , 22781 "format" : "pve-poolid" , 22791 "description" : "Create new pool." , 22801 "path" : "/pools/{poolid}" , 22809 "additionalProperties" : 0 , 22814 "description" : "List of storage IDs." , 22815 "format" : "pve-storage-id-list" 22818 "format" : "pve-vmid-list" , 22821 "description" : "List of virtual machines." 22824 "description" : "Remove vms/storage (instead of adding it)." , 22829 "format" : "pve-poolid" , 22846 "description" : "You also need the right to modify permissions on any object you add/delete." 22848 "name" : "update_pool" , 22849 "description" : "Update pool data." , 22856 "method" : "DELETE" , 22857 "description" : "Delete pool." , 22860 "additionalProperties" : 0 , 22863 "format" : "pve-poolid" , 22868 "name" : "delete_pool" , 22870 "description" : "You can only delete empty pools (no members)." , 22881 "description" : "Get pool configuration." , 22882 "name" : "read_pool" , 22887 "format" : "pve-poolid" 22890 "additionalProperties" : 0 22907 "additionalProperties" : 1 , 22941 "additionalProperties" : 0 , 22946 "text" : "{poolid}" 22955 "path" : "/version" , 22973 "description" : "API version details. The result also includes the global datacenter confguration." , 22978 "additionalProperties" : 0
projects / pve-docs.git / blob