mirror of
git://git.proxmox.com/git/pve-docs.git
synced 2025-01-03 01:17:49 +03:00
update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
parent
1024fbf5d0
commit
de786b48df
@ -1162,6 +1162,7 @@ const apiSchema = [
|
||||
]
|
||||
]
|
||||
},
|
||||
"protected" : 1,
|
||||
"returns" : {
|
||||
"type" : "object"
|
||||
}
|
||||
@ -3741,6 +3742,13 @@ const apiSchema = [
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"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" : "<boolean>"
|
||||
},
|
||||
"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" : "<boolean>"
|
||||
},
|
||||
"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" : "<boolean>"
|
||||
},
|
||||
"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" : "<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",
|
||||
@ -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" : "<string>"
|
||||
@ -17885,7 +17900,7 @@ const apiSchema = [
|
||||
"typetext" : "<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",
|
||||
@ -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" : "<string>"
|
||||
@ -23543,7 +23558,7 @@ const apiSchema = [
|
||||
"typetext" : "<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",
|
||||
@ -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" : "<string>"
|
||||
@ -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" : "<string>"
|
||||
"typetext" : "<string>",
|
||||
"verbose_description" : "JSON encoded array of commands, where each command is an object with the following properties:\n args: <object>\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: <string>\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" : "<string>"
|
||||
},
|
||||
"namespace" : {
|
||||
"description" : "RBD Namespace.",
|
||||
"description" : "Namespace.",
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
@ -45060,7 +45084,7 @@ const apiSchema = [
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"namespace" : {
|
||||
"description" : "RBD Namespace.",
|
||||
"description" : "Namespace.",
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
@ -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" : "<string>"
|
||||
},
|
||||
|
||||
@ -18,7 +18,7 @@ Log level for incoming traffic.
|
||||
|
||||
Log level for outgoing traffic.
|
||||
|
||||
`macfilter`: `<boolean>` ('default =' `0`)::
|
||||
`macfilter`: `<boolean>` ('default =' `1`)::
|
||||
|
||||
Enable/disable MAC address filter.
|
||||
|
||||
|
||||
@ -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` `<string>` ::
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
|
||||
@ -122,7 +122,7 @@ Allow experimental versions. Use with care!
|
||||
|
||||
Use the test, not the main repository. Use with care!
|
||||
|
||||
`--version` `<octopus | pacific>` ('default =' `pacific`)::
|
||||
`--version` `<octopus | pacific | quincy>` ('default =' `pacific`)::
|
||||
|
||||
Ceph version to install.
|
||||
|
||||
|
||||
@ -128,7 +128,7 @@ mount point
|
||||
|
||||
`--namespace` `<string>` ::
|
||||
|
||||
RBD Namespace.
|
||||
Namespace.
|
||||
|
||||
`--nocow` `<boolean>` ('default =' `0`)::
|
||||
|
||||
@ -676,7 +676,7 @@ mount point
|
||||
|
||||
`--namespace` `<string>` ::
|
||||
|
||||
RBD Namespace.
|
||||
Namespace.
|
||||
|
||||
`--nocow` `<boolean>` ('default =' `0`)::
|
||||
|
||||
|
||||
@ -28,6 +28,14 @@ Set subscription key.
|
||||
|
||||
Proxmox VE subscription key
|
||||
|
||||
*pvesubscription set-offline-key* `<data>`
|
||||
|
||||
(Internal use only!) Set a signed subscription info blob as offline key
|
||||
|
||||
`<data>`: `<string>` ::
|
||||
|
||||
no description available
|
||||
|
||||
*pvesubscription update* `[OPTIONS]`
|
||||
|
||||
Update subscription info.
|
||||
|
||||
@ -67,15 +67,11 @@ IPv6 address in CIDR format.
|
||||
|
||||
`nameserver`: `<string>` ::
|
||||
|
||||
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`: `<string>` ::
|
||||
|
||||
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`: `<string>` ::
|
||||
|
||||
|
||||
@ -295,9 +295,7 @@ Set a name for the VM. Only used on the configuration web interface.
|
||||
|
||||
`--nameserver` `<string>` ::
|
||||
|
||||
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=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
|
||||
|
||||
@ -353,9 +351,7 @@ SCSI controller model
|
||||
|
||||
`--searchdomain` `<string>` ::
|
||||
|
||||
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` `<string>` ::
|
||||
|
||||
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=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
|
||||
|
||||
@ -1106,9 +1100,7 @@ SCSI controller model
|
||||
|
||||
`--searchdomain` `<string>` ::
|
||||
|
||||
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)` ::
|
||||
|
||||
|
||||
@ -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`: `<string>` ::
|
||||
|
||||
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=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,mtu=<integer>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
|
||||
|
||||
@ -1041,9 +1039,7 @@ SCSI controller model
|
||||
|
||||
`searchdomain`: `<string>` ::
|
||||
|
||||
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)` ::
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user