schema: vmgenid: reword desscription, add verbose one and document default

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

diff --git a/PVE/QemuServer.pm b/PVE/QemuServer.pm
index c0c63d8279cbcfdf12a4b4a0ea0b06700231b85f..75e7fdee84aa7a37a6ffc7bbf77f7d436f337258 100644 (file)
--- a/PVE/QemuServer.pm
+++ b/PVE/QemuServer.pm
@@ -563,7 +563,18 @@ EODESCR
        type => 'string',
        pattern => '(?:[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}|[01])',
        format_description => 'UUID',
-        description => "Set VM Generation ID UUID. Use special value 1 to autogenerate one (API only). Use special value 0 to disable explicitly.",
+       description => "Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.",
+       verbose_description => "The VM generation ID (vmgenid) device exposes a".
+           " 128-bit integer value identifier to the guest OS. This allows to".
+           " notify the guest operating system when the virtual machine is".
+           " executed with a different configuration (e.g. snapshot execution".
+           " or creation from a template). The guest operating system notices".
+           " the change, and is then able to react as appropriate by marking".
+           " its copies of distributed databases as dirty, re-initializing its".
+           " random number generator, etc.\n".
+           "Note that auto-creation only works when done throug API/CLI create".
+           " or update methods, but not when manually editing the config file.",
+       default => "1 (autogenerated)",
        optional => 1,
     },
 };