Browse Source

run make update

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
stable-5
Thomas Lamprecht 7 months ago
parent
commit
95895385d2

+ 836
- 58
api-viewer/apidata.js View File

@@ -821,6 +821,22 @@ var pveapi = [
"optional" : 1,
"type" : "integer"
},
"log" : {
"description" : "Log level for firewall rule",
"enum" : [
"emerg",
"alert",
"crit",
"err",
"warning",
"notice",
"info",
"debug",
"nolog"
],
"optional" : 1,
"type" : "string"
},
"macro" : {
"optional" : 1,
"type" : "string"
@@ -919,6 +935,22 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"log" : {
"description" : "Log level for firewall rule.",
"enum" : [
"emerg",
"alert",
"crit",
"err",
"warning",
"notice",
"info",
"debug",
"nolog"
],
"optional" : 1,
"type" : "string"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
@@ -1134,6 +1166,22 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"log" : {
"description" : "Log level for firewall rule.",
"enum" : [
"emerg",
"alert",
"crit",
"err",
"warning",
"notice",
"info",
"debug",
"nolog"
],
"optional" : 1,
"type" : "string"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
@@ -1397,6 +1445,22 @@ var pveapi = [
"optional" : 1,
"type" : "integer"
},
"log" : {
"description" : "Log level for firewall rule",
"enum" : [
"emerg",
"alert",
"crit",
"err",
"warning",
"notice",
"info",
"debug",
"nolog"
],
"optional" : 1,
"type" : "string"
},
"macro" : {
"optional" : 1,
"type" : "string"
@@ -1488,6 +1552,22 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"log" : {
"description" : "Log level for firewall rule.",
"enum" : [
"emerg",
"alert",
"crit",
"err",
"warning",
"notice",
"info",
"debug",
"nolog"
],
"optional" : 1,
"type" : "string"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
@@ -1657,6 +1737,22 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"log" : {
"description" : "Log level for firewall rule.",
"enum" : [
"emerg",
"alert",
"crit",
"err",
"warning",
"notice",
"info",
"debug",
"nolog"
],
"optional" : 1,
"type" : "string"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
@@ -2370,6 +2466,34 @@ var pveapi = [
"optional" : 1,
"type" : "integer"
},
"log_ratelimit" : {
"description" : "Log ratelimiting settings",
"format" : {
"burst" : {
"default" : 5,
"description" : "Inital burst of packages which will get logged",
"minimum" : 0,
"optional" : 1,
"type" : "integer"
},
"enable" : {
"default" : "1",
"default_key" : 1,
"description" : "Enable or disable log rate limiting",
"type" : "boolean"
},
"rate" : {
"default" : "1/second",
"description" : "Frequency with which the burst bucket gets refilled",
"format_description" : "rate",
"optional" : 1,
"pattern" : "[1-9][0-9]*\\/(second|minute|hour|day)",
"type" : "string"
}
},
"optional" : 1,
"type" : "string"
},
"policy_in" : {
"description" : "Input policy.",
"enum" : [
@@ -2429,6 +2553,35 @@ var pveapi = [
"type" : "integer",
"typetext" : "<integer> (0 - N)"
},
"log_ratelimit" : {
"description" : "Log ratelimiting settings",
"format" : {
"burst" : {
"default" : 5,
"description" : "Inital burst of packages which will get logged",
"minimum" : 0,
"optional" : 1,
"type" : "integer"
},
"enable" : {
"default" : "1",
"default_key" : 1,
"description" : "Enable or disable log rate limiting",
"type" : "boolean"
},
"rate" : {
"default" : "1/second",
"description" : "Frequency with which the burst bucket gets refilled",
"format_description" : "rate",
"optional" : 1,
"pattern" : "[1-9][0-9]*\\/(second|minute|hour|day)",
"type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "[enable=]<1|0> [,burst=<integer>] [,rate=<rate>]"
},
"policy_in" : {
"description" : "Input policy.",
"enum" : [
@@ -3187,7 +3340,7 @@ var pveapi = [
"additionalProperties" : 0,
"properties" : {
"node" : {
"description" : "The cluster node name.",
"description" : "Target node.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
@@ -3229,7 +3382,7 @@ var pveapi = [
"additionalProperties" : 0,
"properties" : {
"node" : {
"description" : "The cluster node name.",
"description" : "Target node.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
@@ -4475,35 +4628,35 @@ var pveapi = [
"description" : "Set bandwidth/io limits various operations.",
"format" : {
"clone" : {
"description" : "bandwidth limit in MiB/s for cloning disks",
"description" : "bandwidth limit in KiB/s for cloning disks",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"default" : {
"description" : "default bandwidth limit in MiB/s",
"description" : "default bandwidth limit in KiB/s",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"migration" : {
"description" : "bandwidth limit in MiB/s for migrating guests",
"description" : "bandwidth limit in KiB/s for migrating guests (including moving local disks)",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"move" : {
"description" : "bandwidth limit in MiB/s for moving disks",
"description" : "bandwidth limit in KiB/s for moving disks",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"restore" : {
"description" : "bandwidth limit in MiB/s for restoring guests from backups",
"description" : "bandwidth limit in KiB/s for restoring guests from backups",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
@@ -4635,9 +4788,10 @@ var pveapi = [
},
"mac_prefix" : {
"description" : "Prefix for autogenerated MAC addresses.",
"format" : "mac-prefix",
"optional" : 1,
"pattern" : "(?^i:[a-f0-9]{2}(?::[a-f0-9]{2}){0,2}:?)",
"type" : "string"
"type" : "string",
"typetext" : "<string>"
},
"max_workers" : {
"description" : "Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.",
@@ -4676,6 +4830,26 @@ var pveapi = [
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"u2f" : {
"description" : "u2f",
"format" : {
"appid" : {
"description" : "U2F AppId URL override. Defaults to the origin.",
"format_description" : "APPID",
"optional" : 1,
"type" : "string"
},
"origin" : {
"description" : "U2F Origin override. Mostly useful for single nodes with a single URL.",
"format_description" : "URL",
"optional" : 1,
"type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "[appid=<APPID>] [,origin=<URL>]"
}
}
},
@@ -4930,6 +5104,22 @@ var pveapi = [
"optional" : 1,
"type" : "integer"
},
"log" : {
"description" : "Log level for firewall rule",
"enum" : [
"emerg",
"alert",
"crit",
"err",
"warning",
"notice",
"info",
"debug",
"nolog"
],
"optional" : 1,
"type" : "string"
},
"macro" : {
"optional" : 1,
"type" : "string"
@@ -5021,6 +5211,22 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"log" : {
"description" : "Log level for firewall rule.",
"enum" : [
"emerg",
"alert",
"crit",
"err",
"warning",
"notice",
"info",
"debug",
"nolog"
],
"optional" : 1,
"type" : "string"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
@@ -5218,6 +5424,22 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"log" : {
"description" : "Log level for firewall rule.",
"enum" : [
"emerg",
"alert",
"crit",
"err",
"warning",
"notice",
"info",
"debug",
"nolog"
],
"optional" : 1,
"type" : "string"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
@@ -8147,6 +8369,12 @@ var pveapi = [
"type" : "string",
"typetext" : "<volume>"
},
"cicustom" : {
"description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.",
"format" : "pve-qm-cicustom",
"optional" : 1,
"type" : "string"
},
"cipassword" : {
"description" : "cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.",
"optional" : 1,
@@ -8663,6 +8891,13 @@ var pveapi = [
],
"optional" : 1,
"type" : "string"
},
"wwn" : {
"description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
"format_description" : "wwn",
"optional" : 1,
"pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
"type" : "string"
}
},
"optional" : 1,
@@ -8674,6 +8909,25 @@ var pveapi = [
"optional" : 1,
"type" : "string"
},
"ivshmem" : {
"description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.",
"format" : {
"name" : {
"description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.",
"format_description" : "string",
"optional" : 1,
"pattern" : "[a-zA-Z0-9\\-]+",
"type" : "string"
},
"size" : {
"description" : "The size of the file in MB.",
"minimum" : 1,
"type" : "integer"
}
},
"optional" : 1,
"type" : "string"
},
"keyboard" : {
"default" : null,
"description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.",
@@ -8727,7 +8981,9 @@ var pveapi = [
"migrate",
"rollback",
"snapshot",
"snapshot-delete"
"snapshot-delete",
"suspending",
"suspended"
],
"optional" : 1,
"type" : "string"
@@ -8821,10 +9077,11 @@ var pveapi = [
},
"macaddr" : {
"description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
"format" : "mac-addr",
"format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1,
"pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
"type" : "string"
"type" : "string",
"verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
},
"model" : {
"default_key" : 1,
@@ -9291,6 +9548,13 @@ var pveapi = [
],
"optional" : 1,
"type" : "string"
},
"wwn" : {
"description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
"format_description" : "wwn",
"optional" : 1,
"pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
"type" : "string"
}
},
"optional" : 1,
@@ -9617,6 +9881,13 @@ var pveapi = [
],
"optional" : 1,
"type" : "string"
},
"wwn" : {
"description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
"format_description" : "wwn",
"optional" : 1,
"pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
"type" : "string"
}
},
"optional" : 1,
@@ -10225,6 +10496,13 @@ var pveapi = [
"type" : "string",
"typetext" : "<volume>"
},
"cicustom" : {
"description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.",
"format" : "pve-qm-cicustom",
"optional" : 1,
"type" : "string",
"typetext" : "[meta=<volume>] [,network=<volume>] [,user=<volume>]"
},
"cipassword" : {
"description" : "cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.",
"optional" : 1,
@@ -10770,11 +11048,18 @@ var pveapi = [
],
"optional" : 1,
"type" : "string"
},
"wwn" : {
"description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
"format_description" : "wwn",
"optional" : 1,
"pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
"type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"ipconfig[n]" : {
"description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.\n",
@@ -10783,6 +11068,26 @@ var pveapi = [
"type" : "string",
"typetext" : "[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]"
},
"ivshmem" : {
"description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.",
"format" : {
"name" : {
"description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.",
"format_description" : "string",
"optional" : 1,
"pattern" : "[a-zA-Z0-9\\-]+",
"type" : "string"
},
"size" : {
"description" : "The size of the file in MB.",
"minimum" : 1,
"type" : "integer"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "size=<integer> [,name=<string>]"
},
"keyboard" : {
"default" : null,
"description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.",
@@ -10838,7 +11143,9 @@ var pveapi = [
"migrate",
"rollback",
"snapshot",
"snapshot-delete"
"snapshot-delete",
"suspending",
"suspended"
],
"optional" : 1,
"type" : "string"
@@ -10937,10 +11244,11 @@ var pveapi = [
},
"macaddr" : {
"description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
"format" : "mac-addr",
"format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1,
"pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
"type" : "string"
"type" : "string",
"verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
},
"model" : {
"default_key" : 1,
@@ -11426,11 +11734,18 @@ var pveapi = [
],
"optional" : 1,
"type" : "string"
},
"wwn" : {
"description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
"format_description" : "wwn",
"optional" : 1,
"pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
"type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"scsi[n]" : {
"description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
@@ -11753,11 +12068,18 @@ var pveapi = [
],
"optional" : 1,
"type" : "string"
},
"wwn" : {
"description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
"format_description" : "wwn",
"optional" : 1,
"pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
"type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"scsihw" : {
"default" : "lsi",
@@ -12405,6 +12727,13 @@ var pveapi = [
"type" : "string",
"typetext" : "<volume>"
},
"cicustom" : {
"description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.",
"format" : "pve-qm-cicustom",
"optional" : 1,
"type" : "string",
"typetext" : "[meta=<volume>] [,network=<volume>] [,user=<volume>]"
},
"cipassword" : {
"description" : "cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.",
"optional" : 1,
@@ -12950,11 +13279,18 @@ var pveapi = [
],
"optional" : 1,
"type" : "string"
},
"wwn" : {
"description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
"format_description" : "wwn",
"optional" : 1,
"pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
"type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"ipconfig[n]" : {
"description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.\n",
@@ -12963,6 +13299,26 @@ var pveapi = [
"type" : "string",
"typetext" : "[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]"
},
"ivshmem" : {
"description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.",
"format" : {
"name" : {
"description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.",
"format_description" : "string",
"optional" : 1,
"pattern" : "[a-zA-Z0-9\\-]+",
"type" : "string"
},
"size" : {
"description" : "The size of the file in MB.",
"minimum" : 1,
"type" : "integer"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "size=<integer> [,name=<string>]"
},
"keyboard" : {
"default" : null,
"description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.",
@@ -13018,7 +13374,9 @@ var pveapi = [
"migrate",
"rollback",
"snapshot",
"snapshot-delete"
"snapshot-delete",
"suspending",
"suspended"
],
"optional" : 1,
"type" : "string"
@@ -13117,10 +13475,11 @@ var pveapi = [
},
"macaddr" : {
"description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
"format" : "mac-addr",
"format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1,
"pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
"type" : "string"
"type" : "string",
"verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
},
"model" : {
"default_key" : 1,
@@ -13606,11 +13965,18 @@ var pveapi = [
],
"optional" : 1,
"type" : "string"
},
"wwn" : {
"description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
"format_description" : "wwn",
"optional" : 1,
"pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
"type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"scsi[n]" : {
"description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
@@ -13933,11 +14299,18 @@ var pveapi = [
],
"optional" : 1,
"type" : "string"
},
"wwn" : {
"description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
"format_description" : "wwn",
"optional" : 1,
"pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
"type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"scsihw" : {
"default" : "lsi",
@@ -14936,6 +15309,11 @@ var pveapi = [
"description" : "HA manager service status.",
"type" : "object"
},
"lock" : {
"description" : "The current config lock, if any.",
"optional" : 1,
"type" : "string"
},
"maxdisk" : {
"description" : "Root disk size in bytes.",
"optional" : 1,
@@ -15303,6 +15681,21 @@ var pveapi = [
"type" : "boolean",
"typetext" : "<boolean>"
},
"statestorage" : {
"description" : "The storage for the VM state",
"format" : "pve-storage-id",
"optional" : 1,
"requires" : "todisk",
"type" : "string",
"typetext" : "<string>"
},
"todisk" : {
"default" : 0,
"description" : "If set, suspends the VM to disk. Will be resumed on next VM start.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
@@ -15574,6 +15967,14 @@ var pveapi = [
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"bwlimit" : {
"default" : "clone limit from datacenter or storage config",
"description" : "Override I/O bandwidth limit (in KiB/s).",
"minimum" : "0",
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (0 - N)"
},
"description" : {
"description" : "Description for the new VM.",
"optional" : 1,
@@ -15706,6 +16107,14 @@ var pveapi = [
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"bwlimit" : {
"default" : "move limit from datacenter or storage config",
"description" : "Override I/O bandwidth limit (in KiB/s).",
"minimum" : "0",
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (0 - N)"
},
"delete" : {
"default" : 0,
"description" : "Delete the original disk after successful copy. By default the original disk is kept as unused disk.",
@@ -15839,6 +16248,14 @@ var pveapi = [
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"bwlimit" : {
"default" : "migrate limit from datacenter or storage config",
"description" : "Override I/O bandwidth limit (in KiB/s).",
"minimum" : "0",
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (0 - N)"
},
"force" : {
"description" : "Allow to migrate VMs which use local devices. Only root may use this option.",
"optional" : 1,
@@ -16707,6 +17124,11 @@ var pveapi = [
"optional" : 1,
"type" : "number"
},
"lock" : {
"description" : "The current config lock, if any.",
"optional" : 1,
"type" : "string"
},
"maxdisk" : {
"description" : "Root disk size in bytes.",
"optional" : 1,
@@ -16862,7 +17284,8 @@ var pveapi = [
"type" : "string"
},
"bwlimit" : {
"description" : "Override i/o bandwidth limit (in KiB/s).",
"default" : "restore limit from datacenter or storage config",
"description" : "Override I/O bandwidth limit (in KiB/s).",
"minimum" : "0",
"optional" : 1,
"type" : "integer",
@@ -16875,6 +17298,13 @@ var pveapi = [
"type" : "string",
"typetext" : "<volume>"
},
"cicustom" : {
"description" : "cloud-init: Specify custom files to replace the automatically generated ones at start.",
"format" : "pve-qm-cicustom",
"optional" : 1,
"type" : "string",
"typetext" : "[meta=<volume>] [,network=<volume>] [,user=<volume>]"
},
"cipassword" : {
"description" : "cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.",
"optional" : 1,
@@ -17406,11 +17836,18 @@ var pveapi = [
],
"optional" : 1,
"type" : "string"
},
"wwn" : {
"description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
"format_description" : "wwn",
"optional" : 1,
"pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
"type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,model=<model>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"ipconfig[n]" : {
"description" : "cloud-init: Specify IP addresses and gateways for the corresponding interface.\n\nIP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.\n\nThe special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.\nFor IPv6 the special string 'auto' can be used to use stateless autoconfiguration.\n\nIf cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.\n",
@@ -17419,6 +17856,26 @@ var pveapi = [
"type" : "string",
"typetext" : "[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]"
},
"ivshmem" : {
"description" : "Inter-VM shared memory. Useful for direct communication between VMs, or to the host.",
"format" : {
"name" : {
"description" : "The name of the file. Will be prefixed with 'pve-shm-'. Default is the VMID. Will be deleted when the VM is stopped.",
"format_description" : "string",
"optional" : 1,
"pattern" : "[a-zA-Z0-9\\-]+",
"type" : "string"
},
"size" : {
"description" : "The size of the file in MB.",
"minimum" : 1,
"type" : "integer"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "size=<integer> [,name=<string>]"
},
"keyboard" : {
"default" : null,
"description" : "Keybord layout for vnc server. Default is read from the '/etc/pve/datacenter.cfg' configuration file.It should not be necessary to set it.",
@@ -17474,7 +17931,9 @@ var pveapi = [
"migrate",
"rollback",
"snapshot",
"snapshot-delete"
"snapshot-delete",
"suspending",
"suspended"
],
"optional" : 1,
"type" : "string"
@@ -17573,10 +18032,11 @@ var pveapi = [
},
"macaddr" : {
"description" : "MAC address. That address must be unique withing your network. This is automatically generated if not specified.",
"format" : "mac-addr",
"format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1,
"pattern" : "(?^i:[0-9a-f]{2}(?::[0-9a-f]{2}){5})",
"type" : "string"
"type" : "string",
"verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
},
"model" : {
"default_key" : 1,
@@ -18062,11 +18522,18 @@ var pveapi = [
],
"optional" : 1,
"type" : "string"
},
"wwn" : {
"description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
"format_description" : "wwn",
"optional" : 1,
"pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
"type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"scsi[n]" : {
"description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
@@ -18389,11 +18856,18 @@ var pveapi = [
],
"optional" : 1,
"type" : "string"
},
"wwn" : {
"description" : "The drive's worldwide name, encoded as 16 bytes hex string, prefixed by '0x'.",
"format_description" : "wwn",
"optional" : 1,
"pattern" : "(?^:^(0x)[0-9a-fA-F]{16})",
"type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]"
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,iothread=<1|0>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,queues=<integer>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,scsiblock=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"scsihw" : {
"default" : "lsi",
@@ -19080,7 +19554,7 @@ var pveapi = [
"description" : "Allow mounting file systems of specific types. This should be a list of file system types as used with the mount command. Note that this can have negative effects on the container's security. With access to a loop device, mounting a file can circumvent the mknod permission of the devices cgroup, mounting an NFS file system can block the host's I/O completely and prevent it from rebooting, etc.",
"format_description" : "fstype;fstype;...",
"optional" : 1,
"pattern" : "(?^:[a-zA-Z0-9; ]+)",
"pattern" : "(?^:[a-zA-Z0-9_; ]+)",
"type" : "string"
},
"nesting" : {
@@ -19237,10 +19711,11 @@ var pveapi = [
},
"hwaddr" : {
"description" : "The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)",
"format" : "mac-addr",
"format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1,
"pattern" : "(?^i:(?:[a-f0-9]{2}:){5}[a-f0-9]{2})",
"type" : "string"
"type" : "string",
"verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
},
"ip" : {
"description" : "IPv4 address in CIDR format.",
@@ -19529,7 +20004,7 @@ var pveapi = [
"description" : "Allow mounting file systems of specific types. This should be a list of file system types as used with the mount command. Note that this can have negative effects on the container's security. With access to a loop device, mounting a file can circumvent the mknod permission of the devices cgroup, mounting an NFS file system can block the host's I/O completely and prevent it from rebooting, etc.",
"format_description" : "fstype;fstype;...",
"optional" : 1,
"pattern" : "(?^:[a-zA-Z0-9; ]+)",
"pattern" : "(?^:[a-zA-Z0-9_; ]+)",
"type" : "string"
},
"nesting" : {
@@ -19681,10 +20156,11 @@ var pveapi = [
},
"hwaddr" : {
"description" : "The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)",
"format" : "mac-addr",
"format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1,
"pattern" : "(?^i:(?:[a-f0-9]{2}:){5}[a-f0-9]{2})",
"type" : "string"
"type" : "string",
"verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
},
"ip" : {
"description" : "IPv4 address in CIDR format.",
@@ -19967,6 +20443,11 @@ var pveapi = [
"description" : "HA manager service status.",
"type" : "object"
},
"lock" : {
"description" : "The current config lock, if any.",
"optional" : 1,
"type" : "string"
},
"maxdisk" : {
"description" : "Root disk size in bytes.",
"optional" : 1,
@@ -20833,6 +21314,22 @@ var pveapi = [
"optional" : 1,
"type" : "integer"
},
"log" : {
"description" : "Log level for firewall rule",
"enum" : [
"emerg",
"alert",
"crit",
"err",
"warning",
"notice",
"info",
"debug",
"nolog"
],
"optional" : 1,
"type" : "string"
},
"macro" : {
"optional" : 1,
"type" : "string"
@@ -20924,6 +21421,22 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"log" : {
"description" : "Log level for firewall rule.",
"enum" : [
"emerg",
"alert",
"crit",
"err",
"warning",
"notice",
"info",
"debug",
"nolog"
],
"optional" : 1,
"type" : "string"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
@@ -21121,6 +21634,22 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"log" : {
"description" : "Log level for firewall rule.",
"enum" : [
"emerg",
"alert",
"crit",
"err",
"warning",
"notice",
"info",
"debug",
"nolog"
],
"optional" : 1,
"type" : "string"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
@@ -22858,6 +23387,14 @@ var pveapi = [
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"bwlimit" : {
"default" : "migrate limit from datacenter or storage config",
"description" : "Override I/O bandwidth limit (in KiB/s).",
"minimum" : "0",
"optional" : 1,
"type" : "number",
"typetext" : "<number> (0 - N)"
},
"force" : {
"description" : "Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.",
"optional" : 1,
@@ -23045,6 +23582,14 @@ var pveapi = [
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"bwlimit" : {
"default" : "clone limit from datacenter or storage config",
"description" : "Override I/O bandwidth limit (in KiB/s).",
"minimum" : "0",
"optional" : 1,
"type" : "number",
"typetext" : "<number> (0 - N)"
},
"description" : {
"description" : "Description for the new CT.",
"optional" : 1,
@@ -23489,6 +24034,14 @@ var pveapi = [
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"bwlimit" : {
"default" : "clone limit from datacenter or storage config",
"description" : "Override I/O bandwidth limit (in KiB/s).",
"minimum" : "0",
"optional" : 1,
"type" : "number",
"typetext" : "<number> (0 - N)"
},
"delete" : {
"default" : 0,
"description" : "Delete the original volume after successful copy. By default the original is kept as an unused volume entry.",
@@ -23937,6 +24490,11 @@ var pveapi = [
"optional" : 1,
"type" : "number"
},
"lock" : {
"description" : "The current config lock, if any.",
"optional" : 1,
"type" : "string"
},
"maxdisk" : {
"description" : "Root disk size in bytes.",
"optional" : 1,
@@ -24012,7 +24570,8 @@ var pveapi = [
"type" : "string"
},
"bwlimit" : {
"description" : "Override i/o bandwidth limit (in KiB/s).",
"default" : "restore limit from datacenter or storage config",
"description" : "Override I/O bandwidth limit (in KiB/s).",
"minimum" : "0",
"optional" : 1,
"type" : "number",
@@ -24087,7 +24646,7 @@ var pveapi = [
"description" : "Allow mounting file systems of specific types. This should be a list of file system types as used with the mount command. Note that this can have negative effects on the container's security. With access to a loop device, mounting a file can circumvent the mknod permission of the devices cgroup, mounting an NFS file system can block the host's I/O completely and prevent it from rebooting, etc.",
"format_description" : "fstype;fstype;...",
"optional" : 1,
"pattern" : "(?^:[a-zA-Z0-9; ]+)",
"pattern" : "(?^:[a-zA-Z0-9_; ]+)",
"type" : "string"
},
"nesting" : {
@@ -24251,10 +24810,11 @@ var pveapi = [
},
"hwaddr" : {
"description" : "The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)",
"format" : "mac-addr",
"format_description" : "XX:XX:XX:XX:XX:XX",
"optional" : 1,
"pattern" : "(?^i:(?:[a-f0-9]{2}:){5}[a-f0-9]{2})",
"type" : "string"
"type" : "string",
"verbose_description" : "A common MAC address with the I/G (Individual/Group) bit not set."
},
"ip" : {
"description" : "IPv4 address in CIDR format.",
@@ -24486,6 +25046,13 @@ var pveapi = [
"type" : "integer",
"typetext" : "<integer> (0 - 6)"
},
"unique" : {
"description" : "Assign a unique random ethernet address.",
"optional" : 1,
"requires" : "restore",
"type" : "boolean",
"typetext" : "<boolean>"
},
"unprivileged" : {
"default" : 0,
"description" : "Makes the container run as unprivileged user. (Should not be modified manually.)",
@@ -25249,6 +25816,7 @@ var pveapi = [
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"items" : {
"properties" : {
@@ -25392,6 +25960,7 @@ var pveapi = [
1
]
},
"proxyto" : "node",
"returns" : {
"type" : "string"
}
@@ -25508,7 +26077,7 @@ var pveapi = [
"default" : "ceph.target",
"description" : "Ceph service name.",
"optional" : 1,
"pattern" : "(mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}",
"pattern" : "(ceph|mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}",
"type" : "string"
}
}
@@ -25552,7 +26121,7 @@ var pveapi = [
"default" : "ceph.target",
"description" : "Ceph service name.",
"optional" : 1,
"pattern" : "(mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}",
"pattern" : "(ceph|mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}",
"type" : "string"
}
}
@@ -30676,6 +31245,22 @@ var pveapi = [
"optional" : 1,
"type" : "integer"
},
"log" : {
"description" : "Log level for firewall rule",
"enum" : [
"emerg",
"alert",
"crit",
"err",
"warning",
"notice",
"info",
"debug",
"nolog"
],
"optional" : 1,
"type" : "string"
},
"macro" : {
"optional" : 1,
"type" : "string"
@@ -30767,6 +31352,22 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"log" : {
"description" : "Log level for firewall rule.",
"enum" : [
"emerg",
"alert",
"crit",
"err",
"warning",
"notice",
"info",
"debug",
"nolog"
],
"optional" : 1,
"type" : "string"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
@@ -30950,6 +31551,22 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"log" : {
"description" : "Log level for firewall rule.",
"enum" : [
"emerg",
"alert",
"crit",
"err",
"warning",
"notice",
"info",
"debug",
"nolog"
],
"optional" : 1,
"type" : "string"
},
"macro" : {
"description" : "Use predefined standard macro.",
"maxLength" : 128,
@@ -31089,6 +31706,12 @@ var pveapi = [
"optional" : 1,
"type" : "string"
},
"log_nf_conntrack" : {
"default" : 0,
"description" : "Enable logging of conntrack information.",
"optional" : 1,
"type" : "boolean"
},
"ndp" : {
"description" : "Enable NDP.",
"optional" : 1,
@@ -31217,6 +31840,13 @@ var pveapi = [
"optional" : 1,
"type" : "string"
},
"log_nf_conntrack" : {
"default" : 0,
"description" : "Enable logging of conntrack information.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"ndp" : {
"description" : "Enable NDP.",
"optional" : 1,
@@ -32611,6 +33241,17 @@ var pveapi = [
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"cmd" : {
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
"upgrade",
"ceph_install",
"login"
],
"optional" : 1,
"type" : "string"
},
"height" : {
"description" : "sets the height of the console in pixels.",
"maximum" : 2160,
@@ -32627,7 +33268,7 @@ var pveapi = [
},
"upgrade" : {
"default" : 0,
"description" : "Run 'apt-get dist-upgrade' instead of normal shell.",
"description" : "Deprecated, use the 'cmd' property instead! Run 'apt-get dist-upgrade' instead of normal shell.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
@@ -32694,6 +33335,17 @@ var pveapi = [
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"cmd" : {
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
"upgrade",
"ceph_install",
"login"
],
"optional" : 1,
"type" : "string"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
@@ -32702,7 +33354,7 @@ var pveapi = [
},
"upgrade" : {
"default" : 0,
"description" : "Run 'apt-get dist-upgrade' instead of normal shell.",
"description" : "Deprecated, use the 'cmd' property instead! Run 'apt-get dist-upgrade' instead of normal shell.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
@@ -32806,6 +33458,17 @@ var pveapi = [
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"cmd" : {
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
"upgrade",
"ceph_install",
"login"
],
"optional" : 1,
"type" : "string"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
@@ -32821,7 +33484,7 @@ var pveapi = [
},
"upgrade" : {
"default" : 0,
"description" : "Run 'apt-get dist-upgrade' instead of normal shell.",
"description" : "Deprecated, use the 'cmd' property instead! Run 'apt-get dist-upgrade' instead of normal shell.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
@@ -33629,35 +34292,35 @@ var pveapi = [
"description" : "Set bandwidth/io limits various operations.",
"format" : {
"clone" : {
"description" : "bandwidth limit in MiB/s for cloning disks",
"description" : "bandwidth limit in KiB/s for cloning disks",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"default" : {
"description" : "default bandwidth limit in MiB/s",
"description" : "default bandwidth limit in KiB/s",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"migration" : {
"description" : "bandwidth limit in MiB/s for migrating guests",
"description" : "bandwidth limit in KiB/s for migrating guests (including moving local disks)",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"move" : {
"description" : "bandwidth limit in MiB/s for moving disks",
"description" : "bandwidth limit in KiB/s for moving disks",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"restore" : {
"description" : "bandwidth limit in MiB/s for restoring guests from backups",
"description" : "bandwidth limit in KiB/s for restoring guests from backups",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
@@ -34001,35 +34664,35 @@ var pveapi = [
"description" : "Set bandwidth/io limits various operations.",
"format" : {
"clone" : {
"description" : "bandwidth limit in MiB/s for cloning disks",
"description" : "bandwidth limit in KiB/s for cloning disks",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"default" : {
"description" : "default bandwidth limit in MiB/s",
"description" : "default bandwidth limit in KiB/s",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"migration" : {
"description" : "bandwidth limit in MiB/s for migrating guests",
"description" : "bandwidth limit in KiB/s for migrating guests (including moving local disks)",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"move" : {
"description" : "bandwidth limit in MiB/s for moving disks",
"description" : "bandwidth limit in KiB/s for moving disks",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
"type" : "number"
},
"restore" : {
"description" : "bandwidth limit in MiB/s for restoring guests from backups",
"description" : "bandwidth limit in KiB/s for restoring guests from backups",
"format_description" : "LIMIT",
"minimum" : "0",
"optional" : 1,
@@ -35518,7 +36181,7 @@ var pveapi = [
"maxLength" : 128,
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
"typetext" : "type=<TFATYPE> [,digits=<COUNT>] [,id=<ID>] [,key=<KEY>] [,step=<SECONDS>] [,url=<URL>]"
},
"user_attr" : {
"description" : "LDAP user attribute name",
@@ -35704,7 +36367,7 @@ var pveapi = [
"maxLength" : 128,
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
"typetext" : "type=<TFATYPE> [,digits=<COUNT>] [,id=<ID>] [,key=<KEY>] [,step=<SECONDS>] [,url=<URL>]"
},
"type" : {
"description" : "Realm type.",
@@ -35907,6 +36570,121 @@ var pveapi = [
"leaf" : 1,
"path" : "/access/password",
"text" : "password"
},
{
"info" : {
"POST" : {
"description" : "Finish a u2f challenge.",
"method" : "POST",
"name" : "verify_tfa",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"response" : {
"description" : "The response to the current authentication challenge.",
"type" : "string",
"typetext" : "<string>"
}
}
},
"permissions" : {
"user" : "all"
},
"protected" : 1,
"returns" : {
"properties" : {
"ticket" : {
"type" : "string"
}
},
"type" : "object"
}
},
"PUT" : {
"description" : "Change user u2f authentication.",
"method" : "PUT",
"name" : "change_tfa",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"action" : {
"description" : "The action to perform",
"enum" : [
"delete",
"new",
"confirm"
],
"type" : "string"
},
"config" : {
"description" : "A TFA configuration. This must currently be of type TOTP of not set at all.",
"format" : "pve-tfa-config",
"maxLength" : 128,
"optional" : 1,
"type" : "string",
"typetext" : "type=<TFATYPE> [,digits=<COUNT>] [,id=<ID>] [,key=<KEY>] [,step=<SECONDS>] [,url=<URL>]"
},
"key" : {
"description" : "When adding TOTP, the shared secret value.",
"optional" : 1,
"pattern" : "(?^:[A-Z2-7=]{16}|[A-Fa-f0-9]{40})",
"type" : "string"
},
"password" : {
"description" : "The current password.",
"maxLength" : 64,
"minLength" : 5,
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"response" : {
"description" : "Either the the response to the current u2f registration challenge, or, when adding TOTP, the currently valid TOTP value.",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"userid" : {
"description" : "User ID",
"format" : "pve-userid",
"maxLength" : 64,
"type" : "string",
"typetext" : "<string>"
}
}
},
"permissions" : {
"check" : [
"or",
[
"userid-param",
"self"
],
[
"and",
[
"userid-param",
"Realm.AllocateUser"
],
[
"userid-group",
[
"User.Modify"
]
]
]
],
"description" : "A user can change their own u2f or totp token."
},
"protected" : 1,
"returns" : {
"type" : "object"
}
}
},
"leaf" : 1,
"path" : "/access/tfa",
"text" : "tfa"
}
],
"info" : {

+ 18
- 6
datacenter.cfg.5-opts.adoc View File

@@ -4,23 +4,23 @@ Set bandwidth/io limits various operations.

`clone`=`<LIMIT>` ;;

bandwidth limit in MiB/s for cloning disks
bandwidth limit in KiB/s for cloning disks

`default`=`<LIMIT>` ;;

default bandwidth limit in MiB/s
default bandwidth limit in KiB/s

`migration`=`<LIMIT>` ;;

bandwidth limit in MiB/s for migrating guests
bandwidth limit in KiB/s for migrating guests (including moving local disks)

`move`=`<LIMIT>` ;;

bandwidth limit in MiB/s for moving disks
bandwidth limit in KiB/s for moving disks

`restore`=`<LIMIT>` ;;

bandwidth limit in MiB/s for restoring guests from backups
bandwidth limit in KiB/s for restoring guests from backups

`console`: `<applet | html5 | vv | xtermjs>` ::

@@ -56,7 +56,7 @@ Default keybord layout for vnc server.

Default GUI language.

`mac_prefix`: `(?^i:[a-f0-9]{2}(?::[a-f0-9]{2}){0,2}:?)` ::
`mac_prefix`: `<string>` ::

Prefix for autogenerated MAC addresses.

@@ -80,3 +80,15 @@ Migration traffic is encrypted using an SSH tunnel by default. On secure, comple

Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead!

`u2f`: `[appid=<APPID>] [,origin=<URL>]` ::

u2f

`appid`=`<APPID>` ;;

U2F AppId URL override. Defaults to the origin.

`origin`=`<URL>` ;;

U2F Origin override. Mostly useful for single nodes with a single URL.


+ 2
- 2
ha-manager.1-synopsis.adoc View File

@@ -134,7 +134,7 @@ HA resource ID. This consists of a resource type followed by a resource specific

`<node>`: `<string>` ::

The cluster node name.
Target node.

*ha-manager relocate* `<sid> <node>`

@@ -147,7 +147,7 @@ HA resource ID. This consists of a resource type followed by a resource specific

`<node>`: `<string>` ::

The cluster node name.
Target node.

*ha-manager remove* `<sid>`


+ 1
- 1
pct-network-opts.adoc View File

@@ -20,7 +20,7 @@ Default gateway for IPv6 traffic.

`hwaddr`=`<XX:XX:XX:XX:XX:XX>` ;;

The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)
A common MAC address with the I/G (Individual/Group) bit not set.

`ip`=`<(IPv4/CIDR|dhcp|manual)>` ;;


+ 36
- 4
pct.1-synopsis.adoc View File

@@ -12,6 +12,10 @@ The (unique) ID of the VM.

VMID for the clone.

`--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::

Override I/O bandwidth limit (in KiB/s).

`--description` `<string>` ::

Description for the new CT.
@@ -84,9 +88,9 @@ The OS template or backup file.

OS architecture type.

`--bwlimit` `<number> (0 - N)` ::
`--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::

Override i/o bandwidth limit (in KiB/s).
Override I/O bandwidth limit (in KiB/s).

`--cmode` `<console | shell | tty>` ('default =' `tty`)::

@@ -216,6 +220,12 @@ Enable/disable Template.

Specify the number of tty available to the container

`--unique` `<boolean>` ::

Assign a unique random ethernet address.
+
NOTE: Requires option(s): `restore`

`--unprivileged` `<boolean>` ('default =' `0`)::

Makes the container run as unprivileged user. (Should not be modified manually.)
@@ -292,6 +302,14 @@ A volume on which to run the filesystem check

Force checking, even if the filesystem seems clean

*pct fstrim* `<vmid>`

Run fstrim on a chosen CT and its mountpoints.

`<vmid>`: `<integer> (1 - N)` ::

The (unique) ID of the VM.

*pct help* `[OPTIONS]`

Get help about specified command.
@@ -328,6 +346,10 @@ The (unique) ID of the VM.

Target node.

`--bwlimit` `<number> (0 - N)` ('default =' `migrate limit from datacenter or storage config`)::

Override I/O bandwidth limit (in KiB/s).

`--force` `<boolean>` ::

Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.
@@ -370,6 +392,10 @@ Volume which will be moved.

Target Storage.

`--bwlimit` `<number> (0 - N)` ('default =' `clone limit from datacenter or storage config`)::

Override I/O bandwidth limit (in KiB/s).

`--delete` `<boolean>` ('default =' `0`)::

Delete the original volume after successful copy. By default the original is kept as an unused volume entry.
@@ -482,9 +508,9 @@ The OS template or backup file.

OS architecture type.

`--bwlimit` `<number> (0 - N)` ::
`--bwlimit` `<number> (0 - N)` ('default =' `restore limit from datacenter or storage config`)::

Override i/o bandwidth limit (in KiB/s).
Override I/O bandwidth limit (in KiB/s).

`--cmode` `<console | shell | tty>` ('default =' `tty`)::

@@ -610,6 +636,12 @@ Enable/disable Template.

Specify the number of tty available to the container

`--unique` `<boolean>` ::

Assign a unique random ethernet address.
+
NOTE: Requires option(s): `restore`

`--unprivileged` `<boolean>` ('default =' `0`)::

Makes the container run as unprivileged user. (Should not be modified manually.)

+ 1
- 1
pct.conf.5-opts.adoc View File

@@ -136,7 +136,7 @@ Default gateway for IPv6 traffic.

`hwaddr`=`<XX:XX:XX:XX:XX:XX>` ;;

The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)
A common MAC address with the I/G (Individual/Group) bit not set.

`ip`=`<(IPv4/CIDR|dhcp|manual)>` ;;


+ 16
- 0
pve-firewall-cluster-opts.adoc View File

@@ -6,6 +6,22 @@ Enable ebtables rules cluster wide.

Enable or disable the firewall cluster wide.

`log_ratelimit`: `[enable=]<1|0> [,burst=<integer>] [,rate=<rate>]` ::

Log ratelimiting settings

`burst`=`<integer> (0 - N)` ('default =' `5`);;

Inital burst of packages which will get logged

`enable`=`<boolean>` ('default =' `1`);;

Enable or disable log rate limiting

`rate`=`<rate>` ('default =' `1/second`);;

Frequency with which the burst bucket gets refilled

`policy_in`: `<ACCEPT | DROP | REJECT>` ::

Input policy.

+ 4
- 0
pve-firewall-host-opts.adoc View File

@@ -10,6 +10,10 @@ Log level for incoming traffic.

Log level for outgoing traffic.

`log_nf_conntrack`: `<boolean>` ('default =' `0`)::

Enable logging of conntrack information.

`ndp`: `<boolean>` ::

Enable NDP.

+ 1
- 1
pve-firewall-macros.adoc View File

@@ -539,7 +539,7 @@
[width="100%",options="header"]
|===========================================================
|Action|proto|dport|sport
|ACCEPT|tcp|2703|
|PARAM|tcp|2703|
|===========================================================

[horizontal]

+ 4
- 0
pve-firewall-rules-opts.adoc View File

@@ -10,6 +10,10 @@ Restrict TCP/UDP destination port. You can use service names or simple numbers (

Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.

`--log` `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::

Log level for firewall rule.

`--proto` `<string>` ::

IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.

+ 2
- 2
pveceph.1-synopsis.adoc View File

@@ -266,7 +266,7 @@ Destroy ceph related data and configuration files.

Start ceph services.

`<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`)::
`<service>`: `(ceph|mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`)::

Ceph service name.

@@ -278,7 +278,7 @@ Get ceph status.

Stop ceph services.

`<service>`: `(mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`)::
`<service>`: `(ceph|mon|mds|osd|mgr)\.[A-Za-z0-9\-]{1,32}` ('default =' `ceph.target`)::

Ceph service name.


+ 20
- 0
pvecm.1-synopsis.adoc View File

@@ -156,6 +156,26 @@ Run a command with a tcp socket as standard input. The IP address and port are p

Displays the local view of the cluster nodes.

*pvecm qdevice remove*

Remove a configured QDevice

*pvecm qdevice setup* `<address>` `[OPTIONS]`

Setup the use of a QDevice

`<address>`: `<string>` ::

Specifies the network address of an external corosync QDevice

`--force` `<boolean>` ::

Do not throw error on possible dangerous operations.

`--network` `<string>` ::

The network which should be used to connect to the external qdevice

*pvecm status*

Displays the local view of the cluster status.

+ 16
- 0
qm-cloud-init-opts.adoc View File

@@ -1,3 +1,19 @@
`cicustom`: `[meta=<volume>] [,network=<volume>] [,user=<volume>]` ::

Specify custom files to replace the automatically generated ones at start.