mirror of
https://git.proxmox.com/git/pve-docs
synced 2025-04-28 12:12:29 +00:00
update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
parent
2173def643
commit
74fc3c7681
@ -741,6 +741,117 @@ const apiSchema = [
|
||||
},
|
||||
{
|
||||
"children" : [
|
||||
{
|
||||
"info" : {
|
||||
"GET" : {
|
||||
"allowtoken" : 1,
|
||||
"description" : "Returns known notification metadata fields",
|
||||
"method" : "GET",
|
||||
"name" : "get_matcher_fields",
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0
|
||||
},
|
||||
"permissions" : {
|
||||
"check" : [
|
||||
"or",
|
||||
[
|
||||
"perm",
|
||||
"/mapping/notifications",
|
||||
[
|
||||
"Mapping.Modify"
|
||||
]
|
||||
],
|
||||
[
|
||||
"perm",
|
||||
"/mapping/notifications",
|
||||
[
|
||||
"Mapping.Audit"
|
||||
]
|
||||
]
|
||||
]
|
||||
},
|
||||
"protected" : 0,
|
||||
"returns" : {
|
||||
"items" : {
|
||||
"properties" : {
|
||||
"name" : {
|
||||
"description" : "Name of the field.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
},
|
||||
"links" : [
|
||||
{
|
||||
"href" : "{name}",
|
||||
"rel" : "child"
|
||||
}
|
||||
],
|
||||
"type" : "array"
|
||||
}
|
||||
}
|
||||
},
|
||||
"leaf" : 1,
|
||||
"path" : "/cluster/notifications/matcher-fields",
|
||||
"text" : "matcher-fields"
|
||||
},
|
||||
{
|
||||
"info" : {
|
||||
"GET" : {
|
||||
"allowtoken" : 1,
|
||||
"description" : "Returns known notification metadata fields and their known values",
|
||||
"method" : "GET",
|
||||
"name" : "get_matcher_field_values",
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0
|
||||
},
|
||||
"permissions" : {
|
||||
"check" : [
|
||||
"or",
|
||||
[
|
||||
"perm",
|
||||
"/mapping/notifications",
|
||||
[
|
||||
"Mapping.Modify"
|
||||
]
|
||||
],
|
||||
[
|
||||
"perm",
|
||||
"/mapping/notifications",
|
||||
[
|
||||
"Mapping.Audit"
|
||||
]
|
||||
]
|
||||
]
|
||||
},
|
||||
"protected" : 1,
|
||||
"returns" : {
|
||||
"items" : {
|
||||
"properties" : {
|
||||
"comment" : {
|
||||
"description" : "Additional comment for this value.",
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"field" : {
|
||||
"description" : "Field this value belongs to.",
|
||||
"type" : "string"
|
||||
},
|
||||
"value" : {
|
||||
"description" : "Notification metadata value known by the system.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
},
|
||||
"type" : "array"
|
||||
}
|
||||
}
|
||||
},
|
||||
"leaf" : 1,
|
||||
"path" : "/cluster/notifications/matcher-field-values",
|
||||
"text" : "matcher-field-values"
|
||||
},
|
||||
{
|
||||
"children" : [
|
||||
{
|
||||
@ -5678,6 +5789,16 @@ const apiSchema = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"pbs-change-detection-mode" : {
|
||||
"description" : "PBS mode used to detect file changes and switch encoding. NOTE: `data` and `metadata` modes are experimental. format for container backups.",
|
||||
"enum" : [
|
||||
"legacy",
|
||||
"data",
|
||||
"metadata"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"performance" : {
|
||||
"description" : "Other performance-related settings.",
|
||||
"format" : "backup-performance",
|
||||
@ -6057,6 +6178,16 @@ const apiSchema = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"pbs-change-detection-mode" : {
|
||||
"description" : "PBS mode used to detect file changes and switch encoding. NOTE: `data` and `metadata` modes are experimental. format for container backups.",
|
||||
"enum" : [
|
||||
"legacy",
|
||||
"data",
|
||||
"metadata"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"performance" : {
|
||||
"description" : "Other performance-related settings.",
|
||||
"format" : "backup-performance",
|
||||
@ -17277,7 +17408,7 @@ const apiSchema = [
|
||||
},
|
||||
"migrate_downtime" : {
|
||||
"default" : 0.1,
|
||||
"description" : "Set maximum tolerated downtime (in seconds) for migrations.",
|
||||
"description" : "Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge.",
|
||||
"minimum" : 0,
|
||||
"optional" : 1,
|
||||
"type" : "number"
|
||||
@ -18373,7 +18504,7 @@ const apiSchema = [
|
||||
"type" : "string"
|
||||
},
|
||||
"version" : {
|
||||
"default" : "v2.0",
|
||||
"default" : "v1.2",
|
||||
"description" : "The TPM interface version. v2.0 is newer and should be preferred. Note that this cannot be changed later on.",
|
||||
"enum" : [
|
||||
"v1.2",
|
||||
@ -18462,7 +18593,7 @@ const apiSchema = [
|
||||
"type" : {
|
||||
"default" : "std",
|
||||
"default_key" : 1,
|
||||
"description" : "Select the VGA type.",
|
||||
"description" : "Select the VGA type. Using type 'cirrus' is not recommended.",
|
||||
"enum" : [
|
||||
"cirrus",
|
||||
"qxl",
|
||||
@ -19655,7 +19786,7 @@ const apiSchema = [
|
||||
},
|
||||
"migrate_downtime" : {
|
||||
"default" : 0.1,
|
||||
"description" : "Set maximum tolerated downtime (in seconds) for migrations.",
|
||||
"description" : "Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge.",
|
||||
"minimum" : 0,
|
||||
"optional" : 1,
|
||||
"type" : "number",
|
||||
@ -20815,7 +20946,7 @@ const apiSchema = [
|
||||
"type" : "string"
|
||||
},
|
||||
"version" : {
|
||||
"default" : "v2.0",
|
||||
"default" : "v1.2",
|
||||
"description" : "The TPM interface version. v2.0 is newer and should be preferred. Note that this cannot be changed later on.",
|
||||
"enum" : [
|
||||
"v1.2",
|
||||
@ -20908,7 +21039,7 @@ const apiSchema = [
|
||||
"type" : {
|
||||
"default" : "std",
|
||||
"default_key" : 1,
|
||||
"description" : "Select the VGA type.",
|
||||
"description" : "Select the VGA type. Using type 'cirrus' is not recommended.",
|
||||
"enum" : [
|
||||
"cirrus",
|
||||
"qxl",
|
||||
@ -22135,7 +22266,7 @@ const apiSchema = [
|
||||
},
|
||||
"migrate_downtime" : {
|
||||
"default" : 0.1,
|
||||
"description" : "Set maximum tolerated downtime (in seconds) for migrations.",
|
||||
"description" : "Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge.",
|
||||
"minimum" : 0,
|
||||
"optional" : 1,
|
||||
"type" : "number",
|
||||
@ -23295,7 +23426,7 @@ const apiSchema = [
|
||||
"type" : "string"
|
||||
},
|
||||
"version" : {
|
||||
"default" : "v2.0",
|
||||
"default" : "v1.2",
|
||||
"description" : "The TPM interface version. v2.0 is newer and should be preferred. Note that this cannot be changed later on.",
|
||||
"enum" : [
|
||||
"v1.2",
|
||||
@ -23388,7 +23519,7 @@ const apiSchema = [
|
||||
"type" : {
|
||||
"default" : "std",
|
||||
"default_key" : 1,
|
||||
"description" : "Select the VGA type.",
|
||||
"description" : "Select the VGA type. Using type 'cirrus' is not recommended.",
|
||||
"enum" : [
|
||||
"cirrus",
|
||||
"qxl",
|
||||
@ -28298,7 +28429,7 @@ const apiSchema = [
|
||||
},
|
||||
"migrate_downtime" : {
|
||||
"default" : 0.1,
|
||||
"description" : "Set maximum tolerated downtime (in seconds) for migrations.",
|
||||
"description" : "Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge.",
|
||||
"minimum" : 0,
|
||||
"optional" : 1,
|
||||
"type" : "number",
|
||||
@ -29467,7 +29598,7 @@ const apiSchema = [
|
||||
"type" : "string"
|
||||
},
|
||||
"version" : {
|
||||
"default" : "v2.0",
|
||||
"default" : "v1.2",
|
||||
"description" : "The TPM interface version. v2.0 is newer and should be preferred. Note that this cannot be changed later on.",
|
||||
"enum" : [
|
||||
"v1.2",
|
||||
@ -29567,7 +29698,7 @@ const apiSchema = [
|
||||
"type" : {
|
||||
"default" : "std",
|
||||
"default_key" : 1,
|
||||
"description" : "Select the VGA type.",
|
||||
"description" : "Select the VGA type. Using type 'cirrus' is not recommended.",
|
||||
"enum" : [
|
||||
"cirrus",
|
||||
"qxl",
|
||||
@ -40238,6 +40369,16 @@ const apiSchema = [
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"pbs-change-detection-mode" : {
|
||||
"description" : "PBS mode used to detect file changes and switch encoding. NOTE: `data` and `metadata` modes are experimental. format for container backups.",
|
||||
"enum" : [
|
||||
"legacy",
|
||||
"data",
|
||||
"metadata"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"performance" : {
|
||||
"description" : "Other performance-related settings.",
|
||||
"format" : "backup-performance",
|
||||
@ -40451,6 +40592,14 @@ const apiSchema = [
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer> (0 - 8)"
|
||||
},
|
||||
"job-id" : {
|
||||
"description" : "The ID of the backup job. If set, the 'backup-job' metadata field of the backup notification will be set to this value. Only root@pam can set this parameter.",
|
||||
"format" : "pve-configid",
|
||||
"maxLength" : 256,
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"lockwait" : {
|
||||
"default" : 180,
|
||||
"description" : "Maximal time to wait for the global lock (minutes).",
|
||||
@ -40538,6 +40687,16 @@ const apiSchema = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"pbs-change-detection-mode" : {
|
||||
"description" : "PBS mode used to detect file changes and switch encoding. NOTE: `data` and `metadata` modes are experimental. format for container backups.",
|
||||
"enum" : [
|
||||
"legacy",
|
||||
"data",
|
||||
"metadata"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"performance" : {
|
||||
"description" : "Other performance-related settings.",
|
||||
"format" : "backup-performance",
|
||||
@ -40652,7 +40811,7 @@ const apiSchema = [
|
||||
}
|
||||
},
|
||||
"permissions" : {
|
||||
"description" : "The user needs 'VM.Backup' permissions on any VM, and 'Datastore.AllocateSpace' on the backup storage (and fleecing storage when fleecing is used). The 'tmpdir', 'dumpdir' and 'script' parameters are restricted to the 'root@pam' user. The 'maxfiles' and 'prune-backups' settings require 'Datastore.Allocate' on the backup storage. The 'bwlimit', 'performance' and 'ionice' parameters require 'Sys.Modify' on '/'.",
|
||||
"description" : "The user needs 'VM.Backup' permissions on any VM, and 'Datastore.AllocateSpace' on the backup storage (and fleecing storage when fleecing is used). The 'tmpdir', 'dumpdir', 'script' and 'job-id' parameters are restricted to the 'root@pam' user. The 'maxfiles' and 'prune-backups' settings require 'Datastore.Allocate' on the backup storage. The 'bwlimit', 'performance' and 'ionice' parameters require 'Sys.Modify' on '/'.",
|
||||
"user" : "all"
|
||||
},
|
||||
"protected" : 1,
|
||||
@ -49039,7 +49198,7 @@ const apiSchema = [
|
||||
"type" : "object"
|
||||
},
|
||||
"current-kernel" : {
|
||||
"description" : "The uptime of the system in seconds.",
|
||||
"description" : "Meta-information about the currently booted kernel of this node.",
|
||||
"properties" : {
|
||||
"machine" : {
|
||||
"description" : "Hardware (architecture) type",
|
||||
@ -49527,9 +49686,9 @@ const apiSchema = [
|
||||
"default" : "login",
|
||||
"description" : "Run specific command or default to login (requires 'root@pam')",
|
||||
"enum" : [
|
||||
"upgrade",
|
||||
"login",
|
||||
"ceph_install",
|
||||
"login"
|
||||
"upgrade"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
@ -49622,9 +49781,9 @@ const apiSchema = [
|
||||
"default" : "login",
|
||||
"description" : "Run specific command or default to login (requires 'root@pam')",
|
||||
"enum" : [
|
||||
"upgrade",
|
||||
"login",
|
||||
"ceph_install",
|
||||
"login"
|
||||
"upgrade"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
@ -49747,9 +49906,9 @@ const apiSchema = [
|
||||
"default" : "login",
|
||||
"description" : "Run specific command or default to login (requires 'root@pam')",
|
||||
"enum" : [
|
||||
"upgrade",
|
||||
"login",
|
||||
"ceph_install",
|
||||
"login"
|
||||
"upgrade"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
|
||||
@ -825,6 +825,18 @@ API token expiration date (seconds since epoch). '0' means no expiration date.
|
||||
|
||||
Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.
|
||||
|
||||
*pveum user token delete* `<userid> <tokenid>` `[FORMAT_OPTIONS]`
|
||||
|
||||
Remove API token for a specific user.
|
||||
|
||||
`<userid>`: `<string>` ::
|
||||
|
||||
Full User ID, in the `name@realm` format.
|
||||
|
||||
`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
|
||||
|
||||
User-specific token identifier.
|
||||
|
||||
*pveum user token list* `<userid>` `[FORMAT_OPTIONS]`
|
||||
|
||||
Get user API tokens.
|
||||
@ -873,17 +885,9 @@ User-specific token identifier.
|
||||
|
||||
Only dump this specific path, not the whole tree.
|
||||
|
||||
*pveum user token remove* `<userid> <tokenid>` `[FORMAT_OPTIONS]`
|
||||
*pveum user token remove*
|
||||
|
||||
Remove API token for a specific user.
|
||||
|
||||
`<userid>`: `<string>` ::
|
||||
|
||||
Full User ID, in the `name@realm` format.
|
||||
|
||||
`<tokenid>`: `(?^:[A-Za-z][A-Za-z0-9\.\-_]+)` ::
|
||||
|
||||
User-specific token identifier.
|
||||
An alias for 'pveum user token delete'.
|
||||
|
||||
*pveum useradd*
|
||||
|
||||
|
||||
@ -305,7 +305,7 @@ Memory properties.
|
||||
|
||||
`--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
|
||||
|
||||
Set maximum tolerated downtime (in seconds) for migrations.
|
||||
Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge.
|
||||
|
||||
`--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
|
||||
|
||||
@ -902,7 +902,7 @@ Memory properties.
|
||||
|
||||
`--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
|
||||
|
||||
Set maximum tolerated downtime (in seconds) for migrations.
|
||||
Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge.
|
||||
|
||||
`--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
|
||||
|
||||
@ -1486,7 +1486,7 @@ Memory properties.
|
||||
|
||||
`--migrate_downtime` `<number> (0 - N)` ('default =' `0.1`)::
|
||||
|
||||
Set maximum tolerated downtime (in seconds) for migrations.
|
||||
Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge.
|
||||
|
||||
`--migrate_speed` `<integer> (0 - N)` ('default =' `0`)::
|
||||
|
||||
|
||||
@ -547,7 +547,7 @@ Current amount of online RAM for the VM in MiB. This is the maximum available me
|
||||
|
||||
`migrate_downtime`: `<number> (0 - N)` ('default =' `0.1`)::
|
||||
|
||||
Set maximum tolerated downtime (in seconds) for migrations.
|
||||
Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge.
|
||||
|
||||
`migrate_speed`: `<integer> (0 - N)` ('default =' `0`)::
|
||||
|
||||
@ -1190,7 +1190,7 @@ The drive's backing volume.
|
||||
|
||||
Disk size. This is purely informational and has no effect.
|
||||
|
||||
`version`=`<v1.2 | v2.0>` ('default =' `v2.0`);;
|
||||
`version`=`<v1.2 | v2.0>` ('default =' `v1.2`);;
|
||||
|
||||
The TPM interface version. v2.0 is newer and should be preferred. Note that this cannot be changed later on.
|
||||
|
||||
@ -1250,7 +1250,7 @@ Sets the VGA memory (in MiB). Has no effect with serial display.
|
||||
|
||||
`type`=`<cirrus | none | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | virtio-gl | vmware>` ('default =' `std`);;
|
||||
|
||||
Select the VGA type.
|
||||
Select the VGA type. Using type 'cirrus' is not recommended.
|
||||
|
||||
`virtio[n]`: `[file=]<volume> [,aio=<native|threads|io_uring>] [,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>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,ro=<1|0>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>]` ::
|
||||
|
||||
|
||||
@ -40,6 +40,10 @@ Options for backup fleecing (VM only).
|
||||
|
||||
Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.
|
||||
|
||||
`--job-id` `<string>` ::
|
||||
|
||||
The ID of the backup job. If set, the 'backup-job' metadata field of the backup notification will be set to this value. Only root@pam can set this parameter.
|
||||
|
||||
`--lockwait` `<integer> (0 - N)` ('default =' `180`)::
|
||||
|
||||
Maximal time to wait for the global lock (minutes).
|
||||
@ -82,6 +86,10 @@ Deprecated: Do not use
|
||||
|
||||
Deprecated: Do not use
|
||||
|
||||
`--pbs-change-detection-mode` `<data | legacy | metadata>` ::
|
||||
|
||||
PBS mode used to detect file changes and switch encoding. NOTE: `data` and `metadata` modes are experimental. format for container backups.
|
||||
|
||||
`--performance` `[max-workers=<integer>] [,pbs-entries-max=<integer>]` ::
|
||||
|
||||
Other performance-related settings.
|
||||
|
||||
@ -68,6 +68,10 @@ Deprecated: Do not use
|
||||
|
||||
Deprecated: Do not use
|
||||
|
||||
`pbs-change-detection-mode`: `<data | legacy | metadata>` ::
|
||||
|
||||
PBS mode used to detect file changes and switch encoding. NOTE: `data` and `metadata` modes are experimental. format for container backups.
|
||||
|
||||
`performance`: `[max-workers=<integer>] [,pbs-entries-max=<integer>]` ::
|
||||
|
||||
Other performance-related settings.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user