NAME

vncserver-virtuald - VNC® Server in Virtual Mode daemon  

SYNOPSIS

vncserver-virtuald [OPTION...] [COMMAND]  

DESCRIPTION

vncserver-virtuald is a daemon that starts VNC Server in Virtual Mode for each VNC Viewer that connects, in order to create virtual desktops on demand. The daemon can be started manually, but is designed to be started automatically at system boot time; see STARTING THE DAEMON. Note that an Enterprise license is required.

By default, the daemon listens for connections on port 5999; specify the DaemonPort VNC parameter to choose a different port. Also by default, a VNC Viewer can connect by supplying the credentials of any user able to log on to the computer (the daemon mandates system authentication); specify the Permissions VNC parameter to restrict access to particular users or groups.

For each successfully-authenticating VNC Viewer, the daemon runs vncserver-virtual; see vncserver-virtual(1). The daemon then transfers the connection to the newly-created virtual desktop and consumes one desktop from your license, as that user. The daemon itself does not consume a desktop.

When a VNC Viewer disconnects, their virtual desktop is destroyed. Your license is incremented by one desktop. If a VNC Viewer reconnects using the same credentials, a new virtual desktop is created; a session does not persist.  

COMMANDS

Applying a command to vncserver-virtuald performs an auxiliary operation instead of starting the daemon.

To see a list of valid commands, run vncserver-virtuald -help.  

OPTIONS

Options are VNC parameters, used to configure the daemon, and also the following:
-fg
Runs in the foreground (not as a daemon), which may be useful for troubleshooting.

To see a list of valid VNC parameters, run vncserver-virtuald -help.  

VNC CONFIGURATION FILES

VNC parameters can be specified as command line OPTIONS, but preferably in VNC configuration files. VNC configuration files are available for:
o
All VNC applications, or just the daemon
o
All users of the computer, or just the root user
o
Policy, in order to lock down the daemon

When the daemon starts, VNC parameters are applied in the following order:

1
System-wide VNC configuration files
2
Per-user VNC configuration files
3
Command line OPTIONS
4
Policy VNC configuration files

This means that a particular VNC parameter specified at the command line overrides the same parameter specified in a per-user or in a system-wide VNC configuration file, but is itself overridden by the same parameter specified in a policy VNC configuration file. Policy cannot be changed by users.

Note there is a disadvantage to specifying VNC parameters at the command line: parameters cannot be reloaded while the daemon is running. VNC configuration files can be reloaded, however, which means that the daemon can be reconfigured without downtime.

For a list of the VNC configuration files available for the daemon, and for detailed explanations of individual VNC parameters, start with
http://www.realvnc.com/products/vnc/documentation/latest/guides/user/am1082101.html#Ram86607

Note that an equivalent set of VNC configuration files is available for each instance of vncserver-virtual started by the daemon. To configure activities related to a particular session, edit VNC configuration files for Xvnc owned by the appropriate user.  

STARTING THE DAEMON

A suitable init file should have been installed with VNC Server; see vncinitconfig(1). To start the daemon manually:
o
For a Linux distribution using systemd, run systemctl start vncserver-virtuald.service
o
For a Linux distribution using initd, run /etc/init.d/vncserver-virtuald start
o
For a Debian-compatible Linux distribution using initd, (alternatively) run service vncserver-virtuald start

To start the daemon automatically at system boot time, use the appropriate configuration tool for your system:

o
For a Linux distribution using systemd, run systemctl enable vncserver-virtuald.service
o
For a Debian-compatible Linux distribution using initd, run update-rc.d vncserver-virtuald defaults
o
For a Red Hat-compatible Linux distribution using initd, run chkconfig --add vncserver-virtuald

For UNIX systems, please consult the appropriate startup script documentation.  

LOGGING

By default, vncserver-virtuald logs basic activity to file at /var/log/vncserver-virtuald.log.

To change the log quality, quantity, or destination, specify the Log, LogDir, and LogFile VNC parameters.  

SEE ALSO

vncserver-virtual(1), vnclicense(1), vncinitconfig(1), vncpasswd(1), vncviewer(1)  

AUTHOR

Copyright © 2002-2014 RealVNC Ltd.

VNC is a registered trademark of RealVNC Ltd. in the U.S. and in other countries. Protected by UK patent 2481870.

http://www.realvnc.com