mirror of
git://git.proxmox.com/git/pve-docs.git
synced 2025-03-19 18:50:06 +03:00
update static information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
parent
42449bdff9
commit
ac70d7d134
@ -4420,6 +4420,7 @@ var pveapi = [
|
||||
"da",
|
||||
"ddnss",
|
||||
"desec",
|
||||
"df",
|
||||
"dgon",
|
||||
"dnsimple",
|
||||
"do",
|
||||
@ -4656,6 +4657,7 @@ var pveapi = [
|
||||
"da",
|
||||
"ddnss",
|
||||
"desec",
|
||||
"df",
|
||||
"dgon",
|
||||
"dnsimple",
|
||||
"do",
|
||||
@ -5058,6 +5060,47 @@ var pveapi = [
|
||||
"leaf" : 1,
|
||||
"path" : "/cluster/acme/directories",
|
||||
"text" : "directories"
|
||||
},
|
||||
{
|
||||
"info" : {
|
||||
"GET" : {
|
||||
"allowtoken" : 1,
|
||||
"description" : "Get schema of ACME challenge types.",
|
||||
"method" : "GET",
|
||||
"name" : "challengeschema",
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0
|
||||
},
|
||||
"permissions" : {
|
||||
"user" : "all"
|
||||
},
|
||||
"returns" : {
|
||||
"items" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"id" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"name" : {
|
||||
"description" : "Human readable name, falls back to id",
|
||||
"type" : "string"
|
||||
},
|
||||
"schema" : {
|
||||
"type" : "object"
|
||||
},
|
||||
"type" : {
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
},
|
||||
"type" : "array"
|
||||
}
|
||||
}
|
||||
},
|
||||
"leaf" : 1,
|
||||
"path" : "/cluster/acme/challenge-schema",
|
||||
"text" : "challenge-schema"
|
||||
}
|
||||
],
|
||||
"info" : {
|
||||
@ -5565,6 +5608,12 @@ var pveapi = [
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer>"
|
||||
},
|
||||
"vlanaware" : {
|
||||
"description" : "Allow vm VLANs to pass through this vnet.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"vnet" : {
|
||||
"description" : "The SDN vnet object identifier.",
|
||||
"format" : "pve-sdn-vnet-id",
|
||||
@ -5664,7 +5713,7 @@ var pveapi = [
|
||||
},
|
||||
"tag" : {
|
||||
"description" : "vlan or vxlan id",
|
||||
"optional" : 0,
|
||||
"optional" : 1,
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer>"
|
||||
},
|
||||
@ -5676,6 +5725,12 @@ var pveapi = [
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"vlanaware" : {
|
||||
"description" : "Allow vm VLANs to pass through this vnet.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"vnet" : {
|
||||
"description" : "The SDN vnet object identifier.",
|
||||
"format" : "pve-sdn-vnet-id",
|
||||
@ -5814,7 +5869,7 @@ var pveapi = [
|
||||
"typetext" : "<integer>"
|
||||
},
|
||||
"mtu" : {
|
||||
"description" : "mtu",
|
||||
"description" : "MTU",
|
||||
"optional" : 1,
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer>"
|
||||
@ -5834,10 +5889,20 @@ var pveapi = [
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"tag" : {
|
||||
"description" : "vlan tag",
|
||||
"description" : "Service-VLAN Tag",
|
||||
"minimum" : 0,
|
||||
"optional" : 1,
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer>"
|
||||
"typetext" : "<integer> (0 - N)"
|
||||
},
|
||||
"vlan-protocol" : {
|
||||
"default" : "802.1q",
|
||||
"enum" : [
|
||||
"802.1q",
|
||||
"802.1ad"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"vrf-vxlan" : {
|
||||
"description" : "l3vni.",
|
||||
@ -5889,6 +5954,7 @@ var pveapi = [
|
||||
"evpn",
|
||||
"faucet",
|
||||
"qinq",
|
||||
"simple",
|
||||
"vlan",
|
||||
"vxlan"
|
||||
],
|
||||
@ -5948,7 +6014,7 @@ var pveapi = [
|
||||
"typetext" : "<integer>"
|
||||
},
|
||||
"mtu" : {
|
||||
"description" : "mtu",
|
||||
"description" : "MTU",
|
||||
"optional" : 1,
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer>"
|
||||
@ -5968,10 +6034,11 @@ var pveapi = [
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"tag" : {
|
||||
"description" : "vlan tag",
|
||||
"description" : "Service-VLAN Tag",
|
||||
"minimum" : 0,
|
||||
"optional" : 1,
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer>"
|
||||
"typetext" : "<integer> (0 - N)"
|
||||
},
|
||||
"type" : {
|
||||
"description" : "Plugin type.",
|
||||
@ -5979,12 +6046,22 @@ var pveapi = [
|
||||
"evpn",
|
||||
"faucet",
|
||||
"qinq",
|
||||
"simple",
|
||||
"vlan",
|
||||
"vxlan"
|
||||
],
|
||||
"format" : "pve-configid",
|
||||
"type" : "string"
|
||||
},
|
||||
"vlan-protocol" : {
|
||||
"default" : "802.1q",
|
||||
"enum" : [
|
||||
"802.1q",
|
||||
"802.1ad"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"vrf-vxlan" : {
|
||||
"description" : "l3vni.",
|
||||
"optional" : 1,
|
||||
@ -11135,6 +11212,13 @@ var pveapi = [
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"mtu" : {
|
||||
"description" : "Force MTU, for VirtIO only. Set to '1' to use the bridge MTU",
|
||||
"maximum" : 65520,
|
||||
"minimum" : 1,
|
||||
"optional" : 1,
|
||||
"type" : "integer"
|
||||
},
|
||||
"ne2k_isa" : {
|
||||
"alias" : "macaddr",
|
||||
"keyAlias" : "model"
|
||||
@ -12782,7 +12866,7 @@ var pveapi = [
|
||||
"format" : "pve-qm-hostpci",
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]",
|
||||
"typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]",
|
||||
"verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer\npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
|
||||
},
|
||||
"hotplug" : {
|
||||
@ -13338,6 +13422,13 @@ var pveapi = [
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"mtu" : {
|
||||
"description" : "Force MTU, for VirtIO only. Set to '1' to use the bridge MTU",
|
||||
"maximum" : 65520,
|
||||
"minimum" : 1,
|
||||
"optional" : 1,
|
||||
"type" : "integer"
|
||||
},
|
||||
"ne2k_isa" : {
|
||||
"alias" : "macaddr",
|
||||
"keyAlias" : "model"
|
||||
@ -13392,7 +13483,7 @@ var pveapi = [
|
||||
},
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
|
||||
"typetext" : "[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>]"
|
||||
},
|
||||
"node" : {
|
||||
"description" : "The cluster node name.",
|
||||
@ -14760,7 +14851,8 @@ var pveapi = [
|
||||
"VM.Config.Memory",
|
||||
"VM.Config.Network",
|
||||
"VM.Config.HWType",
|
||||
"VM.Config.Options"
|
||||
"VM.Config.Options",
|
||||
"VM.Config.Cloudinit"
|
||||
],
|
||||
"any",
|
||||
1
|
||||
@ -15052,7 +15144,7 @@ var pveapi = [
|
||||
"format" : "pve-qm-hostpci",
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]",
|
||||
"typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]",
|
||||
"verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer\npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
|
||||
},
|
||||
"hotplug" : {
|
||||
@ -15608,6 +15700,13 @@ var pveapi = [
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"mtu" : {
|
||||
"description" : "Force MTU, for VirtIO only. Set to '1' to use the bridge MTU",
|
||||
"maximum" : 65520,
|
||||
"minimum" : 1,
|
||||
"optional" : 1,
|
||||
"type" : "integer"
|
||||
},
|
||||
"ne2k_isa" : {
|
||||
"alias" : "macaddr",
|
||||
"keyAlias" : "model"
|
||||
@ -15662,7 +15761,7 @@ var pveapi = [
|
||||
},
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
|
||||
"typetext" : "[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>]"
|
||||
},
|
||||
"node" : {
|
||||
"description" : "The cluster node name.",
|
||||
@ -17030,7 +17129,8 @@ var pveapi = [
|
||||
"VM.Config.Memory",
|
||||
"VM.Config.Network",
|
||||
"VM.Config.HWType",
|
||||
"VM.Config.Options"
|
||||
"VM.Config.Options",
|
||||
"VM.Config.Cloudinit"
|
||||
],
|
||||
"any",
|
||||
1
|
||||
@ -17184,6 +17284,13 @@ var pveapi = [
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"generate-password" : {
|
||||
"default" : 0,
|
||||
"description" : "Generates a random password to be used as ticket instead of the API ticket.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"node" : {
|
||||
"description" : "The cluster node name.",
|
||||
"format" : "pve-node",
|
||||
@ -17221,6 +17328,11 @@ var pveapi = [
|
||||
"cert" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"password" : {
|
||||
"description" : "Returned if requested with 'generate-password' param. Consists of printable ASCII characters ('!' .. '~').",
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"port" : {
|
||||
"type" : "integer"
|
||||
},
|
||||
@ -19944,7 +20056,7 @@ var pveapi = [
|
||||
"format" : "pve-qm-hostpci",
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]",
|
||||
"typetext" : "[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]",
|
||||
"verbose_description" : "Map host PCI devices into guest.\n\nNOTE: This option allows direct access to host hardware. So it is no longer\npossible to migrate such machines - use with special care.\n\nCAUTION: Experimental! User reported problems with this option.\n"
|
||||
},
|
||||
"hotplug" : {
|
||||
@ -20500,6 +20612,13 @@ var pveapi = [
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"mtu" : {
|
||||
"description" : "Force MTU, for VirtIO only. Set to '1' to use the bridge MTU",
|
||||
"maximum" : 65520,
|
||||
"minimum" : 1,
|
||||
"optional" : 1,
|
||||
"type" : "integer"
|
||||
},
|
||||
"ne2k_isa" : {
|
||||
"alias" : "macaddr",
|
||||
"keyAlias" : "model"
|
||||
@ -20554,7 +20673,7 @@ var pveapi = [
|
||||
},
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "[model=]<enum> [,bridge=<bridge>] [,firewall=<1|0>] [,link_down=<1|0>] [,macaddr=<XX:XX:XX:XX:XX:XX>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]"
|
||||
"typetext" : "[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>]"
|
||||
},
|
||||
"node" : {
|
||||
"description" : "The cluster node name.",
|
||||
@ -21941,6 +22060,60 @@ var pveapi = [
|
||||
"path" : "/nodes/{node}/qemu",
|
||||
"text" : "qemu"
|
||||
},
|
||||
{
|
||||
"info" : {
|
||||
"GET" : {
|
||||
"allowtoken" : 1,
|
||||
"description" : "List all custom and default CPU models.",
|
||||
"method" : "GET",
|
||||
"name" : "index",
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"node" : {
|
||||
"description" : "The cluster node name.",
|
||||
"format" : "pve-node",
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"permissions" : {
|
||||
"description" : "Only returns custom models when the current user has Sys.Audit on /nodes.",
|
||||
"user" : "all"
|
||||
},
|
||||
"returns" : {
|
||||
"items" : {
|
||||
"properties" : {
|
||||
"custom" : {
|
||||
"description" : "True if this is a custom CPU model.",
|
||||
"type" : "boolean"
|
||||
},
|
||||
"name" : {
|
||||
"description" : "Name of the CPU model. Identifies it for subsequent API calls. Prefixed with 'custom-' for custom models.",
|
||||
"type" : "string"
|
||||
},
|
||||
"vendor" : {
|
||||
"description" : "CPU vendor visible to the guest when this model is selected. Vendor of 'reported-model' in case of custom models.",
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
},
|
||||
"links" : [
|
||||
{
|
||||
"href" : "{name}",
|
||||
"rel" : "child"
|
||||
}
|
||||
],
|
||||
"type" : "array"
|
||||
}
|
||||
}
|
||||
},
|
||||
"leaf" : 1,
|
||||
"path" : "/nodes/{node}/cpu",
|
||||
"text" : "cpu"
|
||||
},
|
||||
{
|
||||
"children" : [
|
||||
{
|
||||
@ -29394,13 +29567,45 @@ var pveapi = [
|
||||
"returns" : {
|
||||
"items" : {
|
||||
"properties" : {
|
||||
"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"
|
||||
},
|
||||
"pool" : {
|
||||
"title" : "ID",
|
||||
"type" : "integer"
|
||||
},
|
||||
"pool_name" : {
|
||||
"title" : "Name",
|
||||
"type" : "string"
|
||||
},
|
||||
"size" : {
|
||||
"title" : "Size",
|
||||
"type" : "integer"
|
||||
}
|
||||
},
|
||||
@ -30549,6 +30754,37 @@ var pveapi = [
|
||||
},
|
||||
{
|
||||
"info" : {
|
||||
"DELETE" : {
|
||||
"allowtoken" : 1,
|
||||
"description" : "Delete subscription key of this node.",
|
||||
"method" : "DELETE",
|
||||
"name" : "delete",
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"node" : {
|
||||
"description" : "The cluster node name.",
|
||||
"format" : "pve-node",
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"permissions" : {
|
||||
"check" : [
|
||||
"perm",
|
||||
"/nodes/{node}",
|
||||
[
|
||||
"Sys.Modify"
|
||||
]
|
||||
]
|
||||
},
|
||||
"protected" : 1,
|
||||
"proxyto" : "node",
|
||||
"returns" : {
|
||||
"type" : "null"
|
||||
}
|
||||
},
|
||||
"GET" : {
|
||||
"allowtoken" : 1,
|
||||
"description" : "Read subscription info.",
|
||||
@ -35655,6 +35891,15 @@ var pveapi = [
|
||||
}
|
||||
}
|
||||
},
|
||||
"permissions" : {
|
||||
"check" : [
|
||||
"perm",
|
||||
"/nodes/{node}",
|
||||
[
|
||||
"Sys.Modify"
|
||||
]
|
||||
]
|
||||
},
|
||||
"protected" : 1,
|
||||
"proxyto" : "node",
|
||||
"returns" : {
|
||||
@ -35684,6 +35929,15 @@ var pveapi = [
|
||||
}
|
||||
}
|
||||
},
|
||||
"permissions" : {
|
||||
"check" : [
|
||||
"perm",
|
||||
"/nodes/{node}",
|
||||
[
|
||||
"Sys.Modify"
|
||||
]
|
||||
]
|
||||
},
|
||||
"protected" : 1,
|
||||
"proxyto" : "node",
|
||||
"returns" : {
|
||||
@ -35713,6 +35967,15 @@ var pveapi = [
|
||||
}
|
||||
}
|
||||
},
|
||||
"permissions" : {
|
||||
"check" : [
|
||||
"perm",
|
||||
"/nodes/{node}",
|
||||
[
|
||||
"Sys.Modify"
|
||||
]
|
||||
]
|
||||
},
|
||||
"protected" : 1,
|
||||
"proxyto" : "node",
|
||||
"returns" : {
|
||||
@ -35882,6 +36145,15 @@ var pveapi = [
|
||||
}
|
||||
}
|
||||
},
|
||||
"permissions" : {
|
||||
"check" : [
|
||||
"perm",
|
||||
"/nodes/{node}",
|
||||
[
|
||||
"Sys.Modify"
|
||||
]
|
||||
]
|
||||
},
|
||||
"protected" : 1,
|
||||
"proxyto" : "node",
|
||||
"returns" : {
|
||||
@ -35931,6 +36203,15 @@ var pveapi = [
|
||||
}
|
||||
}
|
||||
},
|
||||
"permissions" : {
|
||||
"check" : [
|
||||
"perm",
|
||||
"/nodes/{node}",
|
||||
[
|
||||
"Sys.Modify"
|
||||
]
|
||||
]
|
||||
},
|
||||
"protected" : 1,
|
||||
"proxyto" : "node",
|
||||
"returns" : {
|
||||
@ -36127,7 +36408,7 @@ var pveapi = [
|
||||
"format" : {
|
||||
"alias" : {
|
||||
"description" : "Alias for the Domain to verify ACME Challenge over DNS",
|
||||
"format" : "pve-acme-domain",
|
||||
"format" : "pve-acme-alias",
|
||||
"format_description" : "domain",
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
@ -36380,6 +36661,11 @@ var pveapi = [
|
||||
"properties" : {
|
||||
"status" : {
|
||||
"description" : "Status of zone",
|
||||
"enum" : [
|
||||
"available",
|
||||
"pending",
|
||||
"error"
|
||||
],
|
||||
"type" : "string"
|
||||
},
|
||||
"zone" : {
|
||||
@ -36987,9 +37273,9 @@ var pveapi = [
|
||||
"default" : "login",
|
||||
"description" : "Run specific command or default to login.",
|
||||
"enum" : [
|
||||
"upgrade",
|
||||
"login",
|
||||
"ceph_install",
|
||||
"login"
|
||||
"upgrade"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
@ -37082,9 +37368,9 @@ var pveapi = [
|
||||
"default" : "login",
|
||||
"description" : "Run specific command or default to login.",
|
||||
"enum" : [
|
||||
"upgrade",
|
||||
"login",
|
||||
"ceph_install",
|
||||
"login"
|
||||
"upgrade"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
@ -37207,9 +37493,9 @@ var pveapi = [
|
||||
"default" : "login",
|
||||
"description" : "Run specific command or default to login.",
|
||||
"enum" : [
|
||||
"upgrade",
|
||||
"login",
|
||||
"ceph_install",
|
||||
"login"
|
||||
"upgrade"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
@ -40034,6 +40320,10 @@ var pveapi = [
|
||||
"optional" : 1,
|
||||
"type" : "boolean"
|
||||
},
|
||||
"VM.Config.Cloudinit" : {
|
||||
"optional" : 1,
|
||||
"type" : "boolean"
|
||||
},
|
||||
"VM.Config.Disk" : {
|
||||
"optional" : 1,
|
||||
"type" : "boolean"
|
||||
|
||||
@ -98,7 +98,11 @@ Targeted number of replicas per object
|
||||
|
||||
Install ceph related packages.
|
||||
|
||||
`--version` `<luminous | nautilus>` ('default =' `nautilus`)::
|
||||
`--allow-experimental` `<boolean>` ('default =' `0`)::
|
||||
|
||||
Allow experimental versions. Use with care!
|
||||
|
||||
`--version` `<luminous | nautilus | octopus>` ('default =' `nautilus`)::
|
||||
|
||||
Ceph version to install.
|
||||
|
||||
@ -254,14 +258,22 @@ If true, destroys pool even if in use
|
||||
|
||||
Remove all pveceph-managed storages configured for this pool
|
||||
|
||||
*pveceph pool ls*
|
||||
*pveceph pool ls* `[FORMAT_OPTIONS]`
|
||||
|
||||
List all pools.
|
||||
|
||||
*pveceph purge*
|
||||
*pveceph purge* `[OPTIONS]`
|
||||
|
||||
Destroy ceph related data and configuration files.
|
||||
|
||||
`--crash` `<boolean>` ::
|
||||
|
||||
Additionally purge Ceph crash logs, /var/lib/ceph/crash.
|
||||
|
||||
`--logs` `<boolean>` ::
|
||||
|
||||
Additionally purge Ceph logs, /var/log/ceph.
|
||||
|
||||
*pveceph start* `[OPTIONS]`
|
||||
|
||||
Start ceph services.
|
||||
|
||||
@ -81,7 +81,7 @@ ACME challenge type.
|
||||
|
||||
ACME Plugin ID name
|
||||
|
||||
`--api` `<acmedns | acmeproxy | active24 | ad | ali | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hexonet | hostingde | infoblox | internetbs | inwx | ispconfig | jd | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | nic | nsd | nsone | nsupdate | nw | one | online | openprovider | opnsense | ovh | pdns | pleskxml | pointhq | rackspace | rcode0 | regru | schlundtech | selectel | servercow | tele3 | ultra | unoeuro | variomedia | vscale | vultr | yandex | zilore | zone | zonomi>` ::
|
||||
`--api` `<acmedns | acmeproxy | active24 | ad | ali | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hexonet | hostingde | infoblox | internetbs | inwx | ispconfig | jd | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | nic | nsd | nsone | nsupdate | nw | one | online | openprovider | opnsense | ovh | pdns | pleskxml | pointhq | rackspace | rcode0 | regru | schlundtech | selectel | servercow | tele3 | ultra | unoeuro | variomedia | vscale | vultr | yandex | zilore | zone | zonomi>` ::
|
||||
|
||||
API plugin name
|
||||
|
||||
@ -133,7 +133,7 @@ Update ACME plugin configuration.
|
||||
|
||||
ACME Plugin ID name
|
||||
|
||||
`--api` `<acmedns | acmeproxy | active24 | ad | ali | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hexonet | hostingde | infoblox | internetbs | inwx | ispconfig | jd | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | nic | nsd | nsone | nsupdate | nw | one | online | openprovider | opnsense | ovh | pdns | pleskxml | pointhq | rackspace | rcode0 | regru | schlundtech | selectel | servercow | tele3 | ultra | unoeuro | variomedia | vscale | vultr | yandex | zilore | zone | zonomi>` ::
|
||||
`--api` `<acmedns | acmeproxy | active24 | ad | ali | autodns | aws | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hexonet | hostingde | infoblox | internetbs | inwx | ispconfig | jd | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | nic | nsd | nsone | nsupdate | nw | one | online | openprovider | opnsense | ovh | pdns | pleskxml | pointhq | rackspace | rcode0 | regru | schlundtech | selectel | servercow | tele3 | ultra | unoeuro | variomedia | vscale | vultr | yandex | zilore | zone | zonomi>` ::
|
||||
|
||||
API plugin name
|
||||
|
||||
|
||||
@ -1,5 +1,9 @@
|
||||
*pvesubscription* `<COMMAND> [ARGS] [OPTIONS]`
|
||||
|
||||
*pvesubscription delete*
|
||||
|
||||
Delete subscription key of this node.
|
||||
|
||||
*pvesubscription get*
|
||||
|
||||
Read subscription info.
|
||||
|
||||
@ -618,6 +618,30 @@ User ID or full API token ID
|
||||
|
||||
Only dump this specific path, not the whole tree.
|
||||
|
||||
*pveum user tfa delete* `<userid>` `[OPTIONS]`
|
||||
|
||||
Change user u2f authentication.
|
||||
|
||||
`<userid>`: `<string>` ::
|
||||
|
||||
User ID
|
||||
|
||||
`--config` `type=<TFATYPE> [,digits=<COUNT>] [,id=<ID>] [,key=<KEY>] [,step=<SECONDS>] [,url=<URL>]` ::
|
||||
|
||||
A TFA configuration. This must currently be of type TOTP of not set at all.
|
||||
|
||||
`--key` `<string>` ::
|
||||
|
||||
When adding TOTP, the shared secret value.
|
||||
|
||||
`--password` `<string>` ::
|
||||
|
||||
The current password.
|
||||
|
||||
`--response` `<string>` ::
|
||||
|
||||
Either the the response to the current u2f registration challenge, or, when adding TOTP, the currently valid TOTP value.
|
||||
|
||||
*pveum user token add* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
|
||||
|
||||
Generate a new API token for a specific user. NOTE: returns API token
|
||||
|
||||
@ -33,6 +33,7 @@ Specify IP addresses and gateways for the corresponding interface.
|
||||
IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.
|
||||
+
|
||||
The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
|
||||
For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
|
||||
+
|
||||
If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
|
||||
|
||||
|
||||
@ -213,7 +213,7 @@ Freeze CPU at startup (use 'c' monitor command to start execution).
|
||||
|
||||
Script that will be executed during various steps in the vms lifetime.
|
||||
|
||||
`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
|
||||
`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
|
||||
|
||||
Map host PCI devices into guest.
|
||||
|
||||
@ -284,7 +284,7 @@ Set a name for the VM. Only used on the configuration web interface.
|
||||
|
||||
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>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
|
||||
`--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>]` ::
|
||||
|
||||
Specify network devices.
|
||||
|
||||
@ -928,7 +928,7 @@ Freeze CPU at startup (use 'c' monitor command to start execution).
|
||||
|
||||
Script that will be executed during various steps in the vms lifetime.
|
||||
|
||||
`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
|
||||
`--hostpci[n]` `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
|
||||
|
||||
Map host PCI devices into guest.
|
||||
|
||||
@ -999,7 +999,7 @@ Set a name for the VM. Only used on the configuration web interface.
|
||||
|
||||
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>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
|
||||
`--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>]` ::
|
||||
|
||||
Specify network devices.
|
||||
|
||||
|
||||
@ -140,7 +140,7 @@ Freeze CPU at startup (use 'c' monitor command to start execution).
|
||||
|
||||
Script that will be executed during various steps in the vms lifetime.
|
||||
|
||||
`hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
|
||||
`hostpci[n]`: `[host=]<HOSTPCIID[;HOSTPCIID2...]> [,legacy-igd=<1|0>] [,mdev=<string>] [,pcie=<1|0>] [,rombar=<1|0>] [,romfile=<string>] [,x-vga=<1|0>]` ::
|
||||
|
||||
Map host PCI devices into guest.
|
||||
+
|
||||
@ -158,6 +158,10 @@ of PCI virtual functions of the host. HOSTPCIID syntax is:
|
||||
+
|
||||
You can us the 'lspci' command to list existing PCI devices.
|
||||
|
||||
`legacy-igd`=`<boolean>` ('default =' `0`);;
|
||||
|
||||
Pass this device in legacy IGD mode, making it the primary and exclusive graphics device in the VM. Requires 'pc-i440fx' machine type and VGA set to 'none'.
|
||||
|
||||
`mdev`=`<string>` ;;
|
||||
|
||||
The type of mediated device to use.
|
||||
@ -449,7 +453,7 @@ Set a name for the VM. Only used on the configuration web interface.
|
||||
|
||||
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>] [,queues=<integer>] [,rate=<number>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,<model>=<macaddr>]` ::
|
||||
`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>]` ::
|
||||
|
||||
Specify network devices.
|
||||
|
||||
@ -484,6 +488,10 @@ A common MAC address with the I/G (Individual/Group) bit not set.
|
||||
|
||||
Network Card Model. The 'virtio' model provides the best performance with very low CPU overhead. If your guest does not support this driver, it is usually best to use 'e1000'.
|
||||
|
||||
`mtu`=`<integer> (1 - 65520)` ;;
|
||||
|
||||
Force MTU, for VirtIO only. Set to '1' to use the bridge MTU
|
||||
|
||||
`queues`=`<integer> (0 - 16)` ;;
|
||||
|
||||
Number of packet queues to be used on the device.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user