Table of Contents

This is a SIMP module

This module is a component of the System Integrity Management Platform a compliance-management framework built on Puppet.

If you find any issues, they can be submitted to our JIRA.

Module Description

This module installs the tigervnc client and server, and can create VNC Server Sessions

Setup

What simp vnc affects

Packages managed by simp/vnc:

• tigervnc

Ports used by default for VNC Server:

• 5901 (1024x768)
• 5902 (800x600)
• 5903 (1280x1024)

Beginning with VNC

Client Installation

To install the tigervnc client, just include vnc::client

Server Installation

To create a basic VNC server with default ports, include vnc::server

NOTE: You MUST set the following in Hiera to enable XDMCP. VNC will not work without it.

---
gdm::settings:
  xdmcp:
    Enable: true

Usage

I want to create another VNC Connection

# Screensaver timeout in minutes
vnc::server::create {'myconn':
  port => '65000',
  geometry => '1920x1080',
  depth => '32',
  screensaver_timeout => '30',

Development

Please read our Contribution Guide.

Reference

Table of Contents

Classes

• vnc: This does nothing!
• vnc::client: Makes sure the latests vnc package is installed.
• vnc::server: Installs vnc-server, includes GDM for configuration, and sets up some default vnc sessions. NOTE: You MUST set the following in Hiera to e

Defined types

• vnc::server::create: Create a new VNC Server Session Desktop gets set to 'name'.

Data types

• Vnc::Geometry

Classes

vnc

This does nothing!

vnc::client

Makes sure the latests vnc package is installed.

Parameters

The following parameters are available in the vnc::client class:

• package_ensure

package_ensure

Data type: String

The ensure status of tigervnc client package

Default value: simplib::lookup('simp_options::package_ensure', { 'default_value' => 'installed' })

vnc::server

Installs vnc-server, includes GDM for configuration, and sets up some default vnc sessions.

NOTE: You MUST set the following in Hiera to enable XDMCP. VNC will not work without it.

Examples

---
gdm::settings:
  xdmcp:
    Enable: true

Parameters

The following parameters are available in the vnc::server class:

• package_ensure

package_ensure

Data type: String

The ensure status of the tigervnc-server package

Default value: simplib::lookup('simp_options::package_ensure', { 'default_value' => 'installed' })

Defined types

vnc::server::create

Create a new VNC Server Session

Desktop gets set to 'name'.

Examples

vnc::server::create { 'vnc_default':
  port => '5900'
}

Parameters

The following parameters are available in the vnc::server::create defined type:

• port
• geometry
• depth
• screensaver_timeout

port

Data type: Simplib::Port

Port on which you wish to enable the VNC session

geometry

Data type: Vnc::Geometry

Resolution of your VNC session

Default value: '800x600'

depth

Data type: Integer

Specifies the pixel depth, in bits, of the desktop

Default value: 16

screensaver_timeout

Data type: Integer

Time after which to disable the screensaver, in minutes.

Default value: 15

Data types

Vnc::Geometry

The Vnc::Geometry data type.

Alias of Pattern['^\d+x\d+$']

• Wed Oct 11 2023 Steven Pritchard steve@sicura.us - 7.5.0

• [puppetsync] Updates for Puppet 8
  • These updates may include the following:
    • Update Gemfile
    • Add support for Puppet 8
    • Drop support for Puppet 6
    • Update module dependencies

• Thu Aug 31 2023 Steven Pritchard steve@sicura.us - 7.4.0

• Add AlmaLinux 8 support

• Mon Jun 12 2023 Chris Tessmer chris.tessmer@onyxpoint.com - 7.3.0

• Add RockyLinux 8 support

• Thu Jun 17 2021 Chris Tessmer chris.tessmer@onyxpoint.com - 7.2.0

• Removed support for Puppet 5
• Ensured support for Puppet 7 in requirements and stdlib

• Fri Jan 29 2021 Jeanne Greulich jeanne.greulich@onyxpoint.com - 7.1.2

• Added EL8 support after verifying the module worked on EL8 machines.

• Sat Dec 19 2020 Chris Tessmer chris.tessmer@onyxpoint.com - 7.1.2

• Removed EL6 support

• Thu Jul 23 2020 Jeanne Greulich jeanne.greulich@onyxpoint.com - 7.1.1-0

• update the upper bound of simplib for SIMP 6.5 release

• Fri Aug 02 2019 Robert Vincent pillarsdotnet@gmail.com - 7.1.0-0

• Drop Puppet 4 support
• Add Puppet 6 support
• Add puppetlabs-stdlib 6 support

• Wed Feb 13 2019 Liz Nemsick lnemsick.simp@gmail.com - 7.0.1-0

• Use Simplib::Port data type in lieu of deprecated, simplib Puppet 3 validate_port()
• Use new Vnc::Geometry data type in lieu of deprecated, stdlib validate_re()
• Updated a URL in the README.md

• Thu Nov 01 2018 Liz Nemsick lnemsick.simp@gmail.com - 7.0.0-0

• Update the contribution guide URL in the README.md

• Thu Sep 13 2018 Nick Miller nick.miller@onyxpoint.com - 7.0.0-0

• Add support for Puppet 5 and OEL
• Convert docs to yard tags and add reference.md
• Added $package_ensure parameters to vnc::server and vnc::client
  • Changed the packages from 'latest' to 'installed'
  • Each will also respect simp_options::package_ensure

• Fri Jun 22 2018 Trevor Vaughan tvaughan@onyxpoint.com - 7.0.0-0

• Remove automatic setting of the XDMCP setting in GDM - BREAKING
  • It was determined that this should be something that the administrator should explicitly opt into by setting it in the GDM module settings via Hiera since it has security implications

• Tue May 08 2018 Trevor Vaughan tvaughan@onyxpoint.com - 6.0.3-0

• Ensure that the default VNC sessions set the IPv4 flag
• Ensure that the default VNC sessions set the banner to /dev/null

• Thu Jul 06 2017 Liz Nemsick lnemsick.simp@gmail.com - 6.0.2-0

• Confine puppet version in metadata.json

• Wed Jan 02 2017 Chris Tessmer chris.tessmer@onyxpoint.com - 6.0.1-0

• Removed unecessary code and deps after major dep releases
• Locked versions of all build and test deps

• Wed Dec 14 2016 Liz Nemsick lnemsick.simp@gmail.com - 6.0.0-0

• Use simp_options module for global catalysts
• Use strong typed parameters

• Mon Dec 05 2016 Nick Markowski nmarkowski@keywcorp.com - 5.0.1-0

• Replaced xwindows with gdm.

• Tue Nov 22 2016 Jeanne Greulich jgreulich@onyxpoint.com - 5.0.0-0

• Bump major version

• Mon Nov 21 2016 Chris Tessmer chris.tessmer@onyxpoint.com - 4.1.2-0

• Minor cleanup

• Mon Nov 09 2015 Chris Tessmer chris.tessmer@onypoint.com - 4.1.0-4

• migration to simplib and simpcat (lib/ only)

• Mon Apr 06 2015 Trevor Vaughan tvaughan@onyxpoint.com - 4.1.0-3

• Updated to ensure that a banner is not printed since this breaks many clients.

• Thu Feb 19 2015 Trevor Vaughan tvaughan@onyxpoint.com - 4.1.0-2

• Migrated to the new 'simp' environment.

• Fri Jan 16 2015 Trevor Vaughan tvaughan@onyxpoint.com - 4.1.0-1

• Changed puppet-server requirement to puppet

• Fri Apr 04 2014 Nick Markowski nmarkowski@keywcorp.com - 4.1.0-0

• Updated module for puppet3/hiera
• Complies with lint and added rspec tests

• Wed Oct 02 2013 Trevor Vaughan tvaughan@onyxpoint.com - 4.0.0-6

• Use 'versioncmp' for all version comparisons.

• Tue Dec 11 2012 Maintenance 4.0.0-5

• Created a Cucumber test to ensure that vnc and its dependencies install correctly from the vnc module.
• Created a Cucumber test to ensure that the ports 5901, 5902, and 5903 are in state LISTEN and owned by xinetd after vnc::server has been installed and configured.

• Wed Nov 14 2012 Maintenance 4.0.0-4

• Removed tigervnc-server-module from the included packages list since it is not included in RHEL/CentOS 6.3 by default and is not needed for Xvnc performance.

• Wed Apr 11 2012 Maintenance 4.0.0-3

• Moved mit-tests to /usr/share/simp...
• Updated pp files to better meet Puppet's recommended style guide.

• Fri Mar 02 2012 Maintenance 4.0.0-2

• Improved test stubs.

• Mon Dec 26 2011 Maintenance 4.0.0-1

• Updated the spec file to not require a separate file list.

• Wed Nov 02 2011 Maintenance 4.0.0-0

• Updated to handle RHEL6

• Mon Jun 06 2011 Maintenance - 2.0.0-1

• Added -audit 4 and a variable screensaver timeout to the VNC spawned X sessions.

• Tue Jan 11 2011 Maintenance - 2.0.0-0

• Refactored for SIMP-2.0.0-alpha release

• Tue Oct 26 2010 Maintenance - 1-1

• Converting all spec files to check for directories prior to copy.

• Mon May 24 2010 Maintenance 1.0-0

• Code refactoring.

• Thu Oct 1 2009 Maintenance 0.1-0

• Initial Release
• You must have vncserver >= 4.1.2-14.el5_3.1 for VNC to work properly!