Summary
Web Interface 4.0 and 4.5 support installation, uninstallation, site creation, site modification, and site removal through command line utilities. These utilities can be used as an alternative to the Access Suite Console/Access Management Console for some tasks or as a means to perform an unattended installation.
Web Interface for Windows Command-line Installation
To get started, unzip the WebInterface.exe package to a directory. If WinZip is not installed on a Windows 2003 server, you can simply rename the WebInterface.exe program to WebInterface.zip and then expand it using Windows’ built-in zip handler. The unzipped contents will include the file WebInterfaceSetup.exe:
The command-line options for WebInterfaceSetup.exe are detailed in the following table. After Web Interface for Windows is installed, the sitemgr.exe tool is added to the Program Files\Citrix\Web Interface\4.0 (Program Files\Citrix\Web Interface\4.5 for Web Interface 4.5) directory. Use sitemgr.exe to add, remove, or modify sites for the current installation. Sitemgr.exe supports all the same command-line options detailed for WebInterfaceSetup.exe below EXCEPT -noasc, -q, -e and -p.
If necessary, the zip file extraction step may be skipped and command-line options can be passed to the self-extractor through an environment variable. The self-extractor cannot accept command line arguments directly. Set the environment variable WI_COMMAND_LINE equal to the command line you wish to use, and then invoke the self-extractor with no arguments. When using this option, use the \ character to escape spaces within arguments. If the \ character is needed to express a directory path, use \\ instead. For example:
C:\>set WI_COMMAND_LINE=-q -noasc -g c:\\wi\\logfile -c "WIDest=1:/Citrix/MetaFrame,Config=Local,XMLService=mfpsrv01:80;mfpsrv02:80,WIDefaultSite=Yes"
C:\>WebInterface.exe
WebInterfaceSetup.exe Command-line Options
Option |
Meaning |
Behavior if absent |
-noasc |
Bypasses the check for the Access Suite Console for MetaFrame Presentation Server. This allows you to install Web Interface without installing the console. |
Without this option, the installer will exit (with an error message in an interactive install) if the correct version of the Access Suite Console is not installed. |
-p <path> |
Installs site management tool and language packs to <path>. This option implies a silent installation of Web Interface. |
Site management tool and language packs are installed to C:\Program Files\Citrix (or equivalent). |
-q |
Installs Web Interface silently. |
With none of these options, the installer GUI is displayed. |
-c <sitedef> |
Installs a new site defined by <sitedef>, which is a comma separated list of <arg>=<value> pairs. See the next table for a specification. |
No site is created |
-e <path> |
Installs the ICA clients from <path> which must point to an ICAWEB folder. This option can only be specified to the first time setup wrapper or the UNIX pre-install script. If absent, the ICA clients are not installed. This option can only be used if the –p option is also specified. |
ICA Client files are not installed. |
-g <logpath> |
Log the operation(s) performed and save the log files in <logpath>. |
No log file is created. |
-h or -? |
Displays the program’s version and a summary of the accepted command line options, then quits. All other command line options are ignored. |
Help is not displayed. |
-i |
Prints out a summary of all sites currently installed on the machine. This option can only be specified by itself. |
No summary is shown. |
-l <language> |
Use language <language> for the GUI rather than the default language. If this option is used along with any of the other options, it has no effect (since the GUI will not be displayed). Possible values for <language> are en, de, fr, es and ja (English, German, French, Spanish and Japanese, respectively). |
If no other command line options are supplied, the user is prompted to select a language for the installation program. |
-m <sitedef> |
Modifies an existing site specified by <sitedef>. |
Existing sites are not modified. |
-r <sitedef> |
Removes an existing site specified by <sitedef>. |
No site is removed. |
-u |
Uninstalls the Web Interface. This option can only be specified by itself. |
Web Interface is not uninstalled. |
Site Definition Strings
Wherever <sitedef> appears in the previous table, this refers to a double quoted and comma-separated list of name=value pairs which describe a Web Interface, Program Neighborhood Agent or MetaFrame Conferencing Manager site. For example, the following <sitedef> string describes a Web Interface 4.0 site installed at the Default Web Site beneath /Citrix/MetaFrame, using a local configuration file with the server MPS401 providing the Citrix XML Service:
"WIDest=1:/Citrix/MetaFrame,Config=Local,XMLService=MPS401:8080"
Options which may be included in a site definition string are defined in the following table. All options and values are case-sensitive.
Option |
Meaning |
WIDest=<IISSite>:<path> |
Web Interface site is to be installed at path <path> under IIS site <IISSite> (the number of the IIS site). Example: WIDest=1:/Citrix/MetaFrame |
PNADest=<IISSite>:<path> |
Program Neighborhood Agent site is to be installed at path <path> under IIS site <IISSite> (the number of the IIS site). Example: PNADest=1:/Citrix/PNAgent |
MCMDest=<IISSite>:<path> |
MetaFrame Conferencing Manager site is to be installed at path <path> under IIS site <IISSite> (the number of the IIS site). Example: MCMDest=1:/Citrix/MCM |
WICurrent=<IISSite>:<path> |
Modify/remove the Web Interface site at path <path> under IIS site <IISSite> (the number of the IIS site). |
PNACurrent=<IISSite>:<path> |
Modify/remove the PNAgent site at path <path> under IIS site <IISSite> (the number of the IIS site). |
MCMCurrent=<IISSite>:<path> |
Modify/remove the MCM site at path <path> under IIS site <IISSite> (the number of the IIS site). |
Config=Local|<service_list> Where <service_list> is one or more ; separated <server>:<port> pairs. |
Specifies the configuration source to be either a local configuration file or the Configuration Service at the specified location(s). This option must be specified when creating a site. When modifying a site, its absence signifies no change. Examples: • Config=Local • Config=MFSRV01:80;MFSRV02:80 |
Option |
Meaning |
WIDefaultSite=Yes|No |
Makes this Web Interface site the default site if Yes. Stops the Web Interface site from being the default site if No. If a new Web Interface I site is being created and this option is absent the default is No. |
FarmName=<farm_name> |
Configures the initial farm to have name <farm_name>. If configuration source is not local, an error occurs. If absent, Farm1 is used. This option can only be specified when creating a new site. |
XMLService=<server>:<port> |
Configures an initial XML Service at host <server> and port <port>. If configuration source is not local, an error occurs. If absent, the initial XML Service is set to localhost:80. This option can only be specified when creating a new site. |
XMLSProtocol=HTTP|HTTPS|SSL |
Sets the protocol used to communicate with the XML Service (HTTP, HTTPS or SSL). If configuration source is not local, an error occurs. If absent, defaults to HTTP. This option can only be specified when creating a new site. |
XMLSSSLPort=<port> |
Sets the SSL port used for communication with the XML Service. If configuration source is not local, an error occurs. Ignored if XMLSProtocol is not SSL. If absent, defaults to 443. This option can only be specified when creating a new site. |
ECS=<server>:<port> |
Configures an initial ECS service at host <server> and port <port>. If configuration source is not local, an error occurs. Ignored if a MetaFrame Conferencing Manager site is not being installed. If absent, defaults to localhost:9000. This option can only be specified when creating a new site. |
ECSSecure=Yes|No |
Sets whether communications with the initial ECS service are secured using SSL. If configuration source is not local or if no ECS option is specified, an error occurs. If absent, defaults to No. This option can only be specified when creating a new site. |
WIApplyChangesURL=<URL> |
Sends the specified URL as the Apply Changes URL when registering the Web Interface site with the Configuration Service. Ignored if not using the Configuration Service. If absent, a guessed URL is sent. This option can only be specified when creating a new site. |
PNAApplyChangesURL=<URL> |
Sends the specified URL as the Apply Changes URL when registering the Program Neighborhood Agent site with the Configuration Service. Ignored if not using the Configuration Service. If absent, a guessed URL is sent. This option can only be specified when creating a new site. |
MCMApplyChangesURL=<URL> |
Sends the specified URL as the Apply Changes URL when registering the MCM site with the Configuration Service. Ignored if not using the Configuration Service. If absent, a guessed URL is sent. This option can only be specified when creating a new site. |
Web Interface for Windows Examples
The following examples illustrate how to perform command-line installation or site management of Web Interface 4.0.
Example 1 – Install Web Interface 4.0 for Windows and create a local site
To install Web Interface and create a Web Interface site on the Default Web Site beneath /Citrix/MetaFrame, setting it to be the default destination for this Web server, using a local WebInterface.conf file for configuration:
WebInterfaceSetup.exe –c "WIDest=1:/Citrix/MetaFrame,Config=Local,XMLService=mps01:80,WIDefaultSite=Yes"
Example 2 – Add a site that uses remote configuration
This command adds two new sites to an existing Web Interface 4.0 server. The new sites will use the XML services MPS401:8080 and MPS402:8080 as configuration sources. The XML Service addresses to use for application enumeration must be specified later using the Access Suite Console. We have created a new site in IIS that we wish to use to serve the Web Interface sites. The new IIS site has an identifier of 894881:
We want to install the Web Interface and Program Neighborhood Agent Services sites on this new IIS Web site.
cd "program files\citrix\web interface\4.0"
sitemgr.exe –c "WIDest=894881:/Citrix/MetaFrame,PNADest=894881:/Citrix/PNAgent, Config=MPS401:8080;MPS402:8080"
Example 3 – Move Web Interface from the default web site to a new site
The following command moves a Web Interface 4.0 site from the Default Web Site to the site whose identifier is 894881:
cd "program files\citrix\web interface\4.0"
sitemgr.exe –m "WICurrent=1:/Citrix/MetaFrame,WIDest=894881:/Citrix/MetaFrame"
Example 4 – Remove Web Interface from the default or non-default web site
Before:
C:\Program Files\Citrix\Web Interface\4.5>sitemgr -i
1:/Citrix/AccessPlatform WI http://FTLRDRINEHAR19.UOFM.com/Citrix/AccessPlatform 4.5.0.6869 c:\inetpub\wwwroot\Citrix\AccessPlatform
1:/Citrix/Clipboard WI http://FTLRDRINEHAR19.UOFM.com/Citrix/Clipboard
4.5.0.6869 c:\inetpub\wwwroot\Citrix\Clipboard
1:/Citrix/PNAgent PNA http://FTLRDRINEHAR19.UOFM.com/Citrix/PNAgent
4.5.0.6869 c:\inetpub\wwwroot\Citrix\PNAgent
1:/Citrix/Test WI http://FTLRDRINEHAR19.UOFM.com/Citrix/Test 4.5.0.6869 c:\inetpub\wwwroot\Citrix\Test
Note: sitemgr may reflect orphaned site names. These sites can be removed from the registry: HKLM\Software\Citrix\Web Interface\4.5\Sites
WARNING! Using Registry Editor incorrectly can cause serious problems that may require you to reinstall your operating system. Citrix cannot guarantee that problems resulting from the incorrect use of Registry Editor can be solved. Use Registry Editor at your own risk.
For information about how to edit the registry, view the "Changing Keys and Values" Help topic in Registry Editor (Regedit.exe) or the "Add and Delete Information in the Registry" and "Edit Registry Data" Help topics in Regedt32.exe. Make sure you back up the registry before you edit it. If you are running Windows NT, also update your Emergency Repair Disk (ERD).
Sitemgr Deletion Syntax:
C:\Program Files\Citrix\Web Interface\4.5>sitemgr -r WICurrent=1:/Citrix/Test
After:
C:\Program Files\Citrix\Web Interface\4.5>sitemgr -i
1:/Citrix/AccessPlatform WI http://FTLRDRINEHAR19.UOFM.com/Citrix/Ac
cessPlatform 4.5.0.6869 c:\inetpub\wwwroot\Citrix\AccessPlatform
1:/Citrix/Clipboard WI http://FTLRDRINEHAR19.UOFM.com/Citrix/Clipboard
4.5.0.6869 c:\inetpub\wwwroot\Citrix\Clipboard
1:/Citrix/PNAgent PNA http://FTLRDRINEHAR19.UOFM.com/Citrix/PNAgent
4.5.0.6869 c:\inetpub\wwwroot\Citrix\PNAgent
Web Interface for UNIX Site Creation
The JSP variant of Web Interface includes the WebInterface.sh file for creating new sites. The file WebInterface.sh can only be used to create a new site; it cannot be used to move, modify or delete an existing site. To delete an existing site, remove it from the Web server in the standard way.
Option |
Meaning |
WIWARFile=<path> |
Creates a Web Interface site WAR file at the specified location. |
PNAWARFile=<path> |
Creates a Program Neighborhood Agent site WAR file at the specified location. |
MCMWARFile=<path> |
Creates a MetaFrame Conferencing Manager site WAR file at the specified location. |
Config=Local|<service_list> Where <service_list> is one or more ; separated <server>:<port> pairs. |
Specifies the configuration source to be either a local configuration file or the Configuration Service at the specified location(s). If absent, the default is to use a local configuration file. |
FarmName=<farm_name> |
Configures the initial farm to have name <farm_name>. If configuration source is not local, an error occurs. If absent, Farm1 is used. |
XMLService=<server>:<port> |
Configures an initial XML Service at host <server> and port <port>. If configuration source is not local, an error occurs. If absent, the initial XML Service is set to localhost:80. |
XMLSProtocol=HTTP|HTTPS|SSL |
Sets the protocol used to communicate with the XML Service (HTTP, HTTPS or SSL). If configuration source is not local, an error occurs. If absent, defaults to HTTP. |
XMLSSSLPort=<port> |
Sets the SSL port used for communication with the XML Service. If configuration source is not local, an error occurs. Ignored if XMLSProtocol is not SSL. If absent, defaults to 443. |
ECS=<server>:<port> |
Configures an initial ECS service at host <server> and port <port>. If configuration source is not local, an error occurs. Ignored if MCM site is not being installed. If absent, defaults to localhost:9000. |
ECSSecure=Yes|No |
Sets whether communications with the initial ECS service are secured using SSL. If configuration source is not local or if no ECS option is specified, an error occurs. If absent, defaults to No. |
Web Interface for UNIX Example
To create a MetaFrame Presentation Server site using an XML Service at "mf1" or "mf2" on port 80, and local configuration, putting the WAR file at /opt/tomcat5/webapps/MetaFrame.war:
sh WebInterface.sh -c "WIWARFile=/opt/tomcat5/webapps/MetaFrame.war,Config=Local,XMLService=mf1:80;mf2:80"
