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.
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.
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.
It is safe for all nodes to use this declaration. Any non-VMware or unsupported system will skip installtion of the tools.
include ::vmwaretools
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,
}
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,
}
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.vmwaretools::repo
: Installs the VMware Tools software repository.vmwaretools
Main class, includes all other classes.
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
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.
None
VMware Tools Operating System Specific Packages official supported guest operating systems are available for these operating systems:
manage_repository => false
.Please see CONTRIBUTING.md for information on how to contribute.
Copyright (C) 2012 Mike Arnold [email protected]
Licensed under the Apache License, Version 2.0.