REFERENCE.md

Reference

Table of Contents

Classes

• openvmtools: Install the Open Virtual Machine Tools.

Functions

• openvmtools::supported: Returns whether the currently loaded OS is supported by the module

Classes

openvmtools

Install the Open Virtual Machine Tools.

Examples

Default usage

include openvmtools

Force pass supported os check on OS non in supported list

class { 'openvmtools':
  supported => true,
}

Parameters

The following parameters are available in the openvmtools class:

• ensure
• autoupgrade
• desktop_package_conflicts
• desktop_package_name
• manage_epel
• package_name
• service_enable
• service_ensure
• service_hasstatus
• service_name
• service_pattern
• supported
• uninstall_vmware_tools
• with_desktop

ensure

Data type: Enum['absent','present']

Ensure if present or absent.

Default value: 'present'

autoupgrade

Data type: Boolean

Upgrade package automatically, if there is a newer version.

Default value: false

desktop_package_conflicts

Data type: Boolean

Boolean that determines whether the desktop conflicts includes and conflicts with the base package. Only set this if your platform is not supported or you know what you are doing.

Default value: false

desktop_package_name

Data type: String[1]

Name of the desktop package. Only set this if your platform is not supported or you know what you are doing.

Default value: 'open-vm-tools-desktop'

manage_epel

Data type: Boolean

Boolean that determines if puppet-epel is required for packages. This should only needed for RedHat (EL) 6.

Default value: false

package_name

Data type: String[1]

Name of the package. Only set this if your platform is not supported or you know what you are doing.

Default value: 'open-vm-tools'

service_enable

Data type: Boolean

Start service at boot.

Default value: true

service_ensure

Data type: Stdlib::Ensure::Service

Ensure if service is running or stopped.

Default value: 'running'

service_hasstatus

Data type: Boolean

Service has status command. Only set this if your platform is not supported or you know what you are doing.

Default value: true

service_name

Data type: Variant[String[1],Array[String[1]]]

Name of openvmtools service(s). Only set this if your platform is not supported or you know what you are doing.

Default value: ['vgauthd', 'vmtoolsd']

service_pattern

Data type: Optional[String[1]]

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 value: undef

supported

Data type: Optional[Boolean]

Boolean that overrides the result of the supported OS check

Default value: undef

uninstall_vmware_tools

Data type: Boolean

Boolean that determines whether the conflicting VMWare Tools package should be uninstalled, if present.

Default value: false

with_desktop

Data type: Boolean

Whether or not to install the desktop/GUI support.

Default value: false

Functions

openvmtools::supported

Type: Puppet Language

This function uses the current facts to check if the current Operating System and its release or major release is supported.

Examples

Using the Puppet built in global $module_name

openvmtools::supported($module_name)

openvmtools::supported(String[1] $mod)

This function uses the current facts to check if the current Operating System and its release or major release is supported.

Returns: Boolean Whether the current OS is supported for the given module

Examples

Using the Puppet built in global $module_name

openvmtools::supported($module_name)

mod

Data type: String[1]

The module name to check.