openvmtools
Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
- Puppet >= 7.0.0 < 9.0.0
- , , , , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppet-openvmtools', '5.0.0'
Learn more about managing modules with a PuppetfileDocumentation
Open Virtual Machine Tools
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with this module
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Changelog
- References
- Development - Guide for contributing to the module
Overview
This Puppet module manages the installation and configuration of the Open Virtual Machine Tools for VMware. VMware recommends using open-vm-tools redistributed by operating system vendors.
Module Description
open-vm-tools is the open source implementation of VMware Tools and consists of a suite of virtualization utilities that improves the functionality, administration, and management of virtual machines within a VMware environment. The primary purpose for open-vm-tools is to enable operating system vendors and/or communities and virtual appliance vendors to bundle VMware Tools into their product releases.
The benefits of bundling open-vm-tools are:
- End users get the best out-of-box experience to efficiently deploy virtual machines on VMware virtual infrastructure.
- Eliminates the need to separately install VMware Tools when open-vm-tools is bundled with the operating system because open-vm-tools is a fully-supported open source implementation of VMware Tools.
- Reduces operational expenses and virtual machine downtime because updates to open-vm-tools packages are provided with operating system maintenance updates and patches. This eliminates separate maintenance cycles for VMware Tools updates.
- No compatibility matrix check is required for open-vm-tools. Adhering to the VMware Compatibility Matrix for the guest OS release is sufficient.
- open-vm-tools bundled with the operating system provides a compact footprint optimized for each OS release.
Setup
What this module affects
- Installs the main package open-vm-tools.
- Optionally installs the desktop package open-vm-tools-desktop.
- Starts the vmtoolsd daemon.
Requirements
You need to be running a virtual machine on the VMware platform and on an operating system that ships the Open Virtual Machine Tools for this module to do anything.
Beginning with this module
It is safe for all nodes to use this declaration. Any non-VMware or unsupported system will skip installation of the tools.
include openvmtools
To include the desktop software, set the following parameter:
class { 'openvmtools':
with_desktop => true,
}
Usage
There is only one class and most usage will simply include the openvmtools
class.
Reference
Classes
Public Classes
openvmtools
: Installs the Open Virtual Machine Tools.
Class: openvmtools
Parameters
The following parameters are available in the ::openvmtools
class:
ensure
Ensure if present or absent. Default: present
autoupgrade
Upgrade package automatically, if there is a newer version. Default: false
desktop_package_conflicts
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: auto-set, platform specific
desktop_package_name
Name of the desktop package. Only set this if your platform is not supported or you know what you are doing. Default: auto-set, platform specific
manage_epel
Boolean that determines if puppet-epel is required for packages. This should only needed for RedHat (EL) 6. Default: auto-set, platform specific
package_name
Name of the package. Only set this if your platform is not supported or you know what you are doing. Default: auto-set, platform specific
service_enable
Start service at boot. Default: true
service_ensure
Ensure if service is running or stopped. Default: running
service_hasstatus
Name of openvmtools service. Only set this if your platform is not supported or you know what you are doing. Default: auto-set, platform specific
service_name
Name of openvmtools service. Only set this if your platform is not supported or you know what you are doing. Default: auto-set, platform specific
service_pattern
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 be uninstalled, if present. Default: false
with_desktop
Whether or not to install the desktop/GUI support. Default: false
Limitations
OS Support
open-vm-tools is available with these operating systems:
- CentOS 7 and later releases
- Debian 11 and later releases
- Fedora 38 and later releases
- FreeBSD 10 and later releases
- Oracle Linux 7 and later releases
- Red Hat Enterprise Linux 7.0 and later releases
- SUSE Linux Enterprise 12 and later releases
- Ubuntu 20.04 and later LTS releases
- openSUSE 11.x and later releases
- Rocky 8 and later releases
- AlmaLinux 8 and later releases
Notes
- No other VM tools (ie Operating System Specific Packages) will be supported. Use voxpupuli/vmwaretools instead.
Issues
- None
Changelog
see CHANGELOG.md
References
see REFERENCE.md
Development
Please see CONTRIBUTING.md for information on how to contribute.
Copyright (C) 2017 Vox Pupuli voxpupuli@groups.io
Licensed under the Apache License, Version 2.0.
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.
Changelog
All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.
v5.0.0 (2024-03-29)
Breaking changes:
- Remove Fedora 19-25 support #85 (Valantin)
- Remove Ubuntu 14.04, 16.04 and 18.04 from supported OS #76 (Valantin)
- Remove Debian 7,8,9 and 10 from supported OS #75 (Valantin)
Implemented enhancements:
- Add Fedora 38 & 39 support #81 (Valantin)
- Add AlmaLinux 8 and Centos/Rocky/OracleLinux/AlmaLinux 9 to supported OS #77 (Valantin)
- Add Debian 11 and 12 to supported OS #74 (Valantin)
- Add Ubuntu 22.04 to supported OS #73 (Valantin)
Fixed bugs:
Merged pull requests:
- Document parameter supported #83 (Valantin)
- Drop EL6 Hiera data #82 (ekohl)
- Add basic acceptance Test #78 (Valantin)
v4.0.0 (2023-12-04)
Breaking changes:
- Drop Puppet 6 support #60 (bastelfreak)
Implemented enhancements:
- metadata: allow puppet/epel 5.x #67 (kenyon)
- add rhel9 support #65 (golflimaechoecho)
- Add Puppet 8 support #63 (bastelfreak)
- puppetlabs/stdlib: Allow 9.x #62 (bastelfreak)
Closed issues:
- Declare EPEL module compatibile with the latest versions or remove the dependency #66
Merged pull requests:
- Remove legacy top-scope syntax #68 (smortex)
- Fix broken Apache-2 license #58 (bastelfreak)
v3.0.0 (2022-08-04)
Breaking changes:
Implemented enhancements:
Merged pull requests:
v2.1.0 (2021-07-25)
Breaking changes:
Implemented enhancements:
- Add support for Ubuntu 20.04 #45 (timdeluxe)
- Autodetect supported instead of using Hiera #41 (ekohl)
- Support Debian 10 #34 (ajurjevi)
Fixed bugs:
- Repair service management in Ubuntu 14.04 #46 (timdeluxe)
- Create /var/run/vmware directory #27 (raphink)
Closed issues:
Merged pull requests:
- Convert class parameters to puppet-strings #43 (ekohl)
- Typo fixed (line 71) #39 (kant)
- Fix regex_replace error on puppet 5 #36 (jsosic)
- Fix Ubuntu #35 (ghoneycutt)
- modulesync 3.0.0 & puppet-lint updates #31 (bastelfreak)
v2.0.1 (2020-01-25)
Closed issues:
- Publishing on the forge? #23
v2.0.0 (2020-01-17)
Breaking changes:
- Modulesync 2.7.0 and drop Puppet 4 support #15 (pillarsdotnet)
- Require at least Puppet 4, support RedHat-6 and FreeBSD, support
vgauthd
, and various other small fixes #14 (pillarsdotnet)
Implemented enhancements:
- override $supported flag #5
- Collision with existing vmware-tools #3
- CentOS 6 support through epel #2
Closed issues:
Merged pull requests:
- Add missing changelog #24 (dhoppe)
- Fix broken link. #20 (pillarsdotnet)
- Remove duplicate CONTRIBUTING.md file #18 (dhoppe)
- Drop support for Ubuntu 12.04 LTS #17 (ghoneycutt)
1.1.0 (2017-07-16)
1.0.0 (2015-04-11)
Fixed bugs:
- Service error on Ubuntu 14.04 #1
0.2.0 (2015-04-01)
0.1.0 (2015-03-31)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppet/epel (>= 3.0.0 < 6.0.0)
- puppetlabs/stdlib (>= 2.3.0 < 10.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.