TheGreenBow VPN Client Software - Deployment Guide
TheGreenBow VPN Client Software - Deployment Guide
Deployment Guide
WebSite: http://www.thegreenbow.com
Contact: support@thegreenbow.com
Table of Content
1 Introduction ..................................................................................................................................................... 3
2 VPN Client Software Deployment ................................................................................................................... 4
2.1 What is a "silent" VPN Client Setup ....................................................................................................... 4
2.2 How to create a "silent" VPN Client Setup? ........................................................................................... 4
2.3 How to Deploy a VPN Client Setup from a CD-Rom? ............................................................................ 5
2.4 How to run a VPN Client Setup from a shortcut (double-clic on an icon)? ............................................. 5
2.5 How to Deploy a VPN Client Setup using Batch script........................................................................... 6
2.6 How to Deploy a VPN Client Setup from a Network Drive? ................................................................... 6
2.7 How to deploy a VPN Client Software Update? ..................................................................................... 7
3 VPN Client software customized for end-users .............................................................................................. 8
3.1 Introduction to VPN Client Setup customization for end-users? ............................................................ 8
3.2 How to limit VPN Client usage to Connection Panel from software menus?.......................................... 8
3.3 How to limit VPN Client usage to Connection Panel within VPN Client Setup? ..................................... 9
3.4 How to limit VPN Client usage to Connection Panel from the installation? ............................................ 9
3.5 How to limit VPN Client usage to the systray icon from the installation? ............................................. 10
4 VPN Configuration Deployment .................................................................................................................... 11
4.1 How to embed a specific VPN configuration into the VPN Client Setup?............................................. 11
4.2 How to deploy a new VPN Configuration? ........................................................................................... 11
4.3 How to protect a VPN Configuration before deployment?.................................................................... 11
5 VPN Automations ......................................................................................................................................... 13
5.1 How to create a batch/script that automatically opens or closes a tunnel? .......................................... 13
5.2 How to automatically open a web page when the VPN tunnel opens? ................................................ 13
5.3 How to open a tunnel with a double-clic on a desktop icon?................................................................ 14
5.4 How to configure a "Dial-up" tunnel? ................................................................................................... 14
5.5 What is the difference between "/import" and "/importonce"? .............................................................. 14
6 Reference Manual ........................................................................................................................................ 15
6.1 VPN Client Setup command line options ............................................................................................. 15
6.2 VPN Client software command line options ......................................................................................... 17
7 Support ......................................................................................................................................................... 20
1 Introduction
TheGreenBow VPN Client software is designed to be easily deployed and managed. It implements several
functionnalities which enable the IT Manager to pre-configure the setup before deployment, to remotely install or
upgrade the software, and to centrally manage VPN Configurations.
This document describes the management and configuration options of TheGreenBow VPN Client. It especially
describes a set of use cases which illustrate the way to manage the software. These use cases are describes in
"How to" items, summarized below.
Various options can be configured during the installation process of TheGreenBow VPN Client:
License number
VPN Client start mode
Invisible graphical user interface
Activation email
and others..
Additional options can be used with the software itself, for example, once the installation is completed:
VPN Configuration importation
Start/Stop the software
Start/Stop a VPN tunnel
and others..
All features described in this document are applicable to TheGreenBow IPSec VPN Client 4.2 and further.
For previous software release, look on our website for a previous version of this document.
To improve the transparency of the installation, the VPN Client Setup enables the use of command line options,
which may be used to customize this installation. These command line options are fully detailed in the annexe,
and are also described in the following various use cases.
A silent installation uses a set of installation parameters which are provided via command line options.
The following chapters describe the way to configure the installation configuration file and the meaning of each
available command line options.
Usage: Enables a silent installation (no dialog are displayed to the user during the installation)
Example:
C:\Users\bob\Downloads\TheGreenBow_VPN_Client.exe /S --lang=1036 --
license=123456789 --start=1 /D=c:\Program
Files\TheGreenBow\TheGreenBow VPN
Note: the directory specified after the /D switch must be specified entirely. This switch doesn't recognize a
relative directory. The /D switch MUST be the last switch in the command line.
Note: Command-line options that require a parameter must be specified with no space between the option and its
parameter. Quotation marks around an option's parameter are required only if the parameter contains spaces,
except for [install path] which do NOT need quote if there are spaces in the path.
Example:
p Copy the content of the setup directory and the autorun.inf file in the root directory of the CD-Rom.
Note: See section 6.1 for details about the available command line options.
2.4 How to run a VPN Client Setup from a shortcut (double-clic on an icon)?
n Create a "silent" VPN Client Setup (see section 2.2)
o Right-click on the "setup.exe" file in the setup directory, and from the pop-up menu, select "Create Shortcut".
This will create a shortcut to "setup.exe" in the setup directory.
p Right-click on the new shortcut, and from the pop-up menu, select Properties.
In the Target field, add the following options to the command line /S --start=1 --lang=1036 --
license=123456789 /D=[install path] (see details on section 2.2).
Example:
“C:\Users\bob\Downloads\TheGreenBow_VPN_Client.exe /S --lang=1036 --
license=123456789 --start=1 /D=c:\Program Files\TheGreenBow\TheGreenBow
VPN”
q Move the shortcut where it can be clicked by the user (e.g. on the desktop)
Example:
cd .\setup
setup.exe /S –-lang=1036
cd ..
copy myvpnconfig.tgb C:\Program Files\TheGreenBow\TheGreenBow VPN
cd C:\Program Files\TheGreenBow\TheGreenBow VPN
vpnconf.exe /importonce:myvpnconfig.tgb
(1) in this example, the setup directory is called "setup" and is located under the directory containing the batch
file.
(2) in this example, a VPN Configuration is imported at the end of the installation. See further sections for details
about the import capabilities of the VPN Client Software.
p Deploy this file (from a server or on an USB stick) together with the setup directory to the users.
o Right-click on the "setup.exe" file in the setup directory, and from the pop-up menu, select "Create Shortcut".
This will create a shortcut to "setup.exe" in the setup directory.
p Right-click on the new shortcut, and from the pop-up menu, select Properties.
In the Target field, add the following options to the command line: /S --start=1 --lang=1036 --
license=123456789 /D=[install path] (see details on section 2.2).
Example:
q Move the shortcut where it can be clicked by the user (e.g. on the desktop)
We’ve changed our installation software, therefore we shall consider two cases for silent installation of software
upgrades.
1) Upgrade from any software release prior to TheGreenBow IPSec VPN Client 4.2: the un-installation can
NOT be silent and the user will have to click on ‘Accept un-installation’ and ‘Close’ (without reboot) at the end of
un-installation. The rest of upgrade installation will be silent.
2) Upgrade from TheGreenBow IPSec VPN Client 4.2 software release and further: the whole un-install and
installation is silent, no action required from user. Just launch silent installation for the new software release.
These modes enable the IT Manager to hide the configuration part of the software, in order to show a very simple
interface to end-users, while preventing mis-use of the VPN configuration from end-users.
Note: The VPN Configuration is signed and encrypted. Any manual editing of the file disables the VPN
Configuration.
This section describes the VPN Client setup or VPN Client software options which enable to hide or limit the
interface of the software.
3.2 How to limit VPN Client usage to Connection Panel from software menus?
The Configuration Panel can be hidden or protected with a password. This mode can be configured from the
software:
n In the Configuration Panel, go to the menu "View > Configuration", enter and confirm a password. It is also
possible to limit the number of items in the systray menu.
3.3 How to limit VPN Client usage to Connection Panel within VPN Client Setup?
n Add the option "--guidefs=user" to the setup command line (see details section 6.1).
Example: “TheGreenBow_VPN_Client.exe /S --guidefs=user /D=c:\Program
Files\TheGreenBow\TheGreenBow VPN”
TheGreenBow IPSec VPN Client will start showing the "Connection Panel" after the installation reboot.
3.4 How to limit VPN Client usage to Connection Panel from the installation?
n Add the option "--guidefs=user" to the setup command line (see details section 6.1).
o Add the option "--password=mypassword" to the setup command line.
Example: “TheGreenBow_VPN_Client.exe /S --guidefs=user --
password=group2 /D=c:\Program Files\TheGreenBow\TheGreenBow VPN”
TheGreenBow IPSec VPN Client will start showing the "Connexion Panel" after the installation reboot, and the
user won't be able to open the Configuration Panel, which is protected by the password.
3.5 How to limit VPN Client usage to the systray icon from the installation?
n Add the option "--guidefs=hidden" to the setup command line (see details section 6.1).
o Add the option "--password=mypassword" to the setup command line.
Example: “TheGreenBow_VPN_Client.exe /S --guidefs=user --
password=group2 /D=c:\Program Files\TheGreenBow\TheGreenBow VPN”
TheGreenBow IPSec VPN Client will start only showing the systray icon after the installation reboot, and the user
won't be able to open the Configuration Panel, nor the Connection Panel, which are protected by the password. It
will only be able to open/close VPN tunnels via the systray menu.
4.1 How to embed a specific VPN configuration into the VPN Client Setup?
The VPN Client Setup enables the IT Manager to embed a pre-configured VPN Configuration. This VPN
Configuration will be automatically used by the VPN Client during the installation process.
Important: The exported VPN Configuration must not be protected with a password.
pAdd the VPN Configuration (duly configured "conf.tgb" file) to the directory where you intend to put setup on
the target computer (i.e. where software will be installed). In case you intend to deploy software on an USB drive,
copy the VPN Configuration onto the USB drive together with the setup software.
q Deploy the package to the user (the ".tgb" VPN Configuration is imported during the setup) and execute the
setup.
p Give the VPN Configuration to the end-user, either by email, or through file-sharing.
q When the user opens the VPN Configuration (e.g. he opens the email attachment), he will be automatically
asked for the password, and as the password is correctly entered, the VPN Configuration will be automatically
imported and applied by TheGreenBow VPN Client.
The exported VPN Configuration is encrypted. When the user will open it, he will be automatically asked for the
password.
5 VPN Automations
This script will start the VPN Client software with "MyTunnel" VPN Configuration, and will automatically open the
tunnel.
5.2 How to automatically open a web page when the VPN tunnel opens?
n Create a VPN Configuration
oOpen the Phase2 "Scripts" window, and set the url of the web page (internet or Corporate Intranet) in the
field: "Launch this script when this tunnel opens". See exemple below.
p Save the configuration and open the tunnel: the web page is automatically opened as soon as the tunnel is
opened.
n Create a VPN Configuration with "Open automatically when Client starts" selected for the relevant Phase 2
(Advanced Phase2 dialog)
o Export the VPN Configuration in a file (e.g. "MyTunnel.tgb"), and copy, move or shortcut this file on the
desktop.
A double-clic (open) on the desktop icon will run the VPN Client software with the VPN Configuration "MyTunnel",
which will automatically open the tunnel.
6 Reference Manual
Warning: all the options below must be used together with the option “/S" (silent mode).
Note: Command-line options that require a parameter must be specified with no space between the option and its
parameter. Quotation marks around an option's parameter are required only if the parameter contains spaces.
6.1.3 --license
Syntax: --license=[license_number] ("license" must be preceded by 2 dashes)
Usage: Enables to configure the license number. The license number can be a set of 24 or 20 hexadecimal
characters, depending of the software release.
Example: TheGreenBow_VPN_Client.exe --license=1234567890ABCDEF12345678
6.1.4 --start
Syntax: --start=[1|2] ("start" must be preceded by 2 dashes)
Usage: Enables to configure the start mode for the VPN Client: after the logon windows [1], or manually [2].
Default is [1].
Example: TheGreenBow_VPN_Client.exe -–start=2
6.1.5 --guidefs
Syntax: --guidefs=[full|user|hidden] ("guidefs" must be preceded by 2 dashes)
Usage: Enables to define the GUI appearance when the VPN Client software starts.
"full": The Configuration Panel is displayed. Default.
"user": The Connection Panel is displayed.
"hidden": The Configuration Panel and Connection Panel cannot be displayed. Only the systray menu can be
opened. Tunnels can be opened with the systray menu.
Example: TheGreenBow_VPN_Client.exe ––guidefs=hidden
6.1.6 --activmail
Syntax: --activmail=[activation_email] ("activmail" must be preceded by 2 dashes)
Usage: Enables to force the email used for activation confirmation. During the activation process, the edit box
used for entering this email will be disabled
Example: TheGreenBow_VPN_Client.exe -–activmail=salesgroup@company.com
6.1.7 --menuitem
Syntax: --menuitem=[0..31] ("menuitem" must be preceded by 2 dashes)
Usage: Enables to configure the items of the systray menu. The value is a bitfield, where each bit defines a
menuitem: 1 (1st bit)=Quit, 2 (2nd bit)=Connection panel, 4 (3rd bit)=Console, 8 (4th bit)=Save&Apply, 16 (5th
bit)=Configuration panel. Default is 31 (1F) : All menus.
Example: TheGreenBow_VPN_Client.exe --menuitem=3 will only show the "Quit" and
"Connections" menu items.
Note 1: the tunnels are always shown in the systray menu, and can always be opened and closed from this
systray menu.
6.1.8 --password
Syntax: --password=[password] ("password" must be preceded by 2 dashes)
Usage: Enables to control the access to the VPN GUI with a password.
The user will be asked for the password:
- when the user clicks or double-clicks on the VPN systray icon.
- when the user wants to switch from the Connection panel to the Configuration panel.
Example: TheGreenBow_VPN_Client.exe --password=adm253q
6.1.9 --autoactiv
Syntax: --autoactiv=1
Usage: In case of software upgrade (i.e. license number and activation email have already been entered in
previous installation) and --autoactiv=1 option is added, the software will try to activate software automatically
when starting if network is available or when requesting to open a tunnel if network was not available at startup.
Example: TheGreenBow_VPN_Client.exe --autoactiv=1
Note: The option –-autoactiv must be the last option in the command line.
6.1.10 --noactiv
Syntax: --noactiv=1
Usage: No display of the ‘Trial window’ once software started until trial period ends. User doesn’t know he is in
trial period and software will be disabled at the end of trial period. It means that if the user tries to launch the
software after the end of trial period, the software will start and open the ‘Trial window’ but the ‘Evaluate’ button
will be disabled.
Example: TheGreenBow_VPN_Client.exe --noactiv=1
6.1.11 --lang
Syntax: --lang=[language code]
Usage: This option specifies the language for the TheGreenBow IPSec VPN Client software and installation
software. Available languages are listed below.
Example: TheGreenBow_VPN_Client.exe --lang=1040 will start software in Italian.
where …
• "install_directory" is the installation directory of the VPN Client software.
• “value” does not require double quote if there it does not contain space characters.
• All available command line “options” are detailed below.
6.2.1 /import
Syntax: /import:[ConfigFileName]
Usage: Enables the VPN Client to import a VPN Configuration. If the VPN Client software is not running, it is
automatically started by this option. Thus, this option may be used to start the VPN Client with a given VPN
Configuration.
If the VPN Client software is running, this option imports and updates the VPN Configuration without stopping the
software.
[ConfigFileName] must be enclosed in double-quotes if it contains space characters.
Example: vpnconf.exe /import:"c:\my documents\myvpnconf.tgb"
From software release 4.1 and older, the user is asked for adding or replacing the new VPN Configuration. To
avoid this question, /import can be replaced by the options /add or /replace described below.
6.2.2 /importonce
Syntax: /importonce:[ConfigFileName]
Usage: Enables the VPN Client to import a VPN Configuration. If the VPN Client software is not running, it won't
be started by this option. Thus, this option may be used to import a given VPN Configuration without starting the
VPN Client, for example within an installation script.
If the VPN Client software is running, this option imports and updates the VPN Configuration without stopping the
software.
[ConfigFileName] must be enclosed in double-quotes if it contains space characters.
Example: vpnconf.exe /importonce:"c:\my documents\myvpnconf.tgb"
From software release 4.1 and older, the user is asked for adding or replacing the new Configuration. To avoid
this question, /importonce can be replaced by the options /add or /replace described below.
6.2.3 /export
Syntax: /export:[ConfigFileName]
Usage: Enables the VPN Client to export a VPN Configuration. If the VPN Client software is not running, it is
automatically started by this option.
If the VPN Client software is running, this option exports the VPN Configuration without stopping the software.
[ConfigFileName] must be enclosed in double-quotes if it contains space characters.
Example: vpnconf.exe /export:"c:\my documents\myvpnconf.tgb"
6.2.4 /exportonce
Syntax: /exportonce:[ConfigFileName]
Usage: Enables the VPN Client to export a VPN Configuration. If the VPN Client software is not running, it won't
be started by this option.
If the VPN Client software is running, this option exports the VPN Configuration without stopping the software.
[ConfigFileName] must be enclosed in double-quotes if it contains space characters.
Example: vpnconf.exe /exportonce:"c:\my documents\myvpnconf.tgb"
6.2.5 /pwd
Syntax: /pwd:[Password]
Usage: Enables to set a password for import operations. This option can be used together with the /import,
/importonce, /export, /exportonce, /add and /replace options but it must be placed after one of those options.
Example: vpnconf.exe /import:"c:\my documents\myvpnconf.tgb" /pwd=mypwd
6.2.6 /stop
Syntax: /stop
Usage: Enables to exit the VPN Client and close the opened VPN tunnels
Example: vpnconf.exe /stop
6.2.7 /add
Syntax: /add:[ConfigFileName]
Usage: Enables to add a VPN Configuration to the current configuration. This feature is available in software
release 4.1 and older, and may be used instead of the /importonce option.
Example: vpnconf.exe /add:"c:\my documents\myvpnconf.tgb"
6.2.8 /replace
Syntax: /replace:[ConfigFileName]
Usage: Enables to replace the current configuration by a new VPN Configuration. This feature is available in
software release 4.1 and older, and may be used instead of the /importonce option.
Example: vpnconf.exe /replace:"c:\my documents\myvpnconf.tgb"
6.2.9 /open
Syntax: /open:[NamePhase1-NamePhase2]
Usage: Enables to open a VPN tunnel.
Example: vpnconf.exe /open:Corporate-gateway1
6.2.10 /close
Syntax: /close:[NamePhase1-NamePhase2]
Usage: Enables to close a VPN tunnel.
Example: vpnconf.exe /close:”Home gateway-cnx1” (double quote required because name
contains a space charactere).
7 Support