From 0f0a1446d2b0b4a8e5c21a2f1a88312deae6a0b8 Mon Sep 17 00:00:00 2001
From: Roberto Valentini <valantin89@gmail.com>
Date: Mon, 18 Mar 2024 11:18:26 +0100
Subject: [PATCH] Document parameter supported with example to install
 open-vm-tools on non supported OS

---
 README.markdown   |  5 +++++
 REFERENCE.md      | 26 +++++++++++++++++---------
 manifests/init.pp |  8 ++++++++
 3 files changed, 30 insertions(+), 9 deletions(-)

diff --git a/README.markdown b/README.markdown
index 009b569..b92df1b 100644
--- a/README.markdown
+++ b/README.markdown
@@ -164,6 +164,11 @@ Pattern to look for in the process table to determine if the daemon is running.
 Only set this if your platform is not supported or you know what you are doing.
 Default: vmtoolsd
 
+##### `supported`
+
+Boolean that overrides the resulte of the supported OS check
+Default: undef
+
 ##### `uninstall_vmware_tools`
 
 Boolean that determines whether the conflicting VMWare Tools package should
diff --git a/REFERENCE.md b/REFERENCE.md
index dbb7fb3..1ec482a 100644
--- a/REFERENCE.md
+++ b/REFERENCE.md
@@ -26,6 +26,14 @@ Install the Open Virtual Machine Tools.
 include openvmtools
 ```
 
+##### Force pass supported os check on OS non in supported list
+
+```puppet
+class { 'openvmtools':
+  supported => true,
+}
+```
+
 #### Parameters
 
 The following parameters are available in the `openvmtools` class:
@@ -41,9 +49,9 @@ The following parameters are available in the `openvmtools` class:
 * [`service_hasstatus`](#-openvmtools--service_hasstatus)
 * [`service_name`](#-openvmtools--service_name)
 * [`service_pattern`](#-openvmtools--service_pattern)
+* [`supported`](#-openvmtools--supported)
 * [`uninstall_vmware_tools`](#-openvmtools--uninstall_vmware_tools)
 * [`with_desktop`](#-openvmtools--with_desktop)
-* [`supported`](#-openvmtools--supported)
 
 ##### <a name="-openvmtools--ensure"></a>`ensure`
 
@@ -147,6 +155,14 @@ doing.
 
 Default value: `undef`
 
+##### <a name="-openvmtools--supported"></a>`supported`
+
+Data type: `Optional[Boolean]`
+
+Boolean that overrides the result of the supported OS check
+
+Default value: `undef`
+
 ##### <a name="-openvmtools--uninstall_vmware_tools"></a>`uninstall_vmware_tools`
 
 Data type: `Boolean`
@@ -164,14 +180,6 @@ Whether or not to install the desktop/GUI support.
 
 Default value: `false`
 
-##### <a name="-openvmtools--supported"></a>`supported`
-
-Data type: `Optional[Boolean]`
-
-
-
-Default value: `undef`
-
 ## Functions
 
 ### <a name="openvmtools--supported"></a>`openvmtools::supported`
diff --git a/manifests/init.pp b/manifests/init.pp
index fc13b2b..56421ff 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -47,6 +47,9 @@
 #   Only set this if your platform is not supported or you know what you are
 #   doing.
 #
+# @param supported
+#   Boolean that overrides the result of the supported OS check
+#
 # @param uninstall_vmware_tools
 #   Boolean that determines whether the conflicting VMWare Tools package should
 #   be uninstalled, if present.
@@ -57,6 +60,11 @@
 # @example Default usage
 #   include openvmtools
 #
+# @example Force pass supported os check on OS non in supported list
+#   class { 'openvmtools':
+#     supported => true,
+#   }
+#
 # @author Mike Arnold <mike@razorsedge.org>
 # @author Vox Pupuli <voxpupuli@groups.io>
 #