]> git.proxmox.com Git - pve-manager.git/commitdiff
api: node status: document boot-info and current-kernel in return schema
authorThomas Lamprecht <t.lamprecht@proxmox.com>
Mon, 26 Feb 2024 15:55:11 +0000 (16:55 +0100)
committerThomas Lamprecht <t.lamprecht@proxmox.com>
Mon, 26 Feb 2024 15:55:13 +0000 (16:55 +0100)
I recently added the same info to PMG and added them to the return
schema, so copying them over here comes for free, and while far from
complete but better than nothing.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
PVE/API2/Nodes.pm

index 3619190debe9efc236cceb705d6873205ef0e1b6..67a8ce222606468b0ada14b4007451fd34408f8c 100644 (file)
@@ -396,8 +396,47 @@ __PACKAGE__->register_method({
     },
     returns => {
        type => "object",
+       additionalProperties => 1,
        properties => {
-
+           # TODO: document remaing ones
+           'boot-info' => {
+               description => "Meta-information about the boot mode.",
+               type => 'object',
+               properties => {
+                   mode => {
+                       description => 'Through which firmware the system got booted.',
+                       type => 'string',
+                       enum => [qw(efi legacy-bios)],
+                   },
+                   secureboot => {
+                       description => 'System is booted in secure mode, only applicable for the "efi" mode.',
+                       type => 'boolean',
+                       optional => 1,
+                   },
+               },
+           },
+           'current-kernel' => {
+               description => "The uptime of the system in seconds.",
+               type => 'object',
+               properties => {
+                   sysname => {
+                       description => 'OS kernel name (e.g., "Linux")',
+                       type => 'string',
+                   },
+                   release => {
+                       description => 'OS kernel release (e.g., "6.8.0")',
+                       type => 'string',
+                   },
+                   version => {
+                       description => 'OS kernel version with build info',
+                       type => 'string',
+                   },
+                   machine => {
+                       description => 'Hardware (architecture) type',
+                       type => 'string',
+                   },
+               },
+           },
        },
     },
     code => sub {