Browse Source

run make update-static

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
stable-5
Thomas Lamprecht 10 months ago
parent
commit
5f26e15b39
10 changed files with 616 additions and 295 deletions
  1. +529
    -284
      api-viewer/apidata.js
  2. +8
    -0
      datacenter.cfg.5-opts.adoc
  3. +2
    -2
      output-format-opts.adoc
  4. +17
    -1
      pct.1-synopsis.adoc
  5. +4
    -0
      pct.conf.5-opts.adoc
  6. +4
    -0
      pve-firewall-host-opts.adoc
  7. +20
    -0
      pvenode.1-synopsis.adoc
  8. +1
    -1
      pvesubscription.1-synopsis.adoc
  9. +20
    -4
      qm.1-synopsis.adoc
  10. +11
    -3
      qm.conf.5-opts.adoc

+ 529
- 284
api-viewer/apidata.js View File

@@ -823,7 +823,7 @@ var pveapi = [
},
"macro" : {
"optional" : 1,
"type" : "integer"
"type" : "string"
},
"pos" : {
"type" : "integer"
@@ -1399,7 +1399,7 @@ var pveapi = [
},
"macro" : {
"optional" : 1,
"type" : "integer"
"type" : "string"
},
"pos" : {
"type" : "integer"
@@ -3316,7 +3316,58 @@ var pveapi = [
]
]
},
"returns" : {}
"returns" : {
"properties" : {
"comment" : {
"description" : "Description.",
"optional" : 1,
"type" : "string"
},
"digest" : {
"description" : "Can be used to prevent concurrent modifications.",
"type" : "string"
},
"group" : {
"description" : "The HA group identifier.",
"format" : "pve-configid",
"optional" : 1,
"type" : "string"
},
"max_relocate" : {
"description" : "Maximal number of service relocate tries when a service failes to start.",
"optional" : 1,
"type" : "integer"
},
"max_restart" : {
"description" : "Maximal number of tries to restart the service on a node after its start failed.",
"optional" : 1,
"type" : "integer"
},
"sid" : {
"description" : "HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).",
"format" : "pve-ha-resource-or-vm-id",
"type" : "string",
"typetext" : "<type>:<name>"
},
"state" : {
"description" : "Requested resource state.",
"enum" : [
"started",
"stopped",
"enabled",
"disabled",
"ignored"
],
"optional" : 1,
"type" : "string"
},
"type" : {
"description" : "The type of the resources.",
"type" : "string"
}
},
"type" : "object"
}
},
"PUT" : {
"description" : "Update resource configuration.",
@@ -4499,6 +4550,25 @@ var pveapi = [
"optional" : 1,
"type" : "string"
},
"ha" : {
"description" : "Cluster wide HA settings.",
"format" : {
"shutdown_policy" : {
"default" : "conditional",
"description" : "The policy for HA services on node shutdown. 'freeze' disables auto-recovery, 'failover' ensures recovery, 'conditional' recovers on poweroff and freezes on reboot. Running HA Services will always get stopped first on shutdown.",
"enum" : [
"freeze",
"failover",
"conditional"
],
"type" : "string",
"verbose_description" : "Describes the policy for handling HA services on poweroff or reboot of a node. Freeze will always freeze services which are still located on the node on shutdown, those services won't be recovered by the HA manager. Failover will not mark the services as frozen and thus the services will get recovered to other nodes, if the shutdown node does not come up again quickly (< 1min). 'conditional' chooses automatically depending on the type of shutdown, i.e., on a reboot the service will be frozen but on a poweroff the service will stay as is, and thus get recovered after about 2 minutes."
}
},
"optional" : 1,
"type" : "string",
"typetext" : "shutdown_policy=<freeze|failover|conditional>"
},
"http_proxy" : {
"description" : "Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')",
"optional" : 1,
@@ -4862,7 +4932,7 @@ var pveapi = [
},
"macro" : {
"optional" : 1,
"type" : "integer"
"type" : "string"
},
"pos" : {
"type" : "integer"
@@ -7964,6 +8034,14 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"snapshot" : {
"description" : "Fetch config values from given snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
@@ -8161,6 +8239,13 @@ var pveapi = [
"description" : "Do not identify as a KVM virtual machine.",
"optional" : 1,
"type" : "boolean"
},
"hv-vendor-id" : {
"description" : "The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.",
"format_description" : "vendor-id",
"optional" : 1,
"pattern" : "(?^:[a-zA-Z0-9]{1,12})",
"type" : "string"
}
},
"optional" : 1,
@@ -8236,6 +8321,12 @@ var pveapi = [
"optional" : 1,
"type" : "boolean"
},
"hookscript" : {
"description" : "Script that will be executed during various steps in the vms lifetime.",
"format" : "pve-volume-id",
"optional" : 1,
"type" : "string"
},
"hostpci[n]" : {
"description" : "Map host PCI devices into guest.",
"format" : "pve-qm-hostpci",
@@ -8630,10 +8721,13 @@ var pveapi = [
"lock" : {
"description" : "Lock/unlock the VM.",
"enum" : [
"migrate",
"backup",
"clone",
"create",
"migrate",
"rollback",
"snapshot",
"rollback"
"snapshot-delete"
],
"optional" : 1,
"type" : "string"
@@ -9676,6 +9770,7 @@ var pveapi = [
"qxl2",
"qxl3",
"qxl4",
"none",
"serial0",
"serial1",
"serial2",
@@ -10225,11 +10320,18 @@ var pveapi = [
"description" : "Do not identify as a KVM virtual machine.",
"optional" : 1,
"type" : "boolean"
},
"hv-vendor-id" : {
"description" : "The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.",
"format_description" : "vendor-id",
"optional" : 1,
"pattern" : "(?^:[a-zA-Z0-9]{1,12})",
"type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]"
"typetext" : "[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]"
},
"cpulimit" : {
"default" : 0,
@@ -10323,6 +10425,13 @@ var pveapi = [
"type" : "boolean",
"typetext" : "<boolean>"
},
"hookscript" : {
"description" : "Script that will be executed during various steps in the vms lifetime.",
"format" : "pve-volume-id",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"hostpci[n]" : {
"description" : "Map host PCI devices into guest.",
"format" : "pve-qm-hostpci",
@@ -10723,10 +10832,13 @@ var pveapi = [
"lock" : {
"description" : "Lock/unlock the VM.",
"enum" : [
"migrate",
"backup",
"clone",
"create",
"migrate",
"rollback",
"snapshot",
"rollback"
"snapshot-delete"
],
"optional" : 1,
"type" : "string"
@@ -11813,6 +11925,7 @@ var pveapi = [
"qxl2",
"qxl3",
"qxl4",
"none",
"serial0",
"serial1",
"serial2",
@@ -12387,11 +12500,18 @@ var pveapi = [
"description" : "Do not identify as a KVM virtual machine.",
"optional" : 1,
"type" : "boolean"
},
"hv-vendor-id" : {
"description" : "The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.",
"format_description" : "vendor-id",
"optional" : 1,
"pattern" : "(?^:[a-zA-Z0-9]{1,12})",
"type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]"
"typetext" : "[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]"
},
"cpulimit" : {
"default" : 0,
@@ -12485,6 +12605,13 @@ var pveapi = [
"type" : "boolean",
"typetext" : "<boolean>"
},
"hookscript" : {
"description" : "Script that will be executed during various steps in the vms lifetime.",
"format" : "pve-volume-id",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"hostpci[n]" : {
"description" : "Map host PCI devices into guest.",
"format" : "pve-qm-hostpci",
@@ -12885,10 +13012,13 @@ var pveapi = [
"lock" : {
"description" : "Lock/unlock the VM.",
"enum" : [
"migrate",
"backup",
"clone",
"create",
"migrate",
"rollback",
"snapshot",
"rollback"
"snapshot-delete"
],
"optional" : 1,
"type" : "string"
@@ -13975,6 +14105,7 @@ var pveapi = [
"qxl2",
"qxl3",
"qxl4",
"none",
"serial0",
"serial1",
"serial2",
@@ -16839,11 +16970,18 @@ var pveapi = [
"description" : "Do not identify as a KVM virtual machine.",
"optional" : 1,
"type" : "boolean"
},
"hv-vendor-id" : {
"description" : "The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.",
"format_description" : "vendor-id",
"optional" : 1,
"pattern" : "(?^:[a-zA-Z0-9]{1,12})",
"type" : "string"
}
},
"optional" : 1,
"type" : "string",
"typetext" : "[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]"
"typetext" : "[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]"
},
"cpulimit" : {
"default" : 0,
@@ -16923,6 +17061,13 @@ var pveapi = [
"type" : "boolean",
"typetext" : "<boolean>"
},
"hookscript" : {
"description" : "Script that will be executed during various steps in the vms lifetime.",
"format" : "pve-volume-id",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"hostpci[n]" : {
"description" : "Map host PCI devices into guest.",
"format" : "pve-qm-hostpci",
@@ -17323,10 +17468,13 @@ var pveapi = [
"lock" : {
"description" : "Lock/unlock the VM.",
"enum" : [
"migrate",
"backup",
"clone",
"create",
"migrate",
"rollback",
"snapshot",
"rollback"
"snapshot-delete"
],
"optional" : 1,
"type" : "string"
@@ -18428,6 +18576,7 @@ var pveapi = [
"qxl2",
"qxl3",
"qxl4",
"none",
"serial0",
"serial1",
"serial2",
@@ -18822,6 +18971,14 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"snapshot" : {
"description" : "Fetch config values from given snapshot.",
"format" : "pve-configid",
"maxLength" : 40,
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
@@ -18936,6 +19093,12 @@ var pveapi = [
"optional" : 1,
"type" : "string"
},
"hookscript" : {
"description" : "Script that will be exectued during various steps in the containers lifetime.",
"format" : "pve-volume-id",
"optional" : 1,
"type" : "string"
},
"hostname" : {
"description" : "Set a host name for the container.",
"format" : "dns-name",
@@ -19380,6 +19543,13 @@ var pveapi = [
"type" : "string",
"typetext" : "[fuse=<1|0>] [,keyctl=<1|0>] [,mount=<fstype;fstype;...>] [,nesting=<1|0>]"
},
"hookscript" : {
"description" : "Script that will be exectued during various steps in the containers lifetime.",
"format" : "pve-volume-id",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"hostname" : {
"description" : "Set a host name for the container.",
"format" : "dns-name",
@@ -20665,7 +20835,7 @@ var pveapi = [
},
"macro" : {
"optional" : 1,
"type" : "integer"
"type" : "string"
},
"pos" : {
"type" : "integer"
@@ -23937,6 +24107,13 @@ var pveapi = [
"type" : "boolean",
"typetext" : "<boolean>"
},
"hookscript" : {
"description" : "Script that will be exectued during various steps in the containers lifetime.",
"format" : "pve-volume-id",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"hostname" : {
"description" : "Set a host name for the container.",
"format" : "dns-name",
@@ -24739,41 +24916,23 @@ var pveapi = [
"children" : [
{
"info" : {
"POST" : {
"description" : "Create a Ceph filesystem",
"method" : "POST",
"name" : "createfs",
"DELETE" : {
"description" : "Destroy Ceph Manager.",
"method" : "DELETE",
"name" : "destroymgr",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"add-storage" : {
"default" : 0,
"description" : "Configure the created CephFS as storage for this cluster.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"name" : {
"default" : "cephfs",
"description" : "The ceph filesystem name.",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
"id" : {
"description" : "The ID of the manager",
"pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?",
"type" : "string"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
},
"pg_num" : {
"default" : 128,
"description" : "Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.",
"maximum" : 32768,
"minimum" : 8,
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (8 - 32768)"
}
}
},
@@ -24794,18 +24953,24 @@ var pveapi = [
}
},
"leaf" : 1,
"path" : "/nodes/{node}/ceph/fs/{name}",
"text" : "{name}"
"path" : "/nodes/{node}/ceph/mgr/{id}",
"text" : "{id}"
}
],
"info" : {
"GET" : {
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
"POST" : {
"description" : "Create Ceph Manager",
"method" : "POST",
"name" : "createmgr",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"id" : {
"description" : "The ID for the manager, when omitted the same as the nodename",
"optional" : 1,
"pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?",
"type" : "string"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
@@ -24819,72 +24984,89 @@ var pveapi = [
"perm",
"/",
[
"Sys.Audit",
"Datastore.Audit"
],
"any",
1
"Sys.Modify"
]
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"items" : {
"properties" : {
"data_pool" : {
"description" : "The name of the data pool.",
"type" : "string"
},
"metadata_pool" : {
"description" : "The name of the metadata pool.",
"type" : "string"
},
"name" : {
"description" : "The ceph filesystem name.",
"type" : "string"
}
},
"type" : "object"
},
"links" : [
{
"href" : "{name}",
"rel" : "child"
}
],
"type" : "array"
"type" : "string"
}
}
},
"leaf" : 0,
"path" : "/nodes/{node}/ceph/fs",
"text" : "fs"
"path" : "/nodes/{node}/ceph/mgr",
"text" : "mgr"
},
{
"info" : {
"GET" : {
"description" : "List local disks.",
"method" : "GET",
"name" : "disks",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
},
"type" : {
"description" : "Only list specific types of disks.",
"enum" : [
"unused",
"journal_disks"
],
"optional" : 1,
"children" : [
{
"info" : {
"DELETE" : {
"description" : "Destroy Ceph Monitor and Manager.",
"method" : "DELETE",
"name" : "destroymon",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"exclude-manager" : {
"default" : 0,
"description" : "When set, removes only the monitor, not the manager",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"monid" : {
"description" : "Monitor ID",
"pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?",
"type" : "string"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
}
}
},
"permissions" : {
"check" : [
"perm",
"/",
[
"Sys.Modify"
]
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"type" : "string"
}
}
},
"leaf" : 1,
"path" : "/nodes/{node}/ceph/mon/{monid}",
"text" : "{monid}"
}
],
"info" : {
"GET" : {
"description" : "Get Ceph monitor list.",
"method" : "GET",
"name" : "listmon",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
}
}
},
"permissions" : {
"check" : [
"perm",
@@ -24902,54 +25084,51 @@ var pveapi = [
"returns" : {
"items" : {
"properties" : {
"dev" : {
"type" : "string"
},
"gpt" : {
"type" : "boolean"
},
"model" : {
"optional" : 1,
"type" : "string"
},
"osdid" : {
"type" : "integer"
},
"serial" : {
"optional" : 1,
"type" : "string"
},
"size" : {
"type" : "integer"
},
"used" : {
"optional" : 1,
"addr" : {
"type" : "string"
},
"vendor" : {
"optional" : 1,
"name" : {
"type" : "string"
}
},
"type" : "object"
},
"links" : [
{
"href" : "{name}",
"rel" : "child"
}
],
"type" : "array"
}
}
},
"leaf" : 1,
"path" : "/nodes/{node}/ceph/disks",
"text" : "disks"
},
{
"info" : {
"GET" : {
"description" : "Get Ceph configuration.",
"method" : "GET",
"name" : "config",
},
"POST" : {
"description" : "Create Ceph Monitor and Manager",
"method" : "POST",
"name" : "createmon",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"exclude-manager" : {
"default" : 0,
"description" : "When set, only a monitor will be created.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"id" : {
"description" : "The ID for the monitor, when omitted the same as the nodename",
"optional" : 1,
"pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?",
"type" : "string"
},
"mon-address" : {
"description" : "Overwrites autodetected monitor IP address. Must be in the public network of ceph.",
"format" : "ip",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
@@ -24963,50 +25142,60 @@ var pveapi = [
"perm",
"/",
[
"Sys.Audit",
"Datastore.Audit"
],
"any",
1
"Sys.Modify"
]
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"type" : "string"
}
}
},
"leaf" : 1,
"path" : "/nodes/{node}/ceph/config",
"text" : "config"
"leaf" : 0,
"path" : "/nodes/{node}/ceph/mon",
"text" : "mon"
},
{
"children" : [
{
"info" : {
"DELETE" : {
"description" : "Destroy Ceph Monitor and Manager.",
"method" : "DELETE",
"name" : "destroymon",
"POST" : {
"description" : "Create a Ceph filesystem",
"method" : "POST",
"name" : "createfs",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"exclude-manager" : {
"add-storage" : {
"default" : 0,
"description" : "When set, removes only the monitor, not the manager",
"description" : "Configure the created CephFS as storage for this cluster.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"monid" : {
"description" : "Monitor ID",
"pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?",
"type" : "string"
"name" : {
"default" : "cephfs",
"description" : "The ceph filesystem name.",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
},
"pg_num" : {
"default" : 128,
"description" : "Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.",
"maximum" : 32768,
"minimum" : 8,
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (8 - 32768)"
}
}
},
@@ -25027,15 +25216,15 @@ var pveapi = [
}
},
"leaf" : 1,
"path" : "/nodes/{node}/ceph/mon/{monid}",
"text" : "{monid}"
"path" : "/nodes/{node}/ceph/fs/{name}",
"text" : "{name}"
}
],
"info" : {
"GET" : {
"description" : "Get Ceph monitor list.",
"description" : "Directory index.",
"method" : "GET",
"name" : "listmon",
"name" : "index",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
@@ -25060,14 +25249,19 @@ var pveapi = [
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"items" : {
"properties" : {
"addr" : {
"data_pool" : {
"description" : "The name of the data pool.",
"type" : "string"
},
"metadata_pool" : {
"description" : "The name of the metadata pool.",
"type" : "string"
},
"name" : {
"description" : "The ceph filesystem name.",
"type" : "string"
}
},
@@ -25081,34 +25275,103 @@ var pveapi = [
],
"type" : "array"
}
},
"POST" : {
"description" : "Create Ceph Monitor and Manager",
"method" : "POST",
"name" : "createmon",
}
},
"leaf" : 0,
"path" : "/nodes/{node}/ceph/fs",
"text" : "fs"
},
{
"info" : {
"GET" : {
"description" : "List local disks.",
"method" : "GET",
"name" : "disks",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"exclude-manager" : {
"default" : 0,
"description" : "When set, only a monitor will be created.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
},
"id" : {
"description" : "The ID for the monitor, when omitted the same as the nodename",
"type" : {
"description" : "Only list specific types of disks.",
"enum" : [
"unused",
"journal_disks"
],
"optional" : 1,
"pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?",
"type" : "string"
}
}
},
"permissions" : {
"check" : [
"perm",
"/",
[
"Sys.Audit",
"Datastore.Audit"
],
"any",
1
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"items" : {
"properties" : {
"dev" : {
"type" : "string"
},
"gpt" : {
"type" : "boolean"
},
"model" : {
"optional" : 1,
"type" : "string"
},
"osdid" : {
"type" : "integer"
},
"serial" : {
"optional" : 1,
"type" : "string"
},
"size" : {
"type" : "integer"
},
"used" : {
"optional" : 1,
"type" : "string"
},
"vendor" : {
"optional" : 1,
"type" : "string"
}
},
"mon-address" : {
"description" : "Overwrites autodetected monitor IP address. Must be in the public network of ceph.",
"format" : "ip",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"type" : "object"
},
"type" : "array"
}
}
},
"leaf" : 1,
"path" : "/nodes/{node}/ceph/disks",
"text" : "disks"
},
{
"info" : {
"GET" : {
"description" : "Get Ceph configuration.",
"method" : "GET",
"name" : "config",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
@@ -25122,20 +25385,21 @@ var pveapi = [
"perm",
"/",
[
"Sys.Modify"
]
"Sys.Audit",
"Datastore.Audit"
],
"any",
1
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"type" : "string"
}
}
},
"leaf" : 0,
"path" : "/nodes/{node}/ceph/mon",
"text" : "mon"
"leaf" : 1,
"path" : "/nodes/{node}/ceph/config",
"text" : "config"
},
{
"info" : {
@@ -25225,93 +25489,6 @@ var pveapi = [
"path" : "/nodes/{node}/ceph/init",
"text" : "init"
},
{
"children" : [
{
"info" : {
"DELETE" : {
"description" : "Destroy Ceph Manager.",
"method" : "DELETE",
"name" : "destroymgr",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"id" : {
"description" : "The ID of the manager",
"pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?",
"type" : "string"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
}
}
},
"permissions" : {
"check" : [
"perm",
"/",
[
"Sys.Modify"
]
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"type" : "string"
}
}
},
"leaf" : 1,
"path" : "/nodes/{node}/ceph/mgr/{id}",
"text" : "{id}"
}
],
"info" : {
"POST" : {
"description" : "Create Ceph Manager",
"method" : "POST",
"name" : "createmgr",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"id" : {
"description" : "The ID for the manager, when omitted the same as the nodename",
"optional" : 1,
"pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?",
"type" : "string"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
}
}
},
"permissions" : {
"check" : [
"perm",
"/",
[
"Sys.Modify"
]
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"type" : "string"
}
}
},
"leaf" : 0,
"path" : "/nodes/{node}/ceph/mgr",
"text" : "mgr"
},
{
"info" : {
"POST" : {
@@ -26772,7 +26949,7 @@ var pveapi = [
"key" : {
"description" : "Proxmox VE subscription key",
"maxLength" : 32,
"pattern" : "pve([124])([cbsp])-[0-9a-f]{10}",
"pattern" : "pve([1248])([cbsp])-[0-9a-f]{10}",
"type" : "string"
},
"node" : {
@@ -27639,6 +27816,17 @@ var pveapi = [
"type" : "string",
"typetext" : "<string>"
},
"source" : {
"default" : "archive",
"description" : "List archived, active or all tasks.",
"enum" : [
"archive",
"active",
"all"
],
"optional" : 1,
"type" : "string"
},
"start" : {
"default" : 0,
"description" : "List tasks beginning from this offset.",
@@ -27647,6 +27835,12 @@ var pveapi = [
"type" : "integer",
"typetext" : "<integer> (0 - N)"
},
"typefilter" : {
"description" : "Only list tasks of this type (e.g., vzstart, vzdump).",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"userfilter" : {
"description" : "Only list tasks from this user.",
"optional" : 1,
@@ -27677,26 +27871,21 @@ var pveapi = [
"type" : "integer"
},
"id" : {
"optional" : 1,
"title" : "ID",
"type" : "string"
},
"node" : {
"optional" : 1,
"title" : "Node",
"type" : "string"
},
"pid" : {
"optional" : 1,
"title" : "PID",
"type" : "integer"
},
"pstart" : {
"optional" : 1,
"type" : "integer"
},
"starttime" : {
"optional" : 1,
"title" : "Starttime",
"type" : "integer"
},
@@ -27706,7 +27895,6 @@ var pveapi = [
"type" : "string"
},
"type" : {
"optional" : 1,
"title" : "Type",
"type" : "string"
},
@@ -27715,7 +27903,6 @@ var pveapi = [
"type" : "string"
},
"user" : {
"optional" : 1,
"title" : "User",
"type" : "string"
}
@@ -30491,7 +30678,7 @@ var pveapi = [
},
"macro" : {
"optional" : 1,
"type" : "integer"
"type" : "string"
},
"pos" : {
"type" : "integer"
@@ -30907,6 +31094,12 @@ var pveapi = [
"optional" : 1,
"type" : "boolean"
},
"nf_conntrack_allow_invalid" : {
"default" : 0,
"description" : "Allow invalid packets on connection tracking.",
"optional" : 1,
"type" : "boolean"
},
"nf_conntrack_max" : {
"description" : "Maximum number of tracked connections.",
"minimum" : 32768,
@@ -31030,6 +31223,13 @@ var pveapi = [
"type" : "boolean",
"typetext" : "<boolean>"
},
"nf_conntrack_allow_invalid" : {
"default" : 0,
"description" : "Allow invalid packets on connection tracking.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"nf_conntrack_max" : {
"description" : "Maximum number of tracked connections.",
"minimum" : 32768,
@@ -31929,6 +32129,13 @@ var pveapi = [
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
},
"wakeonlan" : {
"description" : "MAC address for wake on LAN",
"format" : "mac-addr",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
}
}
},
@@ -32149,6 +32356,44 @@ var pveapi = [
"path" : "/nodes/{node}/execute",
"text" : "execute"
},
{
"info" : {
"POST" : {
"description" : "Try to wake a node via 'wake on LAN' network packet.",
"method" : "POST",
"name" : "wakeonlan",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"node" : {
"description" : "target node for wake on LAN packet",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
}
}
},
"permissions" : {
"check" : [
"perm",
"/nodes/{node}",
[
"Sys.PowerMgmt"
]
]
},
"protected" : 1,
"returns" : {
"description" : "MAC address used to assemble the WoL magic packet.",
"format" : "mac-addr",
"type" : "string"
}
}
},
"leaf" : 1,
"path" : "/nodes/{node}/wakeonlan",
"text" : "wakeonlan"
},
{
"info" : {
"GET" : {

+ 8
- 0
datacenter.cfg.5-opts.adoc View File

@@ -36,6 +36,14 @@ Set the fencing mode of the HA cluster. Hardware mode needs a valid configuratio
+
WARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP

`ha`: `shutdown_policy=<freeze|failover|conditional>` ::

Cluster wide HA settings.

`shutdown_policy`=`<conditional | failover | freeze>` ('default =' `conditional`);;

Describes the policy for handling HA services on poweroff or reboot of a node. Freeze will always freeze services which are still located on the node on shutdown, those services won't be recovered by the HA manager. Failover will not mark the services as frozen and thus the services will get recovered to other nodes, if the shutdown node does not come up again quickly (< 1min). 'conditional' chooses automatically depending on the type of shutdown, i.e., on a reboot the service will be frozen but on a poweroff the service will stay as is, and thus get recovered after about 2 minutes.

`http_proxy`: `http://.*` ::

Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')

+ 2
- 2
output-format-opts.adoc View File

@@ -2,11 +2,11 @@

Call output rendering functions to produce human readable text.

`--noborder` `<boolean>` ('default =' `1`)::
`--noborder` `<boolean>` ('default =' `0`)::

Do not draw borders (for 'text' format).

`--noheader` `<boolean>` ('default =' `1`)::
`--noheader` `<boolean>` ('default =' `0`)::

Do not show column headers (for 'text' format).


+ 17
- 1
pct.1-synopsis.adoc View File

@@ -40,7 +40,7 @@ Target storage for full clone.

Target node. Only allowed if the original VM is on shared storage.

*pct config* `<vmid>`
*pct config* `<vmid>` `[OPTIONS]`

Get container configuration.

@@ -48,6 +48,10 @@ Get container configuration.

The (unique) ID of the VM.

`--snapshot` `<string>` ::

Fetch config values from given snapshot.

*pct console* `<vmid>` `[OPTIONS]`

Launch a console for the specified container.
@@ -120,6 +124,10 @@ Allow containers access to advanced features.

Allow to overwrite existing container.

`--hookscript` `<string>` ::

Script that will be exectued during various steps in the containers lifetime.

`--hostname` `<string>` ::

Set a host name for the container.
@@ -514,6 +522,10 @@ Allow containers access to advanced features.

Allow to overwrite existing container.

`--hookscript` `<string>` ::

Script that will be exectued during various steps in the containers lifetime.

`--hostname` `<string>` ::

Set a host name for the container.
@@ -678,6 +690,10 @@ Prevent changes if current configuration file has different SHA1 digest. This ca

Allow containers access to advanced features.

`--hookscript` `<string>` ::

Script that will be exectued during various steps in the containers lifetime.

`--hostname` `<string>` ::

Set a host name for the container.

+ 4
- 0
pct.conf.5-opts.adoc View File

@@ -50,6 +50,10 @@ Allow mounting file systems of specific types. This should be a list of file sys

Allow nesting. Best used with unprivileged containers with additional id mapping. Note that this will expose procfs and sysfs contents of the host to the guest.

`hookscript`: `<string>` ::

Script that will be exectued during various steps in the containers lifetime.

`hostname`: `<string>` ::

Set a host name for the container.

+ 4
- 0
pve-firewall-host-opts.adoc View File

@@ -14,6 +14,10 @@ Log level for outgoing traffic.

Enable NDP.

`nf_conntrack_allow_invalid`: `<boolean>` ('default =' `0`)::

Allow invalid packets on connection tracking.

`nf_conntrack_max`: `<integer> (32768 - N)` ::

Maximum number of tracked connections.

+ 20
- 0
pvenode.1-synopsis.adoc View File

@@ -125,6 +125,10 @@ Node description/comment.

Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

`--wakeonlan` `<string>` ::

MAC address for wake on LAN

*pvenode help* `[OPTIONS]`

Get help about specified command.
@@ -185,10 +189,18 @@ no description available

Only list this amount of tasks.

`--source` `<active | all | archive>` ('default =' `archive`)::

List archived, active or all tasks.

`--start` `<integer> (0 - N)` ('default =' `0`)::

List tasks beginning from this offset.

`--typefilter` `<string>` ::

Only list tasks of this type (e.g., vzstart, vzdump).

`--userfilter` `<string>` ::

Only list tasks from this user.
@@ -217,4 +229,12 @@ Read task status.

no description available

*pvenode wakeonlan* `<node>`

Try to wake a node via 'wake on LAN' network packet.

`<node>`: `<string>` ::

target node for wake on LAN packet



+ 1
- 1
pvesubscription.1-synopsis.adoc View File

@@ -20,7 +20,7 @@ Verbose output format.

Set subscription key.

`<key>`: `pve([124])([cbsp])-[0-9a-f]{10}` ::
`<key>`: `pve([1248])([cbsp])-[0-9a-f]{10}` ::

Proxmox VE subscription key


+ 20
- 4
qm.1-synopsis.adoc View File

@@ -78,6 +78,10 @@ The (unique) ID of the VM.

Get current values (instead of pending values).

`--snapshot` `<string>` ::

Fetch config values from given snapshot.

*qm create* `<vmid>` `[OPTIONS]`

Create or restore a virtual machine.
@@ -150,7 +154,7 @@ cloud-init: User name to change ssh keys and password for instead of the image's

The number of cores per socket.

`--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
`--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]` ::

Emulated CPU type.

@@ -180,6 +184,10 @@ NOTE: Requires option(s): `archive`

Freeze CPU at startup (use 'c' monitor command to start execution).

`--hookscript` `<string>` ::

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>]` ::

Map host PCI devices into guest.
@@ -219,7 +227,7 @@ Enable/disable KVM hardware virtualization.

Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.

`--lock` `<backup | migrate | rollback | snapshot>` ::
`--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete>` ::

Lock/unlock the VM.

@@ -800,7 +808,7 @@ cloud-init: User name to change ssh keys and password for instead of the image's

The number of cores per socket.

`--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
`--cpu` `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]` ::

Emulated CPU type.

@@ -838,6 +846,10 @@ NOTE: Requires option(s): `delete`

Freeze CPU at startup (use 'c' monitor command to start execution).

`--hookscript` `<string>` ::

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>]` ::

Map host PCI devices into guest.
@@ -877,7 +889,7 @@ Enable/disable KVM hardware virtualization.

Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.

`--lock` `<backup | migrate | rollback | snapshot>` ::
`--lock` `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete>` ::

Lock/unlock the VM.

@@ -1049,6 +1061,10 @@ The (unique) ID of the VM.

Puts each option on a new line to enhance human readability

`--snapshot` `<string>` ::

Fetch config values from given snapshot.

*qm shutdown* `<vmid>` `[OPTIONS]`

Shutdown virtual machine. This is similar to pressing the power button on a

+ 11
- 3
qm.conf.5-opts.adoc View File

@@ -66,7 +66,7 @@ cloud-init: User name to change ssh keys and password for instead of the image's

The number of cores per socket.

`cpu`: `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>]` ::
`cpu`: `[cputype=]<enum> [,flags=<+FLAG[;-FLAG...]>] [,hidden=<1|0>] [,hv-vendor-id=<vendor-id>]` ::

Emulated CPU type.

@@ -82,6 +82,10 @@ List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to

Do not identify as a KVM virtual machine.

`hv-vendor-id`=`<vendor-id>` ;;

The Hyper-V vendor ID. Some drivers or programs inside Windows guests need a specific ID.

`cpulimit`: `<number> (0 - 128)` ('default =' `0`)::

Limit of CPU usage.
@@ -116,6 +120,10 @@ Disk size. This is purely informational and has no effect.

Freeze CPU at startup (use 'c' monitor command to start execution).

`hookscript`: `<string>` ::

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>]` ::

Map host PCI devices into guest.
@@ -381,7 +389,7 @@ Enable/disable KVM hardware virtualization.

Set the real time clock to local time. This is enabled by default if ostype indicates a Microsoft OS.

`lock`: `<backup | migrate | rollback | snapshot>` ::
`lock`: `<backup | clone | create | migrate | rollback | snapshot | snapshot-delete>` ::

Lock/unlock the VM.

@@ -1002,7 +1010,7 @@ You can also run without any graphic card, using a serial device as terminal.

Sets the VGA memory (in MiB). Has no effect with serial display.

`type`=`<cirrus | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ('default =' `std`);;
`type`=`<cirrus | none | qxl | qxl2 | qxl3 | qxl4 | serial0 | serial1 | serial2 | serial3 | std | virtio | vmware>` ('default =' `std`);;

Select the VGA type.


Loading…
Cancel
Save