Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

vmwaretools

Install VMware Tools Operating System Specific Packages (OSP) on VMware guests.
Project URLRSS FeedReport issues

921,977 downloads

65,061 latest version

4.2 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 6.1.0 (latest)
  • 6.0.0
  • 5.1.0
  • 5.0.1
  • 5.0.0
  • 4.9.0
  • 4.8.1
  • 4.8.0
  • 4.7.0
  • 4.6.0
  • 4.5.0
  • 4.4.1
  • 4.3.0
  • 4.2.0
  • 4.1.2
  • 4.1.1
  • 4.1.0
  • 4.0.2
  • 4.0.1
  • 4.0.0
  • 3.0.1
  • 3.0.0
  • 2.0.0 (deleted)
  • 1.0.0 (deleted)
released Jun 24th 2017
This version is compatible with:
  • Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >=3.0.0 <5.0.0
  • , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'razorsedge-vmwaretools', '6.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add razorsedge-vmwaretools
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install razorsedge-vmwaretools --version 6.1.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: virtualization, vmware, vmware-tools, vmware-tools, vmtools

Documentation

razorsedge/vmwaretools — version 6.1.0 Jun 24th 2017

VMware Tools Operating System Specific Packages

Build Status

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with this module
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

This Puppet module manages the installation and configuration of the Operating System Specific Packages for VMware Tools. This allows you to use your operating system's native tools to install and update the VMware Tools.

Module Description

This Puppet module manages the installation and configuration of the Operating System Specific Packages for VMware Tools. OSPs are an alternative to the existing mechanism used to install VMware Tools through the VMware vSphere™ Client. With OSPs you can use the native update mechanisms of your operating system to download, install, and manage VMware Tools. With OSPs you can manage VMware Tools from the virtual machine as you would other standard software. VMware Tools OSPs occupy a smaller amount of disk space than the tar installer used with vSphere Client, which makes package installation or uninstallation fast.

Setup

What this module affects

  • Removes old VMwareTools package or runs vmware-uninstall-tools.pl if found.
  • Installs a VMware package repository (defaults to the 'latest' package repository).
  • Installs the OSP VMware Tools.
  • Starts the vmware-tools service.

Requirements

You need to be running a virtual machine on the VMware platform and on an operating system supported by VMware's OSPs 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 installtion of the tools.

include ::vmwaretools

Upgrading

Deprecation Warning

  • Due to the switch to the dependent puppetlabs-apt version 2.x in version 6.0.0 of this module, Puppet 2.7 will no longer be supported.

  • The parameters yum_server, yum_path, and just_prepend_yum_path will be renamed to be reposerver, repopath, and just_prepend_repopath respectively in version 5.0.0 of this module. Please be aware that your manifests may need to change to account for the new syntax.

This:

class { '::vmwaretools':
  yum_server            => 'http://server.example.lan',
  yum_path              => '/dir/v2.3.0',
  just_prepend_yum_path => true,
}

would become this:

class { '::vmwaretools':
  reposerver            => 'http://server.example.lan',
  repopath              => '/dir/v2.3.0',
  just_prepend_repopath => true,
}

Usage

All interaction with the vmwaretools module can be done through the main vmwaretools class. This means you can simply toggle the options in ::vmwaretools to have full functionality of the module.

To set the version to install, set the following parameter:

class { '::vmwaretools':
  tools_version => '4.0u3',
}

Mirror packages.vmware.com to a local host and point the vmwaretools class at it.

class { '::vmwaretools':
  reposerver            => 'http://server.example.lan',
  repopath              => '/dir/v2.3.0',
  just_prepend_repopath => true,
}

Turn off configuration of the software repository so that some other tool (ie RHN Satellite) or class can take care of it.

class { '::vmwaretools':
  manage_repository => false,
}

Reference

Classes

