update auto-generated docs
authorDietmar Maurer <dietmar@proxmox.com>
Thu, 1 Dec 2016 09:57:38 +0000 (10:57 +0100)
committerDietmar Maurer <dietmar@proxmox.com>
Thu, 1 Dec 2016 09:58:19 +0000 (10:58 +0100)
api-viewer/apidata.js
qm.1-synopsis.adoc
qm.conf.5-opts.adoc

index bde4904..135d01b 100644 (file)
@@ -4,6 +4,87 @@ var pveapi = [
          {
             "children" : [
                {
+                  "info" : {
+                     "GET" : {
+                        "description" : "Corosync node list.",
+                        "method" : "GET",
+                        "name" : "nodes",
+                        "parameters" : {
+                           "additionalProperties" : 0
+                        },
+                        "returns" : {
+                           "items" : {
+                              "properties" : {
+                                 "node" : {
+                                    "type" : "string"
+                                 }
+                              },
+                              "type" : "object"
+                           },
+                           "links" : [
+                              {
+                                 "href" : "{node}",
+                                 "rel" : "child"
+                              }
+                           ],
+                           "type" : "array"
+                        }
+                     }
+                  },
+                  "leaf" : 1,
+                  "path" : "/cluster/config/nodes",
+                  "text" : "nodes"
+               },
+               {
+                  "info" : {
+                     "GET" : {
+                        "description" : "Get corosync totem protocol settings.",
+                        "method" : "GET",
+                        "name" : "totem",
+                        "parameters" : {
+                           "additionalProperties" : 0
+                        },
+                        "returns" : {
+                           "properties" : {},
+                           "type" : "object"
+                        }
+                     }
+                  },
+                  "leaf" : 1,
+                  "path" : "/cluster/config/totem",
+                  "text" : "totem"
+               }
+            ],
+            "info" : {
+               "GET" : {
+                  "description" : "Directory index.",
+                  "method" : "GET",
+                  "name" : "index",
+                  "parameters" : {
+                     "additionalProperties" : 0
+                  },
+                  "returns" : {
+                     "items" : {
+                        "properties" : {},
+                        "type" : "object"
+                     },
+                     "links" : [
+                        {
+                           "href" : "{name}",
+                           "rel" : "child"
+                        }
+                     ],
+                     "type" : "array"
+                  }
+               }
+            },
+            "leaf" : 0,
+            "path" : "/cluster/config",
+            "text" : "config"
+         },
+         {
+            "children" : [
+               {
                   "children" : [
                      {
                         "children" : [
@@ -6169,6 +6250,7 @@ var pveapi = [
                                                 "wvista",
                                                 "win7",
                                                 "win8",
+                                                "win10",
                                                 "l24",
                                                 "l26",
                                                 "solaris"
@@ -8034,6 +8116,7 @@ var pveapi = [
                                                 "wvista",
                                                 "win7",
                                                 "win8",
+                                                "win10",
                                                 "l24",
                                                 "l26",
                                                 "solaris"
@@ -10425,7 +10508,8 @@ var pveapi = [
                                           [
                                              "VM.Monitor"
                                           ]
-                                       ]
+                                       ],
+                                       "description" : "Sys.Modify is required for (sub)commands which are not read-only ('info *' and 'help')"
                                     },
                                     "protected" : 1,
                                     "proxyto" : "node",
@@ -10440,6 +10524,73 @@ var pveapi = [
                            },
                            {
                               "info" : {
+                                 "POST" : {
+                                    "description" : "Execute Qemu Guest Agent commands.",
+                                    "method" : "POST",
+                                    "name" : "agent",
+                                    "parameters" : {
+                                       "additionalProperties" : 0,
+                                       "properties" : {
+                                          "command" : {
+                                             "description" : "The QGA command.",
+                                             "enum" : [
+                                                "ping",
+                                                "get-time",
+                                                "info",
+                                                "fsfreeze-status",
+                                                "fsfreeze-freeze",
+                                                "fsfreeze-thaw",
+                                                "fstrim",
+                                                "network-get-interfaces",
+                                                "get-vcpus",
+                                                "get-fsinfo",
+                                                "get-memory-blocks",
+                                                "get-memory-block-info",
+                                                "suspend-hybrid",
+                                                "suspend-ram",
+                                                "suspend-disk",
+                                                "shutdown"
+                                             ],
+                                             "type" : "string"
+                                          },
+                                          "node" : {
+                                             "description" : "The cluster node name.",
+                                             "format" : "pve-node",
+                                             "type" : "string",
+                                             "typetext" : "<string>"
+                                          },
+                                          "vmid" : {
+                                             "description" : "The (unique) ID of the VM.",
+                                             "format" : "pve-vmid",
+                                             "minimum" : 1,
+                                             "type" : "integer",
+                                             "typetext" : "<integer> (1 - N)"
+                                          }
+                                       }
+                                    },
+                                    "permissions" : {
+                                       "check" : [
+                                          "perm",
+                                          "/vms/{vmid}",
+                                          [
+                                             "VM.Monitor"
+                                          ]
+                                       ]
+                                    },
+                                    "protected" : 1,
+                                    "proxyto" : "node",
+                                    "returns" : {
+                                       "description" : "Returns an object with a single `result` property. The type of that\nproperty depends on the executed command.",
+                                       "type" : "object"
+                                    }
+                                 }
+                              },
+                              "leaf" : 1,
+                              "path" : "/nodes/{node}/qemu/{vmid}/agent",
+                              "text" : "agent"
+                           },
+                           {
+                              "info" : {
                                  "PUT" : {
                                     "description" : "Extend volume size.",
                                     "method" : "PUT",
@@ -11931,6 +12082,7 @@ var pveapi = [
                                     "wvista",
                                     "win7",
                                     "win8",
+                                    "win10",
                                     "l24",
                                     "l26",
                                     "solaris"
@@ -18017,6 +18169,148 @@ var pveapi = [
                         "text" : "pools"
                      },
                      {
+                        "children" : [
+                           {
+                              "info" : {
+                                 "DELETE" : {
+                                    "description" : "Unset a ceph flag",
+                                    "method" : "DELETE",
+                                    "name" : "unset_flag",
+                                    "parameters" : {
+                                       "additionalProperties" : 0,
+                                       "properties" : {
+                                          "flag" : {
+                                             "description" : "The ceph flag to set/unset",
+                                             "enum" : [
+                                                "full",
+                                                "pause",
+                                                "noup",
+                                                "nodown",
+                                                "noout",
+                                                "noin",
+                                                "nobackfill",
+                                                "norebalance",
+                                                "norecover",
+                                                "noscrub",
+                                                "nodeep-scrub",
+                                                "notieragent"
+                                             ],
+                                             "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" : "null"
+                                    }
+                                 },
+                                 "POST" : {
+                                    "description" : "Set a ceph flag",
+                                    "method" : "POST",
+                                    "name" : "set_flag",
+                                    "parameters" : {
+                                       "additionalProperties" : 0,
+                                       "properties" : {
+                                          "flag" : {
+                                             "description" : "The ceph flag to set/unset",
+                                             "enum" : [
+                                                "full",
+                                                "pause",
+                                                "noup",
+                                                "nodown",
+                                                "noout",
+                                                "noin",
+                                                "nobackfill",
+                                                "norebalance",
+                                                "norecover",
+                                                "noscrub",
+                                                "nodeep-scrub",
+                                                "notieragent"
+                                             ],
+                                             "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" : "null"
+                                    }
+                                 }
+                              },
+                              "leaf" : 1,
+                              "path" : "/nodes/{node}/ceph/flags/{flag}",
+                              "text" : "{flag}"
+                           }
+                        ],
+                        "info" : {
+                           "GET" : {
+                              "description" : "get all set ceph flags",
+                              "method" : "GET",
+                              "name" : "get_flags",
+                              "parameters" : {
+                                 "additionalProperties" : 0,
+                                 "properties" : {
+                                    "node" : {
+                                       "description" : "The cluster node name.",
+                                       "format" : "pve-node",
+                                       "type" : "string",
+                                       "typetext" : "<string>"
+                                    }
+                                 }
+                              },
+                              "permissions" : {
+                                 "check" : [
+                                    "perm",
+                                    "/",
+                                    [
+                                       "Sys.Audit"
+                                    ]
+                                 ]
+                              },
+                              "protected" : 1,
+                              "proxyto" : "node",
+                              "returns" : {
+                                 "type" : "string"
+                              }
+                           }
+                        },
+                        "leaf" : 0,
+                        "path" : "/nodes/{node}/ceph/flags",
+                        "text" : "flags"
+                     },
+                     {
                         "info" : {
                            "GET" : {
                               "description" : "Get OSD crush map",
index 2ec5ad5..eacd6f6 100644 (file)
@@ -1,5 +1,19 @@
 *qm* `<COMMAND> [ARGS] [OPTIONS]`
 
+*qm agent* `<vmid> <command>`
+
+Execute Qemu Guest Agent commands.
+
+`<vmid>`: `<integer> (1 - N)` ::
+
+The (unique) ID of the VM.
+
+`<command>`: `<fsfreeze-freeze | fsfreeze-status | fsfreeze-thaw | fstrim | get-fsinfo | get-memory-block-info | get-memory-blocks | get-time | get-vcpus | info | network-get-interfaces | ping | shutdown | suspend-disk | suspend-hybrid | suspend-ram>` ::
+
+The QGA command.
+
+
+
 *qm clone* `<vmid> <newid>` `[OPTIONS]`
 
 Create a copy of virtual machine/template.
@@ -215,7 +229,7 @@ NUMA topology.
 
 Specifies whether a VM will be started during system bootup.
 
-`-ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp>` ::
+`-ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
 
 Specify guest operating system.
 
@@ -739,7 +753,7 @@ NUMA topology.
 
 Specifies whether a VM will be started during system bootup.
 
-`-ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp>` ::
+`-ostype` `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
 
 Specify guest operating system.
 
index 8f27ed0..fdc0cb6 100644 (file)
@@ -403,7 +403,7 @@ NUMA allocation policy.
 
 Specifies whether a VM will be started during system bootup.
 
-`ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win7 | win8 | wvista | wxp>` ::
+`ostype`: `<l24 | l26 | other | solaris | w2k | w2k3 | w2k8 | win10 | win7 | win8 | wvista | wxp>` ::
 
 Specify guest operating system. This is used to enable special
 optimization/features for specific operating systems: