From: Thomas Lamprecht Date: Mon, 12 Sep 2022 15:25:00 +0000 (+0200) Subject: update static/schema information X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=commitdiff_plain;h=de786b48df593f1026b48d33a132f149bb893614 update static/schema information Signed-off-by: Thomas Lamprecht --- diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index f0a1321..1d4f7a3 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -1162,6 +1162,7 @@ const apiSchema = [ ] ] }, + "protected" : 1, "returns" : { "type" : "object" } @@ -3741,6 +3742,13 @@ const apiSchema = [ "type" : "boolean", "typetext" : "" }, + "repeat-missed" : { + "default" : 0, + "description" : "If true, the job will be run as soon as possible if it was missed while the scheduler was not running.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "schedule" : { "description" : "Backup schedule. The format is a subset of `systemd` calendar events.", "format" : "pve-calendar-event", @@ -4066,6 +4074,13 @@ const apiSchema = [ "type" : "boolean", "typetext" : "" }, + "repeat-missed" : { + "default" : 0, + "description" : "If true, the job will be run as soon as possible if it was missed while the scheduler was not running.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "schedule" : { "description" : "Backup schedule. The format is a subset of `systemd` calendar events.", "format" : "pve-calendar-event", @@ -8811,7 +8826,7 @@ const apiSchema = [ "upper" : { "default" : 1000000, "description" : "Upper, exclusive boundary for free next-id API range.", - "max" : 999999999, + "max" : 1000000000, "min" : 100, "optional" : 1, "type" : "integer" @@ -10504,7 +10519,7 @@ const apiSchema = [ "type" : "string" }, "macfilter" : { - "default" : 0, + "default" : 1, "description" : "Enable/disable MAC address filter.", "optional" : 1, "type" : "boolean" @@ -10619,7 +10634,7 @@ const apiSchema = [ "type" : "string" }, "macfilter" : { - "default" : 0, + "default" : 1, "description" : "Enable/disable MAC address filter.", "optional" : 1, "type" : "boolean", @@ -13179,7 +13194,7 @@ const apiSchema = [ "type" : "string" }, "nameserver" : { - "description" : "cloud-init: Sets DNS server IP address for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.", + "description" : "cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", "format" : "address-list", "optional" : 1, "type" : "string" @@ -14114,7 +14129,7 @@ const apiSchema = [ "type" : "string" }, "searchdomain" : { - "description" : "cloud-init: Sets DNS search domains for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.", + "description" : "cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", "optional" : 1, "type" : "string" }, @@ -15483,7 +15498,7 @@ const apiSchema = [ "typetext" : "" }, "nameserver" : { - "description" : "cloud-init: Sets DNS server IP address for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.", + "description" : "cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", "format" : "address-list", "optional" : 1, "type" : "string", @@ -16455,7 +16470,7 @@ const apiSchema = [ "type" : "string" }, "searchdomain" : { - "description" : "cloud-init: Sets DNS search domains for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.", + "description" : "cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", "optional" : 1, "type" : "string", "typetext" : "" @@ -17885,7 +17900,7 @@ const apiSchema = [ "typetext" : "" }, "nameserver" : { - "description" : "cloud-init: Sets DNS server IP address for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.", + "description" : "cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", "format" : "address-list", "optional" : 1, "type" : "string", @@ -18857,7 +18872,7 @@ const apiSchema = [ "type" : "string" }, "searchdomain" : { - "description" : "cloud-init: Sets DNS search domains for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.", + "description" : "cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", "optional" : 1, "type" : "string", "typetext" : "" @@ -23543,7 +23558,7 @@ const apiSchema = [ "typetext" : "" }, "nameserver" : { - "description" : "cloud-init: Sets DNS server IP address for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.", + "description" : "cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", "format" : "address-list", "optional" : 1, "type" : "string", @@ -24515,7 +24530,7 @@ const apiSchema = [ "type" : "string" }, "searchdomain" : { - "description" : "cloud-init: Sets DNS search domains for a container. Create will'\n\t .' automatically use the setting from the host if neither searchdomain nor nameserver'\n\t .' are set.", + "description" : "cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.", "optional" : 1, "type" : "string", "typetext" : "" @@ -28588,7 +28603,7 @@ const apiSchema = [ "type" : "string" }, "macfilter" : { - "default" : 0, + "default" : 1, "description" : "Enable/disable MAC address filter.", "optional" : 1, "type" : "boolean" @@ -28703,7 +28718,7 @@ const apiSchema = [ "type" : "string" }, "macfilter" : { - "default" : 0, + "default" : 1, "description" : "Enable/disable MAC address filter.", "optional" : 1, "type" : "boolean", @@ -39708,6 +39723,9 @@ const apiSchema = [ "optional" : 1, "type" : "string" }, + "mounted" : { + "type" : "boolean" + }, "osdid" : { "type" : "integer" }, @@ -42853,8 +42871,10 @@ const apiSchema = [ "properties" : { "commands" : { "description" : "JSON encoded array of commands.", + "format" : "pve-command-batch", "type" : "string", - "typetext" : "" + "typetext" : "", + "verbose_description" : "JSON encoded array of commands, where each command is an object with the following properties:\n args: \n\n\t A set of parameter names and their values.\n\n method: (GET|POST|PUT|DELETE)\n\n\t A method related to the API endpoint (GET, POST etc.).\n\n path: \n\n\t A relative path to an API endpoint on this node.\n\n" }, "node" : { "description" : "The cluster node name.", @@ -42876,6 +42896,10 @@ const apiSchema = [ "protected" : 1, "proxyto" : "node", "returns" : { + "items" : { + "properties" : {}, + "type" : "object" + }, "type" : "array" } } @@ -43222,9 +43246,9 @@ const apiSchema = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ - "ceph_install", "upgrade", - "login" + "login", + "ceph_install" ], "optional" : 1, "type" : "string" @@ -43318,9 +43342,9 @@ const apiSchema = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ - "ceph_install", "upgrade", - "login" + "login", + "ceph_install" ], "optional" : 1, "type" : "string" @@ -43444,9 +43468,9 @@ const apiSchema = [ "default" : "login", "description" : "Run specific command or default to login.", "enum" : [ - "ceph_install", "upgrade", - "login" + "login", + "ceph_install" ], "optional" : 1, "type" : "string" @@ -44556,7 +44580,7 @@ const apiSchema = [ "typetext" : "" }, "namespace" : { - "description" : "RBD Namespace.", + "description" : "Namespace.", "optional" : 1, "type" : "string", "typetext" : "" @@ -45060,7 +45084,7 @@ const apiSchema = [ "typetext" : "" }, "namespace" : { - "description" : "RBD Namespace.", + "description" : "Namespace.", "optional" : 1, "type" : "string", "typetext" : "" @@ -45477,8 +45501,7 @@ const apiSchema = [ "self" ], [ - "perm", - "/access/users/{userid}", + "userid-group", [ "User.Modify" ] @@ -45520,8 +45543,7 @@ const apiSchema = [ "self" ], [ - "perm", - "/access/users/{userid}", + "userid-group", [ "User.Modify" ] @@ -45601,8 +45623,7 @@ const apiSchema = [ "self" ], [ - "perm", - "/access/users/{userid}", + "userid-group", [ "User.Modify" ] @@ -45698,8 +45719,7 @@ const apiSchema = [ "self" ], [ - "perm", - "/access/users/{userid}", + "userid-group", [ "User.Modify" ] @@ -45763,8 +45783,7 @@ const apiSchema = [ "self" ], [ - "perm", - "/access/users/{userid}", + "userid-group", [ "User.Modify" ] @@ -47778,7 +47797,7 @@ const apiSchema = [ "properties" : { "code" : { "description" : "OpenId authorization code.", - "maxLength" : 1024, + "maxLength" : 4096, "type" : "string", "typetext" : "" }, diff --git a/pve-firewall-vm-opts.adoc b/pve-firewall-vm-opts.adoc index 84cd752..9f191cf 100644 --- a/pve-firewall-vm-opts.adoc +++ b/pve-firewall-vm-opts.adoc @@ -18,7 +18,7 @@ Log level for incoming traffic. Log level for outgoing traffic. -`macfilter`: `` ('default =' `0`):: +`macfilter`: `` ('default =' `1`):: Enable/disable MAC address filter. diff --git a/pve-firewall.8-synopsis.adoc b/pve-firewall.8-synopsis.adoc index 882aab8..cd2f2fe 100644 --- a/pve-firewall.8-synopsis.adoc +++ b/pve-firewall.8-synopsis.adoc @@ -26,9 +26,9 @@ Restart the Proxmox VE firewall service. *pve-firewall simulate* `[OPTIONS]` -Simulate firewall rules. This does not simulate kernel 'routing' table. -Instead, this simply assumes that routing from source zone to destination -zone is possible. +Simulate firewall rules. This does not simulates the kernel 'routing' +table, but simply assumes that routing from source zone to destination zone +is possible. `--dest` `` :: @@ -76,7 +76,8 @@ Get firewall status. *pve-firewall stop* -Stop firewall. This removes all Proxmox VE related iptable rules. The host -is unprotected afterwards. +Stop the Proxmox VE firewall service. Note, stopping actively removes all +Proxmox VE related iptable rules rendering the host potentially +unprotected. diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index 04041d0..7a2699f 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -122,7 +122,7 @@ Allow experimental versions. Use with care! Use the test, not the main repository. Use with care! -`--version` `` ('default =' `pacific`):: +`--version` `` ('default =' `pacific`):: Ceph version to install. diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index f7fc499..89c797b 100644 --- a/pvesm.1-synopsis.adoc +++ b/pvesm.1-synopsis.adoc @@ -128,7 +128,7 @@ mount point `--namespace` `` :: -RBD Namespace. +Namespace. `--nocow` `` ('default =' `0`):: @@ -676,7 +676,7 @@ mount point `--namespace` `` :: -RBD Namespace. +Namespace. `--nocow` `` ('default =' `0`):: diff --git a/pvesubscription.1-synopsis.adoc b/pvesubscription.1-synopsis.adoc index da8dade..64db530 100644 --- a/pvesubscription.1-synopsis.adoc +++ b/pvesubscription.1-synopsis.adoc @@ -28,6 +28,14 @@ Set subscription key. Proxmox VE subscription key +*pvesubscription set-offline-key* `` + +(Internal use only!) Set a signed subscription info blob as offline key + +``: `` :: + +no description available + *pvesubscription update* `[OPTIONS]` Update subscription info. diff --git a/qm-cloud-init-opts.adoc b/qm-cloud-init-opts.adoc index c01aabd..f4cc36f 100644 --- a/qm-cloud-init-opts.adoc +++ b/qm-cloud-init-opts.adoc @@ -67,15 +67,11 @@ IPv6 address in CIDR format. `nameserver`: `` :: -Sets DNS server IP address for a container. Create will' - .' automatically use the setting from the host if neither searchdomain nor nameserver' - .' are set. +Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. `searchdomain`: `` :: -Sets DNS search domains for a container. Create will' - .' automatically use the setting from the host if neither searchdomain nor nameserver' - .' are set. +Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. `sshkeys`: `` :: diff --git a/qm.1-synopsis.adoc b/qm.1-synopsis.adoc index d64493d..3e59547 100644 --- a/qm.1-synopsis.adoc +++ b/qm.1-synopsis.adoc @@ -295,9 +295,7 @@ Set a name for the VM. Only used on the configuration web interface. `--nameserver` `` :: -cloud-init: Sets DNS server IP address for a container. Create will' - .' automatically use the setting from the host if neither searchdomain nor nameserver' - .' are set. +cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. `--net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,mtu=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: @@ -353,9 +351,7 @@ SCSI controller model `--searchdomain` `` :: -cloud-init: Sets DNS search domains for a container. Create will' - .' automatically use the setting from the host if neither searchdomain nor nameserver' - .' are set. +cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. `--serial[n]` `(/dev/.+|socket)` :: @@ -1048,9 +1044,7 @@ Set a name for the VM. Only used on the configuration web interface. `--nameserver` `` :: -cloud-init: Sets DNS server IP address for a container. Create will' - .' automatically use the setting from the host if neither searchdomain nor nameserver' - .' are set. +cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. `--net[n]` `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,mtu=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: @@ -1106,9 +1100,7 @@ SCSI controller model `--searchdomain` `` :: -cloud-init: Sets DNS search domains for a container. Create will' - .' automatically use the setting from the host if neither searchdomain nor nameserver' - .' are set. +cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. `--serial[n]` `(/dev/.+|socket)` :: diff --git a/qm.conf.5-opts.adoc b/qm.conf.5-opts.adoc index a56dc5d..d80a882 100644 --- a/qm.conf.5-opts.adoc +++ b/qm.conf.5-opts.adoc @@ -145,7 +145,7 @@ The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a spe The physical memory address bits that are reported to the guest OS. Should be smaller or equal to the host's. Set to 'host' to use value from host CPU, but note that doing so will break live migration to CPUs with other values. -`reported-model`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Cascadelake-Server | Cascadelake-Server-noTSX | Conroe | EPYC | EPYC-IBPB | EPYC-Rome | Haswell | Haswell-IBRS | Haswell-noTSX | Haswell-noTSX-IBRS | Icelake-Client | Icelake-Client-noTSX | Icelake-Server | Icelake-Server-noTSX | IvyBridge | IvyBridge-IBRS | KnightsMill | Nehalem | Nehalem-IBRS | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | SandyBridge-IBRS | Skylake-Client | Skylake-Client-IBRS | Skylake-Client-noTSX-IBRS | Skylake-Server | Skylake-Server-IBRS | Skylake-Server-noTSX-IBRS | Westmere | Westmere-IBRS | athlon | core2duo | coreduo | host | kvm32 | kvm64 | max | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);; +`reported-model`=`<486 | Broadwell | Broadwell-IBRS | Broadwell-noTSX | Broadwell-noTSX-IBRS | Cascadelake-Server | Cascadelake-Server-noTSX | Conroe | EPYC | EPYC-IBPB | EPYC-Milan | EPYC-Rome | Haswell | Haswell-IBRS | Haswell-noTSX | Haswell-noTSX-IBRS | Icelake-Client | Icelake-Client-noTSX | Icelake-Server | Icelake-Server-noTSX | IvyBridge | IvyBridge-IBRS | KnightsMill | Nehalem | Nehalem-IBRS | Opteron_G1 | Opteron_G2 | Opteron_G3 | Opteron_G4 | Opteron_G5 | Penryn | SandyBridge | SandyBridge-IBRS | Skylake-Client | Skylake-Client-IBRS | Skylake-Client-noTSX-IBRS | Skylake-Server | Skylake-Server-IBRS | Skylake-Server-noTSX-IBRS | Westmere | Westmere-IBRS | athlon | core2duo | coreduo | host | kvm32 | kvm64 | max | pentium | pentium2 | pentium3 | phenom | qemu32 | qemu64>` ('default =' `kvm64`);; CPU model and vendor to report to the guest. Must be a QEMU/KVM supported model. Only valid for custom CPU model definitions, default models will always report themselves to the guest OS. @@ -529,9 +529,7 @@ Set a name for the VM. Only used on the configuration web interface. `nameserver`: `` :: -cloud-init: Sets DNS server IP address for a container. Create will' - .' automatically use the setting from the host if neither searchdomain nor nameserver' - .' are set. +cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. `net[n]`: `[model=] [,bridge=] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=] [,mtu=] [,queues=] [,rate=] [,tag=] [,trunks=] [,=]` :: @@ -1041,9 +1039,7 @@ SCSI controller model `searchdomain`: `` :: -cloud-init: Sets DNS search domains for a container. Create will' - .' automatically use the setting from the host if neither searchdomain nor nameserver' - .' are set. +cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. `serial[n]`: `(/dev/.+|socket)` ::