vnclicense - VNC® Server licensing utility
applies license key(s) to VNC Server, and performs related auxiliary operations. Note at least
one license key must be applied in order that VNC Viewers may connect. Visit
http://www.realvnc.com/products/vnc/documentation/latest/licensing-faq/ for more on licensing.
Run vnclicense -add KEY to apply a license key. Note this operation can also be performed via
the VNC Server user interface. KEY must either be:
A license key code consisting of 25 alphanumeric characters, divided by hyphens into 5 groups of 5
each, for example XXXXX-XXXXX-XXXXX-XXXXX-XXXXX.
A license key file with a .vnclicense extension, containing a license key with a serial number
and a signature from RealVNC.
Run vnclicense -check to see how many desktops you are licensed to remote, how many
instances of VNC Server are currently running in order to provide these desktops, and by whom they were started.
Run vnclicense -reload to reconfigure all running instances of VNC Server simultaneously,
Valid commands are documented in full below:
- -add KEY
Applies KEY to VNC Server; note vnclicense must be run with elevated privileges.
By default, a form of the license key (modified to incorporate the MAC address) is stored
in /etc/vnc (in a licensekey file for a license key code, and in
the licensekeys directory for a license key file).
Note that if VNC is hosted on a network share, you should specify the LicenseDir VNC
parameter to nominate /<install-dir>/vnc/ instead; see OPTIONS for more information.
Displays the total number of desktops you are licensed to remote. If you have multiple license keys,
the overall total is constrained by the license key valid for the fewest desktops. The number of
desktops equates to the number of times VNC Server can be started (in any mode).
- -info XXXXX-XXXXX-XXXXX-XXXXX-XXXXX | serial-number
Lists the features, number of desktops, and expiry dates (if any) of a particular license key.
To find out the serial-number of a license key file, use -list. To find out the 25
characters of a license key code, consult your original email from RealVNC.
Lists the features, number of desktops, and expiry dates (if any) of all license keys, in the order
they were applied to VNC Server.
Re-applies all license keys and VNC configuration files to all running instances of VNC Server
started by the current user. Run vnclicense -reload with elevated privileges to
do the same for all users.
See also OPTIONS.
- -remove [order-number | XXXXX-XXXXX-XXXXX-XXXXX-XXXXX | serial-number ]
Removes a particular license key; note elevated privileges are required. You can omit the argument if
only one license key has been applied.
To find out the order-number of a license key, or the serial-number of a license key file,
use -list. To find out the 25 characters in a license key code, consult your original email from RealVNC.
Options are VNC parameters, and also the following:
Use as an option in order to cause an -add or -remove operation to take effect immediately,
vnclicense -reload -add KEY
If omitted, a license key may not be applied until a VNC Viewer connects, or until an hourly check
To see a list of valid VNC parameters, run vnclicense -help.
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.