Public Classes

  • vmwaretools: Installs the VMware Tools Operating System Specific Packages.
  • vmwaretools::ntp: Turns off syncTime via the vmware-tools API and should be accompanied by a running NTP client on the guest.

Private Classes

  • vmwaretools::repo: Installs the VMware Tools software repository.

Class: vmwaretools

Main class, includes all other classes.

Parameters

  • ensure: Ensure if present or absent. Default: present

  • autoupgrade: Upgrade package automatically, if there is a newer version. Default: false

  • package: 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_ensure: Ensure if service is running or stopped. Default: running

  • 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_enable: Start service at boot. Default: true

  • service_hasstatus: Service has status command. Only set this if your platform is not supported or you know what you are doing. Default: auto-set, platform specific

  • service_hasrestart: Service has restart command. Default: true

  • tools_version: The version of VMware Tools to install. Possible values can be found here: http://packages.vmware.com/tools/esx/index.html Default: latest

  • disable_tools_version: Whether to report the version of the tools back to vCenter/ESX. Default: true (ie do not report)

  • manage_repository: Whether to allow the repo to be manged by the module or out of band (ie RHN Satellite). Default: true (ie let the module manage it)

  • reposerver: The server which holds the YUM repository. Customize this if you mirror public YUM repos to your internal network. Default: http://packages.vmware.com

  • repopath: The path on reposerver where the repository can be found. Customize this if you mirror public YUM repos to your internal network. Default: /tools

  • just_prepend_repopath: Whether to prepend the overridden repopath onto the default repopath or completely replace it. Only works if repopath is specified. Default: 0 (false)

  • gpgkey_url: The URL where the public GPG key resides for the repository NOT including the GPG public key file itself (ending with a trailing /). Default: ${reposerver}${repopath}/

  • priority: Give packages in this YUM repository a different weight. Requires yum-plugin-priorities to be installed. Default: 50

  • protect: Protect packages in this YUM repository from being overridden by packages in non-protected repositories. Default: 0 (false)

  • proxy: The URL to the proxy server for this repository. Default: absent

  • proxy_username: The username for the proxy. Default: absent

  • proxy_password: The password for the proxy. Default: absent

  • scsi_timeout: This will adjust the scsi timout value set in udev rules. This file is created by the VMWare Tools installer. Defualt: 180

Class: vmwaretools::ntp

This class handles turning off syncTime via the vmware-tools API and should be accompanied by a running NTP daemon on the guest.

Parameters

None

Limitations

OS Support:

VMware Tools Operating System Specific Packages official supported guest operating systems are available for these operating systems:

  • Community ENTerprise Operating System (CentOS)
    • 4.0 through 6.x
  • Red Hat Enterprise Linux
    • 3.0 through 6.x
  • SUSE Linux Enterprise Server
    • 9 through 11
  • SUSE Linux Enterprise Desktop
    • 10 through 11
  • Ubuntu Linux
    • 8.04 through 12.04

Notes:

  • Only tested on CentOS 5.5+ and CentOS 6.2+ x86_64 with 4.0latest.
  • Not supported on Fedora or Debian as these distros are not supported by the OSP.
  • Not supported on RHEL/CentOS/OEL 7+ or SLES 12 as VMware is recommending open-vm-tools instead. Use razorsedge/openvmtools instead.
  • Supports repo proxy, proxy_username, proxy_password, priorities, yum repo protection, and using a local mirror for the reposerver and repopath.
  • Supports not managing the repo configuration via manage_repository => false.
  • No other VM tools (ie Open Virtual Machine Tools) will be supported.

Issues:

  • Does not install Desktop (X Window) components.
  • Does not handle RHEL5 i386 PAE kernel on OSP 5.0+.

Development

Please see CONTRIBUTING.md for information on how to contribute.

Copyright (C) 2012 Mike Arnold mike@razorsedge.org

Licensed under the Apache License, Version 2.0.

razorsedge/puppet-vmwaretools on GitHub

razorsedge/vmwaretools on Puppet Forge