openvmtools
Version information
This version is compatible with:
- Puppet Enterprise 3.x
- Puppet >=2.7.20 <4.0.0
- , , , , , , ,
This module has been deprecated by its author since Aug 4th 2022.
The author has suggested puppet-openvmtools as its replacement.
Start using this module
Documentation
#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.
- 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 installtion 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
- openvmtools: Installs the Open Virtual Machine Tools.
###Parameters
The following parameters are available in the openvmtools module:
####with_desktop
Whether or not to install the desktop/GUI support. Default: false
####ensure
Ensure if present or absent. Default: present
####autoupgrade
Upgrade package automatically, if there is a newer version. Default: false
####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
####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
####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_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
##Limitations
###OS Support:
open-vm-tools is available with these operating systems:
- Debian 7.x and later releases
- Recent Ubuntu releases (12.04 LTS, 13.10 and later)
- openSUSE 11.x and later releases
- SUSE Linux Enterprise 12 and later releases
- Fedora 19 and later releases
- Red Hat Enterprise Linux 7.0 and later releases
- CentOS 7
- Oracle Linux 7
###Notes:
- No other VM tools (ie Operating System Specific Packages) will be supported. Use razorsedge/vmwaretools instead.
###Issues:
- None
##Development
Please see DEVELOP.md for information on how to contribute.
Copyright (C) 2015 Mike Arnold mike@razorsedge.org
Licensed under the Apache License, Version 2.0.
2015-04-10 Michael Arnold github@razorsedge.org - 1.0.0
Michael Arnold github@razorsedge.org (3):
- Add the pattern parameter to the service resource.
- Fix errors in README.markdown.
- Update versions for 1.0.0 release.
2015-04-01 Michael Arnold github@razorsedge.org - 0.2.0
Michael Arnold github@razorsedge.org (4):
- Fixing Debian and Ubuntu $service_name.
- Fix Debian and Ubuntu $desktop_package_name.
- Update metadata summary.
- Update versions for 0.2.0 release.
2015-03-31 Michael Arnold github@razorsedge.org - 0.1.0
Michael Arnold github@razorsedge.org (3):
- Created a shiney new module.
- Fix errors in the README.markdown.
- Update versions for 0.1.0 release.
2015-03-28 Michael Arnold github@razorsedge.org - 0.0.0
Dependencies
- puppetlabs/stdlib (>=2.3.0 <5.0.0)
Copyright (C) 2015 Mike Arnold <mike@razorsedge.org> 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.