Table Of Contents
Customizing the VPN Client Software
Customizing the VPN Client Using an MSI Transform
Creating the Transform
Installing the VPN Client Using the Transform
Installing the VPN Client Without User Interaction
Silent Installation Using MSI
Launching SetMTU with Silent Installation
Customizing the VPN Client GUI for Mac OS X
Customizing the VPN Client Software
This chapter explains how to replace the Cisco Systems brand with your own organization's brand. When you install and launch the VPN Client software, you see your own organization name, program name, and application names on menus, windows, dialogs, and icons.
For the Windows platform, it also explains how to set up the software so that your users can install it automatically without being prompted. This feature is called silent install.
To customize the VPN Client software, you create your own distribution image combining the following elements, which this chapter describes.
For all platforms, you can customize the following:
•
Cisco Systems image that you receive on the Cisco Systems software distribution CD.
•Your own portable network graphics (PNG) (Table 10-1) and icon files to replace the Cisco Systems brand.
•A vpnclient.ini file for configuring the VPN Client software globally (see Chapter 5, "Preconfiguring the VPN Client for Remote Users").
•Individual profile (.pcf) files for each connection entry (see Chapter 5, "Preconfiguring the VPN Client for Remote Users").
Table 10-1 lists the GUI image (portable network graphic) files that the VPN Client uses. If you want to replace any of them with your own image files, you must name your image files exactly as shown in the list; otherwise, the VPN Client GUI does not recognize them.
Table 10-1 Portable Network Graphic Files
PNG File
|
Description
|
splash_screen.png
|
Splash screen that appears for 2 to 5 seconds when the GUI starts. This screen contains a logo, product name and version, and copyright information.
Rebranded splash-screen graphics must be at least 280 pixels wide to accommodate the box that displays the status text. There must be a full-width blank area at the bottom of the graphic at least 36 pixels in height.
|
title_bar.png
|
Image at the left end of the title bar
|
connected.png
|
Image next to connection entry when connection is active
|
logo.png
|
Organization logo for simple and advanced mode main dialogs
|
password_logo.png
|
Organization logo for password dialog (XAuth), group name and password)
|
profile_logo.png
|
Organization logo for new/modify profile dialog
|
status_down_arrow.png
|
Down arrow on the status bar of advanced mode, used to change the status bar display
|
cancel.png
|
Cancel button on advanced mode connection entries toolbar
|
connect_pressed.png
|
Connect button pressed on advanced mode connection entries toolbar
|
disconnect.png
|
Disconnect button on advanced mode connection entries toolbar
|
disconnect_pressed.png
|
Disconnect button pressed on advanced mode connection entries toolbar
|
new_profile.png
|
New button on advanced mode connection entries toolbar
|
new_profile_pressed.png
|
New button pressed on advanced mode connection entries toolbar
|
import_profile.png
|
Import button on advanced mode connection entries toolbar
|
import_profile_pressed.png
|
Import button pressed on advanced mode connection entries toolbar
|
modify_profile.png
|
Modify button on advanced mode connection entries toolbar
|
modify_profile_pressed.png
|
Modify button pressed on advanced mode connection entries toolbar
|
delete_profile.png
|
Delete button on advanced mode connection entries toolbar
|
delete_profile_pressed.png
|
Delete button pressed on advanced mode view certificates toolbar
|
import_certificate.png
|
Import button on advanced mode view certificates toolbar
|
import_certificate_pressed.png
|
Import button pressed on advanced mode view certificates toolbar
|
export_certificate.png
|
Export button on advanced mode view certificates toolbar
|
export_certificate_pressed.png
|
Export button pressed on advanced mode view certificates toolbar
|
delete_certificate.png
|
Delete button on advanced mode view certificates toolbar
|
delete_certificate_pressed.png
|
Delete button pressed on advanced mode view certificates toolbar
|
enroll_certificate.png
|
Enroll button on advanced mode view certificates toolbar
|
enroll_certificate_pressed.png
|
Enroll button pressed on advanced mode view certificates toolbar
|
verify_certificate.png
|
Verify button on advanced mode view certificates toolbar
|
verify_certificate_pressed.png
|
Verify button pressed on advanced mode view certificates toolbar
|
show_certificate.png
|
Show button on advanced mode view certificates toolbar
|
show_certificate_pressed.png
|
Show button pressed on advanced mode view certificates toolbar
|
enable_log.png
|
Enable button on advanced mode connection entries toolbar
|
enable_log_pressed.png
|
Enable button pressed on advanced mode view log toolbar
|
disable_log.png
|
Disable button on advanced mode view log toolbar
|
disable_log_pressed.png
|
Disable button pressed on advanced mode view log toolbar
|
clear_log.png
|
Clear button on advanced mode view log toolbar
|
clear_log_pressed.png
|
Clear button pressed on advanced mode view log toolbar
|
options_log.png
|
Options button on advanced mode view log toolbar
|
options_log_pressed.png
|
Options button pressed on advanced mode view log toolbar
|
show_log.png
|
Show button on advanced mode view log toolbar
|
show_log_pressed.png
|
Show button pressed on advanced mode view log toolbar
|
arrow_up.png
|
Up Arrow button in Backup Servers tab of the new/modify profile dialog
|
arrow_down.png
|
Down Arrow button in Backup Servers tab of the new/modify profile dialog
|
You can also replace the following icon files (as long as your icon files have these same names):
•connected.ico—the tray icon when connected (also in resource file for vpngui.exe icon)
•unconnected.ico—the tray icon when not connected
•disconnecting.ico—the tray icon when disconnecting
Customizing the VPN Client Using an MSI Transform
This section describes how to customize VPN Client installation using a transform for the MSI. To customize the applications, you need both a transform and an oem.ini file.
Caution Do not modify the MSI file. To customize MSI, use a transform. Failure to follow recommended procedure will limit the level of support you can expect from Cisco.
Creating the Transform
To create the transform, you edit the vpnclient_setup.msi file. You can create the transform with any commercially available MSI installation package, such as Wise. The procedure in this section uses the Microsoft ORCA editor available from the Microsoft Windows Installer SDK. The version used here is from Microsoft Platform SDK November 2001. So before you begin, make sure that ORCA is installed on your system. If you need information on transforms and ORCA, refer to the ORCA documentation.
Note For information on using Orca, see the Microsoft technical note "How to Create or Modify a Transform Using Microsoft Orca".
Note This section does not include instructions on using ORCA. Do not attempt the following procedure unless you have experience using ORCA. If you are unfamiliar with ORCA, we recommend that you use an MSI installation package, such as Wise.
Here is the procedure:
Step 1 Start ORCA.
Step 2 Select File > Open and enter vpnclient_setup.msi.
Step 3 Select Transform > Apply Transform and select oem.mst, the transform template.
To customize oem.mst, you modify some of the information you see in the tables. The parts to modify have green change bars on the left side of the row.
Table 10-2 outlines the changes to make in the tables in the oem.mst file. The columns in the table are defined as follows:
•Table Name—the name of the table to edit
•Changes Needed—a list of the changes to make to the table
•Install Requirement—the entries that modify the installation software
•Client Requirement—the entries that modify the way the VPN Client operates at runtime
Table 10-2 Oem.mst Tables
Table Name
|
Changes Needed
|
|
Modifies Install Parameters
|
Modifies VPN Client Runtime Parameters
|
Binary
|
top16—Add your own 500x63 bitmap for the MSI Install
side16—Add you own 501x314 bitmap for the MSI Install
|
|
Yes for both
|
No for both
|
Component
|
CsCoFile_OemFiles—needed to install oem.ini file for custom VPN Clients
CsCoFile_oempngFiles—needed to install icons, bitmaps, and png files
|
|
No
|
Yes
|
Directory
|
INSTALLDIR—Change to your own directory
INSTALLDIR2—Change to your own directory
Cisco_Systems_VPN_Client— Change to your own folder name
|
|
Yes for all
|
No for all
|
Feature
Components
|
Complete | CsCoFile_OemFiles—needed to install oem.ini file for custom VPN Clients
CsCoFile_oempngFiles—needed to install icons, bitmaps, and png files
|
|
No
|
Yes
|
File
|
Add the following files for customizing the VPN Client. For examples, see the oem.mst transform and the oem.ini files.
arrow_down.png
arrow_up.png
cancel.png
cancel_pressed.png
clear_log.png
clear_log_pressed.png
connect.png
connected.ico
connected.png
connect_pressed.png
delete_certificate.png
delete_certificate_pressed.png
delete_profile.png
delete_profile_pressed.png
disable_log.png
disable_log_pressed.png
disconnect.png
disconnecting.ico
disconnect_pressed.png
enable_log.png
enable_log_pressed.png
enroll_certificate.png
enroll_certificate_pressed.png
|
export_certificate.png
export_certificate_pressed.png
import_certificate.png
import_certificate_pressed.png
import_profile.png
import_profile_pressed.png
logo.png
modify_profile.png
modify_profile_pressed.png
new_profile.png
new_profile_pressed.png
notifications.png
notifications_pressed.png
options_log.png
options_log_pressed.png
password_logo.png
profile_logo.png
show_certificate.png
show_certificate_pressed.png
show_log.png
show_log_pressed.png
splash_screen.png
status_down_arrow.png
title_bar.png
unconnected.ico
verify_certificate.png
verify_certificate_pressed.png
vpn_panel.png
|
No
|
Yes
|
Icon
|
Add the following icon files for customizing the VPN Client. These icons are for shortcuts on the Program Group. For examples, see the oem.mst transform and the oem.ini files.
MainIcon.ico
setmtu.ico
|
|
No
|
Yes
|
Media
|
Add the following files for customizing the VPN Client. For examples, see the oem.mst transform and the oem.ini files.
arrow_down.png
arrow_up.png
cancel.png
cancel_pressed.png
clear_log.png
clear_log_pressed.png
connect.png
connected.ico
connected.png
connect_pressed.png
delete_certificate.png
delete_certificate_pressed.png
delete_profile.png
delete_profile_pressed.png
disable_log.png
disable_log_pressed.png
disconnect.png
disconnecting.ico
disconnect_pressed.png
enable_log.png
enable_log_pressed.png
enroll_certificate.png
enroll_certificate_pressed.png
|
export_certificate.png
export_certificate_pressed.png
import_certificate.png
import_certificate_pressed.png
import_profile.png
import_profile_pressed.png
logo.png
modify_profile.png
modify_profile_pressed.png
new_profile.png
new_profile_pressed.png
notifications.png
notifications_pressed.png
options_log.png
options_log_pressed.png
password_logo.png
profile_logo.png
show_certificate.png
show_certificate_pressed.png
show_log.png
show_log_pressed.png
splash_screen.png
status_down_arrow.png
title_bar.png
unconnected.ico
verify_certificate.png
verify_certificate_pressed.png
vpn_panel.png
|
No
|
Yes
|
Property
|
ProductName—Supply company and product names for installation.
Manufacturer—Change publisher in the support information screen under Control Panel > Add/Remove Programs.
ARPURLINFOABOUT—Change the web page in the support information screen under Control Panel > Add/Remove Programs.
|
|
Yes
No
No
|
No
Yes
Yes
|
Shortcut
|
Dialer—Change the name and the icon for the VPN Dialer application.
SET_MTU—Change the name and the icon for the Set MTU application.
|
|
No for all
|
Yes for all
|
Installing the VPN Client Using the Transform
To install the VPN Client with the transform oem.mst that you have prepared, execute the following command at the command-line prompt.
msiexec /i vpnclient_setup.msi TRANSFORMS=oem.mst
If you want to record errors that might occur during the installation, you can create a log file as follows:
msiexec /i vpnclient_setup.msi /l*v! c:oeminstall.log TRANSFORMS=oem.msvpnclient_setup.msi
Installing the VPN Client Without User Interaction
This section describes how to produce installation without user interaction for MSI installations. Installing the VPN Client without user interaction is called silent mode. In silent mode, no messages or prompts appear on the screen.
Note You can launch silent installation from the command line by using the -sd parameter with the vpnclient.exe command. For example, vpnclient -sd toVPN. For information on the vpnclient command, refer to "Configuring Automatic VPN Initiation—Windows Only".
Silent Installation Using MSI
To install the VPN Client without dialogs and messages (user interface) displaying on the screen, you can use either of the two following commands on the command line.
msiexec.exe /q [n|b|r|f] /i vpnclient_setup.msi
or
vpnclient_en.exe /q [n|b|r|f]
Option
|
What it Displays
|
q or qn
|
No user interface. It is advisable to enable logging to determine whether the installation succeeded, since this option eliminates all information including fatal error messages.
|
qb
|
The basic user interface, which is a limited progress dialog that Windows Installer generates. It is advisable to enable logging with this option as well.
|
qr
|
Reduced user interface, similar to the full user interface option, but includes only a subset of all dialogs. For example, this option displays the welcome, license agreement, destination folder, and start dialogs, but does not let the user change the destination folder.
|
qf
|
Full or complete user interface including all dialogs. This is the default setting.
|
Launching SetMTU with Silent Installation
The SetMTU utility is automatically launched in silent mode with the value of 1300 for all installed adapters. To disable the SetMTU utility during installation, set the LAUNCHSETMTU property on the command-line to 0. To modify the MTU value, set SETMTUVALUE to value. To override the DNE MtuAdjuistment parameter, which is set to 0, set DNEMTUADJUSTMENT to value.
For example, to disable SetMTU and set the DNE Mtuadjustment to 144, execute the following command:
vpnclient_setup.msi LAUNCHSETMTU=0 DNEMTUADJUSTMENT=144
For information on the SetMTU utility, see "Changing the MTU Size, page 11-5."
Customizing the VPN Client GUI for Mac OS X
To customize the VPN Client GUI for the Mac OS X platform, place the custom images in the Resources folder of the installer directory.
Figure 10-1shows the vpnclient installer directory. This directory contains the installer package and any preconfigured files in the Profiles and Resources folders.
The Resources folder contains all images for the VPN Client.
Figure 10-1 VPN Client Installer Directory
To distribute custom images, replace the image files in the Resources folder with your own custom images. For example:
•To customize the logo, replace the file /etc/CiscoSystems/Resources/logo.png with your own custom logo.
•To customize the splash screen, replace the file /etc/CiscoSystems/Resources/splash_screen.png with your own custom splash screen.
When the VPN Client is installed, the images in the Resources file are used for the client GUI.
