Cisco WebEx Connect Application Command-line Parameters · SOCKS4=1080 RSOCKS5=1080 PROXY_PROTOCOL ProtocolinConnectionSettings.Thevaluestringisencrypted andstoredinsystemregistry

Cisco WebEx Connect Application Command-lineParameters

• Overview, page 1

• Command-line parameters, page 1

OverviewThis section includes command-line parameters used in the Cisco WebEx Connect application installer. Thecommand-line parameters are passed into the Installer executable WebExConnect.exe or the MSI packageapSetup.msi, or directly added into the MSI package. The following example explains the syntax and usageof the RUNATONCE command-line (or MSI) parameter.

msiexec /i "C:\apsetup.msi" RUNATONCE="YES"

where

• msiexec=the command for invoking the Windows Installer (formerly known as the Microsoft Installer)

• /i=the switch or the install option (here, i is the switch to install or configure the CiscoWebEx Installer)

• C:\...: the path where the Cisco WebEx Connect application installer file is located

• RUNATONCE: the parameter supported by the Cisco WebEx Connect application installer

• YES=the value of the (RUNATONCE) parameter

For a list and description of all the command-line parameters supported by the Cisco WebEx Connectapplication installer, see Command-line parameters, on page 1.

You can also use the following parameter to "silently" install Cisco WebEx: /qn.

Command-line parametersThe following command-line parameters are listed with their values and descriptions. The default value islisted in bold text in the following table.

Auto Update always runsWebExConnect.exe /m, so it saves the current settings, which are in system registry.

Cisco WebEx Messenger Administration Guide 1

If the registry value cannot be decrypted (for example, it was manually modified), an error is reported andthe user cannot sign in.

Note

For installation over an existing version, the command line parameters or the corresponding public propertiesin the MSI package will overwrite the current settings. If not specified, the current settings, NOT DEFAULT,will be used.

DescriptionParameter Values

ARCHIVE

Archive IMsYES

Do not archive IMs.NO

ARCHIVE_DAYS

All values for this parameter are case-insensitive.<integer>

HOMEPAGE

MyWebEx is the homepage.MyWebEx

RUNATONCE

Start Cisco WebEx Connect application when Windows starts.

The default value of this parameter is YES.YES

Do not start Cisco WebEx Connect application whenWindowsstarts.NO

CONNECT_OUTLOOK

Connect to Microsoft Outlook when Cisco WebEx Connectapplication starts.YES

Do not connect to Microsoft Outlook when Cisco WebExConnect application starts.NO

DISPLAY_PRESENCE

Display my Cisco WebEx Connect application presence statusin Microsoft Outlook. This parameter works only whenCONNECT_OUTLOOK is YES.

YES

Do not display my Cisco WebEx Connect application presencestatus in Microsoft Outlook.NO

Cisco WebEx Messenger Administration Guide2

Cisco WebEx Connect Application Command-line ParametersCommand-line parameters


SIGN_ME_OUT

Sign out of CiscoWebEx Connect application when I close myContacts List window.YES

Do not sign out of Cisco WebEx Connect application when Iclose my Contacts List window.NO

SUPPORT_URL

Support URL specified by <SupportURL> value.

This value overrides the default URLs provided by CiscoWebEx.

The support URL can be set to your Cisco WebExOrganization's first level support page at the time of installation.To do this, use the following command line parameter:

msiexec /i "C:\apsetup.msi"SUPPORT_URL=http://firstlevelsupport.mycompany.comGET_SCREEN_NAME_URL=http://register.mycompany.com

Where mycompany.com is the name of your Organization.

<SupportURL>

FORGOT_PASSWORD_URL

URL for "forgot password" hyperlink, specified by<ForgotPasswordURL> value.

The value overrides the default URLs provided by CiscoWebEx.

In organizations where Single Sign-on is implemented,the Forgot Password? link on the client opens theURL the organization administrator has specified forthis parameter. However, if a URL has not beenprovided for this parameter, theForgot Password pagedisplays an error when you enter the user name andselect Submit.

Note

<ForgotPasswordURL>

CONNECTION_SETTINGS_READONLY

Connection Settings are read-only. The entire string is encryptedand stored in system registry.

If the registry value cannot be decrypted (for example, wasmanually modified), the default value "Read-Only" is used.

If <Permission> is read-only, all fields in Connection Settingsare disabled, including the proxy settings. The username andpassword fields should be enabled if "Connect using proxy"checkbox is selected.

Read-Only




Connection Settings are read-write.Read-Write

USE_PROXY

Use proxy. The entire string is encrypted and stored in systemregistry.UseProxy

Do not use proxy.NotUseProxy

PROXY_NAME

Proxy name in Connection Settings. The value string isencrypted and stored in system registry.

The default value is a special GUID to indicate no proxy serverto be used. If no proxy server is used, this value is ignored.

<ProxyName>

PROXY_PORT

Proxy port in Connection Settings. The value string is encryptedand stored in system registry.

The default value depends on proxy protocol value.

If no proxy server is used, this value is ignored.

HTTPS=443

HTTP=80

SOCKS4=1080

RSOCKS5 =1080

PROXY_PROTOCOL

Protocol in Connection Settings. The value string is encryptedand stored in system registry.

The default value depends on proxy protocol value:

HTTPS – 443, HTTP – 80, SOCKS4 -- 1080, SOCKS5 -- 1080If no proxy server is used, this value is ignored.

HTTPS

HTTP

SOCKS4

SOCKS5

DEBUG

Enables creating debug trace logs.When enabled, this parametercreates debug log files in the CiscoWebEx Connect applicationuser's ...\Documents and Settings\<user's profilefolder>\Application Data\WebEx Connect folder. Debug tracelogs typically help in investigating any problems that may arise.The size of each log file is typically 10 Mb.

DEBUG




When this parameter is disabled, the apConfig.ini file appearsas follows:

[Trace]

# OFF or DEBUG or INFO

Level=OFF

EnableWidgetTrace=1

Additionally, no log files are generated.

OFF

The MSI will not set any default value for the parameter. TheapConfig.ini file will contain a default value for this parameterwhen CiscoWebEx Connect application is installed.When youspecify the INFO value, this default value will remainunchanged. Additionally, it generates debug log files, whichprovide very minimal information. The log file size is typicallyabout 1 Mb.

We do not recommend setting the value for this parameter toINFO.

INFO

SSO_ORG_NAME

Required when Single Sign-on is implemented for theOrganization. The parameter enables Single Sign-on for theclient by identifying the Organization’s Single Sign-on domain.

<OrgName>

LANGUAGE

Used for setting a default language. The following the parametervalues:

• English = EN

• Chinese Simplified = ZH

• French = FR

• German = DE

• Italian = IT

• Japanese = JP

• Spanish = ES

<parameter value>

When Single Sign-on is enabled, the Cisco WebEx Connect application must be installed with a commandspecifying the organization name. This enables Single Sign-on in the application and identifies the organizationto be used for Single Sign-on.

Use the following example for installing the Cisco WebEx Connect application:



• Example for installing the MSI file:

◦msiexec.exe /i filename.msi SSO_ORG_NAME=OrgName

• Example for installing the .exe file:

◦filename.exe SSO_ORG_NAME=OrgName

