REFERENCE.md

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+$']