5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-11-12 20:23:45 +03:00

update static/schema information

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
2023-06-21 10:16:15 +02:00
parent 85e53bbf11
commit d7f84e1cc6
3 changed files with 5 additions and 775 deletions

View File

@@ -36618,776 +36618,6 @@ const apiSchema = [
"path" : "/nodes/{node}/ceph/pool",
"text" : "pool"
},
{
"children" : [
{
"info" : {
"DELETE" : {
"allowtoken" : 1,
"description" : "Destroy pool. Deprecated, please use `/nodes/{node}/ceph/pool/{name}`.",
"method" : "DELETE",
"name" : "destroypool",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"force" : {
"default" : 0,
"description" : "If true, destroys pool even if in use",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"name" : {
"description" : "The name of the pool. It must be unique.",
"type" : "string",
"typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
},
"remove_ecprofile" : {
"default" : 1,
"description" : "Remove the erasure code profile. Defaults to true, if applicable.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"remove_storages" : {
"default" : 0,
"description" : "Remove all pveceph-managed storages configured for this pool",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
}
}
},
"permissions" : {
"check" : [
"perm",
"/",
[
"Sys.Modify"
]
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"type" : "string"
}
},
"GET" : {
"allowtoken" : 1,
"description" : "List pool settings. Deprecated, please use `/nodes/{node}/ceph/pool/{pool}/status`.",
"method" : "GET",
"name" : "getpool",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"name" : {
"description" : "The name of the pool. It must be unique.",
"type" : "string",
"typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
},
"verbose" : {
"default" : 0,
"description" : "If enabled, will display additional data(eg. statistics).",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
}
}
},
"permissions" : {
"check" : [
"perm",
"/",
[
"Sys.Audit",
"Datastore.Audit"
],
"any",
1
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"properties" : {
"application" : {
"default" : "rbd",
"description" : "The application of the pool.",
"enum" : [
"rbd",
"cephfs",
"rgw"
],
"optional" : 1,
"title" : "Application",
"type" : "string"
},
"application_list" : {
"optional" : 1,
"title" : "Application",
"type" : "array"
},
"autoscale_status" : {
"optional" : 1,
"title" : "Autoscale Status",
"type" : "object"
},
"crush_rule" : {
"description" : "The rule to use for mapping object placement in the cluster.",
"optional" : 1,
"title" : "Crush Rule Name",
"type" : "string"
},
"fast_read" : {
"title" : "Fast Read",
"type" : "boolean"
},
"hashpspool" : {
"title" : "hashpspool",
"type" : "boolean"
},
"id" : {
"title" : "ID",
"type" : "integer"
},
"min_size" : {
"default" : 2,
"description" : "Minimum number of replicas per object",
"maximum" : 7,
"minimum" : 1,
"optional" : 1,
"title" : "Min Size",
"type" : "integer"
},
"name" : {
"description" : "The name of the pool. It must be unique.",
"title" : "Name",
"type" : "string"
},
"nodeep-scrub" : {
"title" : "nodeep-scrub",
"type" : "boolean"
},
"nodelete" : {
"title" : "nodelete",
"type" : "boolean"
},
"nopgchange" : {
"title" : "nopgchange",
"type" : "boolean"
},
"noscrub" : {
"title" : "noscrub",
"type" : "boolean"
},
"nosizechange" : {
"title" : "nosizechange",
"type" : "boolean"
},
"pg_autoscale_mode" : {
"default" : "warn",
"description" : "The automatic PG scaling mode of the pool.",
"enum" : [
"on",
"off",
"warn"
],
"optional" : 1,
"title" : "PG Autoscale Mode",
"type" : "string"
},
"pg_num" : {
"default" : 128,
"description" : "Number of placement groups.",
"maximum" : 32768,
"minimum" : 1,
"optional" : 1,
"title" : "PG Num",
"type" : "integer"
},
"pg_num_min" : {
"description" : "Minimal number of placement groups.",
"maximum" : 32768,
"optional" : 1,
"title" : "min. PG Num",
"type" : "integer"
},
"pgp_num" : {
"title" : "PGP num",
"type" : "integer"
},
"size" : {
"default" : 3,
"description" : "Number of replicas per object",
"maximum" : 7,
"minimum" : 1,
"optional" : 1,
"title" : "Size",
"type" : "integer"
},
"statistics" : {
"optional" : 1,
"title" : "Statistics",
"type" : "object"
},
"target_size" : {
"description" : "The estimated target size of the pool for the PG autoscaler.",
"optional" : 1,
"pattern" : "^(\\d+(\\.\\d+)?)([KMGT])?$",
"title" : "PG Autoscale Target Size",
"type" : "string"
},
"target_size_ratio" : {
"description" : "The estimated target ratio of the pool for the PG autoscaler.",
"optional" : 1,
"title" : "PG Autoscale Target Ratio",
"type" : "number"
},
"use_gmt_hitset" : {
"title" : "use_gmt_hitset",
"type" : "boolean"
},
"write_fadvise_dontneed" : {
"title" : "write_fadvise_dontneed",
"type" : "boolean"
}
},
"type" : "object"
}
},
"PUT" : {
"allowtoken" : 1,
"description" : "Change POOL settings. Deprecated, please use `/nodes/{node}/ceph/pool/{name}`.",
"method" : "PUT",
"name" : "setpool",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"application" : {
"description" : "The application of the pool.",
"enum" : [
"rbd",
"cephfs",
"rgw"
],
"optional" : 1,
"title" : "Application",
"type" : "string"
},
"crush_rule" : {
"description" : "The rule to use for mapping object placement in the cluster.",
"optional" : 1,
"title" : "Crush Rule Name",
"type" : "string",
"typetext" : "<string>"
},
"min_size" : {
"description" : "Minimum number of replicas per object",
"maximum" : 7,
"minimum" : 1,
"optional" : 1,
"title" : "Min Size",
"type" : "integer",
"typetext" : "<integer> (1 - 7)"
},
"name" : {
"description" : "The name of the pool. It must be unique.",
"title" : "Name",
"type" : "string",
"typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
},
"pg_autoscale_mode" : {
"description" : "The automatic PG scaling mode of the pool.",
"enum" : [
"on",
"off",
"warn"
],
"optional" : 1,
"title" : "PG Autoscale Mode",
"type" : "string"
},
"pg_num" : {
"description" : "Number of placement groups.",
"maximum" : 32768,
"minimum" : 1,
"optional" : 1,
"title" : "PG Num",
"type" : "integer",
"typetext" : "<integer> (1 - 32768)"
},
"pg_num_min" : {
"description" : "Minimal number of placement groups.",
"maximum" : 32768,
"optional" : 1,
"title" : "min. PG Num",
"type" : "integer",
"typetext" : "<integer> (-N - 32768)"
},
"size" : {
"description" : "Number of replicas per object",
"maximum" : 7,
"minimum" : 1,
"optional" : 1,
"title" : "Size",
"type" : "integer",
"typetext" : "<integer> (1 - 7)"
},
"target_size" : {
"description" : "The estimated target size of the pool for the PG autoscaler.",
"optional" : 1,
"pattern" : "^(\\d+(\\.\\d+)?)([KMGT])?$",
"title" : "PG Autoscale Target Size",
"type" : "string"
},
"target_size_ratio" : {
"description" : "The estimated target ratio of the pool for the PG autoscaler.",
"optional" : 1,
"title" : "PG Autoscale Target Ratio",
"type" : "number",
"typetext" : "<number>"
}
}
},
"permissions" : {
"check" : [
"perm",
"/",
[
"Sys.Modify"
]
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"type" : "string"
}
}
},
"leaf" : 1,
"path" : "/nodes/{node}/ceph/pools/{name}",
"text" : "{name}"
}
],
"info" : {
"GET" : {
"allowtoken" : 1,
"description" : "List all pools. Deprecated, please use `/nodes/{node}/ceph/pool`.",
"method" : "GET",
"name" : "lspools",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
}
}
},
"permissions" : {
"check" : [
"perm",
"/",
[
"Sys.Audit",
"Datastore.Audit"
],
"any",
1
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"items" : {
"properties" : {
"application_metadata" : {
"optional" : 1,
"title" : "Associated Applications",
"type" : "object"
},
"autoscale_status" : {
"optional" : 1,
"title" : "Autoscale Status",
"type" : "object"
},
"bytes_used" : {
"title" : "Used",
"type" : "integer"
},
"crush_rule" : {
"title" : "Crush Rule",
"type" : "integer"
},
"crush_rule_name" : {
"title" : "Crush Rule Name",
"type" : "string"
},
"min_size" : {
"title" : "Min Size",
"type" : "integer"
},
"percent_used" : {
"title" : "%-Used",
"type" : "number"
},
"pg_autoscale_mode" : {
"optional" : 1,
"title" : "PG Autoscale Mode",
"type" : "string"
},
"pg_num" : {
"title" : "PG Num",
"type" : "integer"
},
"pg_num_final" : {
"optional" : 1,
"title" : "Optimal PG Num",
"type" : "integer"
},
"pg_num_min" : {
"optional" : 1,
"title" : "min. PG Num",
"type" : "integer"
},
"pool" : {
"title" : "ID",
"type" : "integer"
},
"pool_name" : {
"title" : "Name",
"type" : "string"
},
"size" : {
"title" : "Size",
"type" : "integer"
},
"target_size" : {
"optional" : 1,
"title" : "PG Autoscale Target Size",
"type" : "integer"
},
"target_size_ratio" : {
"optional" : 1,
"title" : "PG Autoscale Target Ratio",
"type" : "number"
},
"type" : {
"enum" : [
"replicated",
"erasure",
"unknown"
],
"title" : "Type",
"type" : "string"
}
},
"type" : "object"
},
"links" : [
{
"href" : "{pool_name}",
"rel" : "child"
}
],
"type" : "array"
}
},
"POST" : {
"allowtoken" : 1,
"description" : "Create Ceph pool. Deprecated, please use `/nodes/{node}/ceph/pool`.",
"method" : "POST",
"name" : "createpool",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"add_storages" : {
"default" : "0; for erasure coded pools: 1",
"description" : "Configure VM and CT storage using the new pool.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"application" : {
"default" : "rbd",
"description" : "The application of the pool.",
"enum" : [
"rbd",
"cephfs",
"rgw"
],
"optional" : 1,
"title" : "Application",
"type" : "string"
},
"crush_rule" : {
"description" : "The rule to use for mapping object placement in the cluster.",
"optional" : 1,
"title" : "Crush Rule Name",
"type" : "string",
"typetext" : "<string>"
},
"erasure-coding" : {
"description" : "Create an erasure coded pool for RBD with an accompaning replicated pool for metadata storage. With EC, the common ceph options 'size', 'min_size' and 'crush_rule' parameters will be applied to the metadata pool.",
"format" : {
"device-class" : {
"description" : "CRUSH device class. Will create an erasure coded pool plus a replicated pool for metadata.",
"format_description" : "class",
"optional" : 1,
"type" : "string"
},
"failure-domain" : {
"default" : "host",
"description" : "CRUSH failure domain. Default is 'host'. Will create an erasure coded pool plus a replicated pool for metadata.",
"format_description" : "domain",
"optional" : 1,
"type" : "string"
},
"k" : {
"description" : "Number of data chunks. Will create an erasure coded pool plus a replicated pool for metadata.",
"minimum" : 2,
"type" : "integer"
},
"m" : {
"description" : "Number of coding chunks. Will create an erasure coded pool plus a replicated pool for metadata.",
"minimum" : 1,
"type" : "integer"
},
"profile" : {
"description" : "Override the erasure code (EC) profile to use. Will create an erasure coded pool plus a replicated pool for metadata.",
"format_description" : "profile",
"optional" : 1,
"type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "k=<integer> ,m=<integer> [,device-class=<class>] [,failure-domain=<domain>] [,profile=<profile>]"
},
"min_size" : {
"default" : 2,
"description" : "Minimum number of replicas per object",
"maximum" : 7,
"minimum" : 1,
"optional" : 1,
"title" : "Min Size",
"type" : "integer",
"typetext" : "<integer> (1 - 7)"
},
"name" : {
"description" : "The name of the pool. It must be unique.",
"title" : "Name",
"type" : "string",
"typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
},
"pg_autoscale_mode" : {
"default" : "warn",
"description" : "The automatic PG scaling mode of the pool.",
"enum" : [
"on",
"off",
"warn"
],
"optional" : 1,
"title" : "PG Autoscale Mode",
"type" : "string"
},
"pg_num" : {
"default" : 128,
"description" : "Number of placement groups.",
"maximum" : 32768,
"minimum" : 1,
"optional" : 1,
"title" : "PG Num",
"type" : "integer",
"typetext" : "<integer> (1 - 32768)"
},
"pg_num_min" : {
"description" : "Minimal number of placement groups.",
"maximum" : 32768,
"optional" : 1,
"title" : "min. PG Num",
"type" : "integer",
"typetext" : "<integer> (-N - 32768)"
},
"size" : {
"default" : 3,
"description" : "Number of replicas per object",
"maximum" : 7,
"minimum" : 1,
"optional" : 1,
"title" : "Size",
"type" : "integer",
"typetext" : "<integer> (1 - 7)"
},
"target_size" : {
"description" : "The estimated target size of the pool for the PG autoscaler.",
"optional" : 1,
"pattern" : "^(\\d+(\\.\\d+)?)([KMGT])?$",
"title" : "PG Autoscale Target Size",
"type" : "string"
},
"target_size_ratio" : {
"description" : "The estimated target ratio of the pool for the PG autoscaler.",
"optional" : 1,
"title" : "PG Autoscale Target Ratio",
"type" : "number",
"typetext" : "<number>"
}
}
},
"permissions" : {
"check" : [
"perm",
"/",
[
"Sys.Modify"
]
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"type" : "string"
}
}
},
"leaf" : 0,
"path" : "/nodes/{node}/ceph/pools",
"text" : "pools"
},
{
"info" : {
"GET" : {
"allowtoken" : 1,
"description" : "Get the Ceph configuration file. Deprecated, please use `/nodes/{node}/ceph/cfg/raw.",
"method" : "GET",
"name" : "config",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
}
}
},
"permissions" : {
"check" : [
"perm",
"/",
[
"Sys.Audit",
"Datastore.Audit"
],
"any",
1
]
},
"proxyto" : "node",
"returns" : {
"type" : "string"
}
}
},
"leaf" : 1,
"path" : "/nodes/{node}/ceph/config",
"text" : "config"
},
{
"info" : {
"GET" : {
"allowtoken" : 1,
"description" : "Get the Ceph configuration database. Deprecated, please use `/nodes/{node}/ceph/cfg/db.",
"method" : "GET",
"name" : "configdb",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
}
}
},
"permissions" : {
"check" : [
"perm",
"/",
[
"Sys.Audit",
"Datastore.Audit"
],
"any",
1
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"items" : {
"properties" : {
"can_update_at_runtime" : {
"type" : "boolean"
},
"level" : {
"type" : "string"
},
"mask" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"section" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
}
}
},
"leaf" : 1,
"path" : "/nodes/{node}/ceph/configdb",
"text" : "configdb"
},
{
"info" : {
"POST" : {
@@ -47048,8 +46278,8 @@ const apiSchema = [
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
"upgrade",
"ceph_install",
"upgrade",
"login"
],
"optional" : 1,
@@ -47144,8 +46374,8 @@ const apiSchema = [
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
"upgrade",
"ceph_install",
"upgrade",
"login"
],
"optional" : 1,
@@ -47270,8 +46500,8 @@ const apiSchema = [
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
"upgrade",
"ceph_install",
"upgrade",
"login"
],
"optional" : 1,