Adding configuration information for the GlobalConf feature.

As part of the GlobalConf feature, a "globalconf" section is introduced
into tools.conf to provide custom configuration options for the feature.
The configuration parameters are as follows:
 * enabled=false - Enable/disable the GlobalConf module.
 * poll-interval=3600 - Poll interval for the GlobalConf feature.
 * resource=<path> - Defines the location of the tools.conf in the
                     GuestStore.  There is a separate default for Windows
                     and Linux guests.

diff --git a/open-vm-tools/lib/globalConfig/globalConfig.c b/open-vm-tools/lib/globalConfig/globalConfig.c
index aebded8f9bb7b8c0de53ee4d0b755d2219010263..f1b3f9345c04245f37c50e60bc98a6252041e3bc 100644 (file)
--- a/open-vm-tools/lib/globalConfig/globalConfig.c
+++ b/open-vm-tools/lib/globalConfig/globalConfig.c
@@ -1,5 +1,5 @@
 /*********************************************************
- * Copyright (C) 2020-2021 VMware, Inc. All rights reserved.
+ * Copyright (C) 2020-2022 VMware, Inc. All rights reserved.
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of the GNU Lesser General Public License as published
@@ -50,7 +50,7 @@
 /**
  * Default value for CONFNAME_GLOBALCONF_ENABLED setting in tools.conf.
  *
- * FALSE will enable the module.
+ * TRUE will enable the module. GlobalConf module is disabled by default.
  */
 #define GLOBALCONF_DEFAULT_ENABLED FALSE
 

diff --git a/open-vm-tools/tools.conf b/open-vm-tools/tools.conf
index 5679887492d397411eabf5ec97b35c8420114b1b..bfcf952b7e75734e8a9eafa063b316d899f1842b 100644 (file)
--- a/open-vm-tools/tools.conf
+++ b/open-vm-tools/tools.conf
@@ -245,6 +245,28 @@
 # whether to include reserved space in diskInfo space metrics on Linux
 #diskinfo-include-reserved=false
 
+[globalconf]
+
+# The GlobalConf feature provides an ability for the vSphere administrators
+# to distribute a 'VMware Tools Configuration File' (tools.conf) via the
+# GuestStore for multiple VMs at scale.
+
+# Defines the configuration to enable/disable the GlobalConf module.
+# Set to true to enable the module.
+# Set to false to disable the module. Default false.
+#enabled=false
+
+# Defines a custom GlobalConf poll interval (in seconds).
+# Default 3600 seconds. Minimum 1800 seconds.
+#poll-interval=3600
+
+# Defines the global configuration resource in GuestStore.
+# Windows guests
+#resource=/vmware/configurations/vmtools/windows/tools.conf
+#
+# Linux guests
+#resource=/vmware/configurations/vmtools/linux/tools.conf
+
 [componentmgr]
 
 # This plugin manages the known and enabled components add/remove status.