Skip to content

Commit

Permalink
Document parameter supported with example to install open-vm-tools on…
Browse files Browse the repository at this point in the history
… non supported OS
  • Loading branch information
Valantin committed Mar 18, 2024
1 parent 4767570 commit 60d3d5c
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 9 deletions.
5 changes: 5 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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 force the resulte of supported OS check
Default: undef

##### `uninstall_vmware_tools`

Boolean that determines whether the conflicting VMWare Tools package should
Expand Down
26 changes: 17 additions & 9 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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`

Expand Down Expand Up @@ -147,6 +155,14 @@ doing.

Default value: `undef`

##### <a name="-openvmtools--supported"></a>`supported`

Data type: `Optional[Boolean]`

Boolean that force the result of supported OS check

Default value: `undef`

##### <a name="-openvmtools--uninstall_vmware_tools"></a>`uninstall_vmware_tools`

Data type: `Boolean`
Expand All @@ -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`
Expand Down
8 changes: 8 additions & 0 deletions manifests/init.pp
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@
# Only set this if your platform is not supported or you know what you are
# doing.
#
# @param supported
# Boolean that force the result of supported OS check
#
# @param uninstall_vmware_tools
# Boolean that determines whether the conflicting VMWare Tools package should
# be uninstalled, if present.
Expand All @@ -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 <[email protected]>
# @author Vox Pupuli <[email protected]>
#
Expand Down

0 comments on commit 60d3d5c

Please sign in to comment.