Link to OpenSpan Help Home Page
Installing OpenSpan from the Command Line
You can bypass the Setup wizard and install OpenSpan Runtime and OpenSpan Studio/Plug-in via the command line using the appropriate installation program, such as OpenSpanRuntimeEntSetup.exe or OpenSpanStudioVS2010Setup.exe. Here is an example of the command line syntax:
OpenSpanRuntimeEntSetup.exe (switches) (parameters)
Command Line Switches
Here are the command line switches you can use when installing Runtime or Studio:
Switch |
Description |
/i |
Installs the system. |
/qn+ |
Installs the system with no user interface except for a modal dialog that appears at the end. |
/qn |
(Silent Mode). Installs the system with no user interaction at all. |
/L*v |
Tells the program to log all install information including the information generated by the v (verbose) option. Include the name of the log file you want to use with this switch. |
Common Parameters
Here are the command line parameters you can use when installing either Runtime or Studio:
Note: Both Runtime and Studio/Plug-in support Advanced Installer and Microsoft Installer parameters, the most commonly-used of these are included here. For more information, see the MSDN Property Reference topic for the Windows Installer.
Parameter |
Description |
AI_DESKTOP_SH=0 |
Enter one (1) to create desktop icons. The default is zero (0), which does not create desktop icons. |
AI_QUICKLAUNCH_SH=0 |
Enter zero (0) if you do not want the installation program to an icon to the Windows Quick Launch toolbar. The default is zero (0), which tells the program to add the icon. |
AI_STARTMENU_SH=1 |
Enter zero (0) if you do not want the installation program to create a start menu program folder. The default is one (1), which tells the program to create a Start menu folder. |
AI_STARTUP_SH =0 |
Enter zero (0) if you do not want the installation program to an icon in the Startup folder. The default is zero (0), which tells the program to add an icon. |
ALLUSERS= |
You have these options: ”” = Forces a per user install. 0 = Installs per user. 1 = Installs per machine, for all users. 2 = If the user has administrator rights, it installs per machine. Note: If the user does not have administrator rights, it installs per user. |
APPDIR=”” |
Use this parameter to override the default installation folder. The default is blank, which tells the program to install OpenSpan Runtime or Studio into the default folder. |
INSTALL_OFFICE=0 |
Enter the version of Microsoft Office installed on the computer. The default is zero (0), which indicates Microsoft Office is not installed on this machine, the installed version is not listed, or if you do not plan to integrate with Microsoft Office. You can enter 2002, 2003, 2007, or 2010 to indicate a specific version of Office. |
INST_SERVICES=1 |
Enter zero (0) if you do not want OpenSpan Services and the OpenSpan Driver Service installed. The default is one (1), which installs these services. Typically, you should accept the default. You would only set this parameter to zero (0) in Citrix environments where you could not install these services. |
MSIINSTALLPERUSER = |
If you want the Installer to install the dual-purpose package in the per-machine installation context, set this parameter to an empty string ("") and set the ALLUSERS parameter to 2. To have the Installer install the dual-purpose package in the per-user installation context, set this parameter to one (1) and set the ALLUSERS parameter to 2. Note: If the ALLUSERS parameter is set to something other than 2, the Installer ignores this parameter. |
Runtime Parameters
These parameters only apply to Runtime installations:
Parameter |
Description |
INSTALL_CONFIG_FILES=1 |
Enter zero (0) to preserve your existing configuration files during the installation. Keep in mind that new functionality may depend on settings in these configuration files and if you choose to preserve the existing files, you may not be able to take advantage of the new functionality, unless you manually update these files after the installation finishes The default is one (1), which tells the program to overwrite the RuntimeConfig.xml, OpenSpan.Runtime.exe.config, and OpenSpan.Runtimex64.exe.config files during the installation. |
LOGVIEWER=0 |
Enter one (1) to install the Log Viewer. The Log Viewer lets you read and work with SuperTrace® diagnostics output. |
ENABLE_SERVER= |
Enter True to enable a connection to the OpenSpan Management Console (OMC) server. Enter False to disable OMC connectivity. The default is True. |
BASEURL= |
This defines the URL from which updates will be downloaded. The default is https://omc.openspan.com Do not change this default. |
TENANT |
Enter the tenant name assigned to your organization. |
ENABLE_ADFS= |
Enter True to enable Active Directory Federation Services (ADFS) authentication. Enter False to disable the use of ADFS authentication. The default is True. If you enable OMC connectivity and disable ADFS authentication, OMC prompts you to enter a user name and password for authentication. |
ADFS_URL= |
Enter the URL to your internal ADFS service. |
Examples
Here are some examples:
OpenSpanRuntimeEntSetup.exe /qn+ /L*v LogFileName.txt INSTALL_OFFICE=2010 LOGVIEWER=1 AI_STARTMENU_SH=1 AI_DESKTOP_SH=1
OpenSpanStudioVS2010Setup.exe /qn+ /L*v LogFileName.txt INSTALL_OFFICE=2010 AI_STARTMENU_SH=1 AI_DESKTOP_SH=1
OpenSpanRuntimeEntSetup.exe /qn+ /L*v LogFileName.txt INSTALL_OFFICE=2010 LOGVIEWER=1 AI_STARTMENU_SH=1 AI_DESKTOP_SH=1 APPDIR="C:\InstallToThisFolder"
OpenSpanRuntimeEntSetup.exe /qn+ /L*v LogFile.txt INSTALL_OFFICE=0 LOGVIEWER=1 AI_STARTMENU_SH=1 ALLUSERS=""
OpenSpanRuntimeEntSetup.x64.msi /qn+ /L*v LogFileName.txt INSTALL_OFFICE=”2010” LOGVIEWER=0 AI_STARTMENU_SH=1 AI_DESKTOP_SH=1 ENABLE_SERVER=True TENANT=YourCompany ENABLE_ADFS=True ADFS_URL=”https://ServerName.YourCompany.com/adfs/services/trust/2005/windowstransport”
Note: The last example uses a .msi instead of an .exe. You cannot include colons (:) in parameters to a .exe file. Because of this, use the .msi when you need to include the BASEURL or ADFS_URL parameters.
See also
Installing OpenSpan Studio On a Citrix Server