{"id":23881432,"url":"https://github.com/voxpupuli/puppet-openvmtools","last_synced_at":"2026-03-16T22:37:19.981Z","repository":{"id":29629070,"uuid":"33169948","full_name":"voxpupuli/puppet-openvmtools","owner":"voxpupuli","description":"Puppet module to manage Open Virtual Machine Tools intallation.","archived":false,"fork":false,"pushed_at":"2025-10-17T14:55:41.000Z","size":233,"stargazers_count":1,"open_issues_count":1,"forks_count":27,"subscribers_count":38,"default_branch":"master","last_synced_at":"2025-11-10T23:43:59.002Z","etag":null,"topics":["bsd-puppet-module","centos-puppet-module","debian-puppet-module","fedora-puppet-module","freebsd-puppet-module","hacktoberfest","linux-puppet-module","oraclelinux-puppet-module","puppet","redhat-puppet-module","sles-puppet-module","ubuntu-puppet-module"],"latest_commit_sha":null,"homepage":"https://forge.puppetlabs.com/puppet/openvmtools","language":"Puppet","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/voxpupuli.png","metadata":{"files":{"readme":"README.markdown","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"open_collective":"vox-pupuli","github":"voxpupuli"}},"created_at":"2015-03-31T06:56:44.000Z","updated_at":"2025-09-23T13:14:58.000Z","dependencies_parsed_at":"2024-02-16T15:53:19.586Z","dependency_job_id":"e33460c5-1042-419e-86fd-5a5d2cff6323","html_url":"https://github.com/voxpupuli/puppet-openvmtools","commit_stats":{"total_commits":129,"total_committers":23,"mean_commits":5.608695652173913,"dds":0.751937984496124,"last_synced_commit":"3628bfe73e5bfd523dca270805f0b10d42bc3258"},"previous_names":["razorsedge/puppet-openvmtools"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/voxpupuli/puppet-openvmtools","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-openvmtools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-openvmtools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-openvmtools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-openvmtools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/voxpupuli","download_url":"https://codeload.github.com/voxpupuli/puppet-openvmtools/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxpupuli%2Fpuppet-openvmtools/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27669742,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-11T02:00:11.302Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bsd-puppet-module","centos-puppet-module","debian-puppet-module","fedora-puppet-module","freebsd-puppet-module","hacktoberfest","linux-puppet-module","oraclelinux-puppet-module","puppet","redhat-puppet-module","sles-puppet-module","ubuntu-puppet-module"],"created_at":"2025-01-04T01:45:45.924Z","updated_at":"2025-12-11T20:44:10.964Z","avatar_url":"https://github.com/voxpupuli.png","language":"Puppet","funding_links":["https://opencollective.com/vox-pupuli","https://github.com/sponsors/voxpupuli"],"categories":[],"sub_categories":[],"readme":"# Open Virtual Machine Tools\n\n[![CI](https://github.com/voxpupuli/puppet-openvmtools/actions/workflows/ci.yml/badge.svg)](https://github.com/voxpupuli/puppet-openvmtools/actions/workflows/ci.yml)\n[![Release](https://github.com/voxpupuli/puppet-openvmtools/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/puppet-openvmtools/actions/workflows/release.yml)\n[![Code Coverage](https://coveralls.io/repos/github/voxpupuli/puppet-openvmtools/badge.svg?branch=master)](https://coveralls.io/github/voxpupuli/puppet-openvmtools)\n[![Puppet Forge](https://img.shields.io/puppetforge/v/puppet/openvmtools.svg)](https://forge.puppetlabs.com/puppet/openvmtools)\n[![Puppet Forge - downloads](https://img.shields.io/puppetforge/dt/puppet/openvmtools.svg)](https://forge.puppetlabs.com/puppet/openvmtools)\n[![Puppet Forge - endorsement](https://img.shields.io/puppetforge/e/puppet/openvmtools.svg)](https://forge.puppetlabs.com/puppet/openvmtools)\n[![Puppet Forge - scores](https://img.shields.io/puppetforge/f/puppet/openvmtools.svg)](https://forge.puppetlabs.com/puppet/openvmtools)\n[![puppetmodule.info docs](http://www.puppetmodule.info/images/badge.png)](http://www.puppetmodule.info/m/puppet-openvmtools)\n[![License](https://img.shields.io/github/license/voxpupuli/puppet-openvmtools.svg)](https://github.com/voxpupuli/puppet-openvmtools/blob/master/LICENSE)\n\n## Table of Contents\n\n1. [Overview](#overview)\n2. [Module Description - What the module does and why it is useful](#module-description)\n3. [Setup - The basics of getting started with this module](#setup)\n    * [What this module affects](#what-this-module-affects)\n    * [What this module requires](#requirements)\n    * [Beginning with this module](#beginning-with-this-module)\n4. [Usage - Configuration options and additional functionality](#usage)\n5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)\n6. [Limitations - OS compatibility, etc.](#limitations)\n    * [OS Support](#os-support)\n    * [Notes](#notes)\n    * [Issues](#issues)\n7. [Changelog](#changelog)\n8. [References](#references)\n9. [Development - Guide for contributing to the module](#development)\n\n## Overview\n\nThis Puppet module manages the installation and configuration of the\n[Open Virtual Machine Tools](http://open-vm-tools.sourceforge.net/) for VMware.\nVMware [recommends using open-vm-tools](http://kb.vmware.com/kb/2073803)\nredistributed by operating system vendors.\n\n## Module Description\n\nopen-vm-tools is the open source implementation of VMware Tools and consists of\na suite of virtualization utilities that improves the functionality,\nadministration, and management of virtual machines within a VMware environment.\nThe primary purpose for open-vm-tools is to enable operating system vendors\nand/or communities and virtual appliance vendors to bundle VMware Tools into\ntheir product releases.\n\nThe benefits of bundling open-vm-tools are:\n\n* End users get the best out-of-box experience to efficiently deploy virtual\n  machines on VMware virtual infrastructure.\n* Eliminates the need to separately install VMware Tools when open-vm-tools is\n  bundled with the operating system because open-vm-tools is a fully-supported\n  open source implementation of VMware Tools.\n* Reduces operational expenses and virtual machine downtime because updates to\n  open-vm-tools packages are provided with operating system maintenance updates\n  and patches. This eliminates separate maintenance cycles for VMware Tools\n  updates.\n* No compatibility matrix check is required for open-vm-tools. Adhering to the\n  VMware Compatibility Matrix for the guest OS release is sufficient.\n* open-vm-tools bundled with the operating system provides a compact footprint\n  optimized for each OS release.\n\n## Setup\n\n### What this module affects\n\n* Installs the main package open-vm-tools.\n* Optionally installs the desktop package open-vm-tools-desktop.\n* Starts the vmtoolsd daemon.\n\n### Requirements\n\nYou need to be running a virtual machine on the VMware platform and on an\noperating system that ships the Open Virtual Machine Tools for this module\nto do anything.\n\n### Beginning with this module\n\nIt is safe for all nodes to use this declaration.  Any non-VMware or unsupported\nsystem will skip installation of the tools.\n\n```puppet\ninclude openvmtools\n```\n\nTo include the desktop software, set the following parameter:\n\n```puppet\nclass { 'openvmtools':\n  with_desktop =\u003e true,\n}\n```\n\n## Usage\n\nThere is only one class and most usage will simply include the `openvmtools`\nclass.\n\n## Reference\n\n### Classes\n\n#### Public Classes\n\n* [`openvmtools`](#class-openvmtools): Installs the Open Virtual Machine Tools.\n\n### Class: `openvmtools`\n\n#### Parameters\n\nThe following parameters are available in the `::openvmtools` class:\n\n##### `ensure`\n\nEnsure if present or absent.\nDefault: present\n\n##### `autoupgrade`\n\nUpgrade package automatically, if there is a newer version.\nDefault: false\n\n##### `desktop_package_conflicts`\n\nBoolean that determines whether the desktop conflicts includes and\nconflicts with the base package. Only set this if your platform is not\nsupported or you know what you are doing.\nDefault: auto-set, platform specific\n\n##### `desktop_package_name`\n\nName of the desktop package.  Only set this if your platform is not supported or\nyou know what you are doing.\nDefault: auto-set, platform specific\n\n##### `manage_epel`\n\nBoolean that determines if puppet-epel is required for packages.\nThis should only needed for RedHat (EL) 6.\nDefault: auto-set, platform specific\n\n##### `package_name`\n\nName of the package.  Only set this if your platform is not supported or you\nknow what you are doing.\nDefault: auto-set, platform specific\n\n##### `service_enable`\n\nStart service at boot.\nDefault: true\n\n##### `service_ensure`\n\nEnsure if service is running or stopped.\nDefault: running\n\n##### `service_hasstatus`\n\nName of openvmtools service.  Only set this if your platform is not supported or\nyou know what you are doing.\nDefault: auto-set, platform specific\n\n##### `service_name`\n\nName of openvmtools service.  Only set this if your platform is not supported or\nyou know what you are doing.\nDefault: auto-set, platform specific\n\n##### `service_pattern`\n\nPattern to look for in the process table to determine if the daemon is running.\nOnly set this if your platform is not supported or you know what you are doing.\nDefault: vmtoolsd\n\n##### `supported`\n\nBoolean that overrides the resulte of the supported OS check\nDefault: undef\n\n##### `uninstall_vmware_tools`\n\nBoolean that determines whether the conflicting VMWare Tools package should\nbe uninstalled, if present.\nDefault: false\n\n##### `with_desktop`\n\nWhether or not to install the desktop/GUI support.\nDefault: false\n\n## Limitations\n\n### OS Support\n\nopen-vm-tools is available with these operating systems:\n\n* CentOS 7 and later releases\n* Debian 11 and later releases\n* Fedora 38 and later releases\n* FreeBSD 10 and later releases\n* Oracle Linux 7 and later releases\n* Red Hat Enterprise Linux 7.0 and later releases\n* SUSE Linux Enterprise 12 and later releases\n* Ubuntu 20.04 and later LTS releases\n* openSUSE 11.x and later releases\n* Rocky 8 and later releases\n* AlmaLinux 8 and later releases\n\n### Notes\n\n* No other VM tools\n  (ie [Operating System Specific Packages](http://packages.vmware.com/)) will be\n  supported.  Use\n  [voxpupuli/vmwaretools](https://forge.puppetlabs.com/voxpupuli/vmwaretools)\n  instead.\n\n### Issues\n\n* None\n\n## Changelog\n\nsee [CHANGELOG.md](CHANGELOG.md)\n\n## References\n\nsee [REFERENCE.md](REFERENCE.md)\n\n## Development\n\nPlease see [CONTRIBUTING.md](.github/CONTRIBUTING.md) for information on how to contribute.\n\nCopyright (C) 2017 Vox Pupuli \u003cvoxpupuli@groups.io\u003e\n\nLicensed under the Apache License, Version 2.0.\n\n[voxpupuli/puppet-openvmtools on GitHub](https://github.com/voxpupuli/puppet-openvmtools)\n\n[voxpupuli/openvmtools on Puppet Forge](https://forge.puppetlabs.com/voxpupuli/openvmtools)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoxpupuli%2Fpuppet-openvmtools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvoxpupuli%2Fpuppet-openvmtools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoxpupuli%2Fpuppet-openvmtools/lists"}