Command-line parameters
The following command-line parameters are listed with their values and descriptions. The default value is listed in bold text in the following table.
Auto Update always runs WebExConnect.exe /m, so it saves the current settings, which are in system registry.
Note: If the registry value cannot be decrypted (for example, it was manually modified), an error is reported and the user cannot sign in.
|
For installation over an existing version, the command line parameters or the corresponding public properties in the MSI package will overwrite the current settings. If not specified, the current settings, NOT DEFAULT, will be used.
Parameter Values
|
Description
|
ARCHIVE
|
|
YES
|
Archive IMs
|
NO
|
Do not archive IMs.
|
ARCHIVE_DAYS
|
|
<integer>
|
All values for this parameter are case-insensitive.
|
HOMEPAGE
|
|
MyWebEx
|
MyWebEx is the homepage.
|
RUNATONCE
|
|
YES
|
Start Cisco WebEx when Windows starts.
The default value of this parameter is YES.
|
NO
|
Do not start Cisco WebEx when Windows starts.
|
CONNECT_OUTLOOK
|
|
YES
|
Connect to Microsoft Outlook when Cisco WebEx starts.
|
NO
|
Do not connect to Microsoft Outlook when Cisco WebEx starts.
|
DISPLAY_PRESENCE
|
|
YES
|
Display my Cisco WebEx presence status in Microsoft Outlook. This parameter works only when CONNECT_OUTLOOK is YES.
|
NO
|
Do not display my Cisco WebEx presence status in Microsoft Outlook.
|
SIGN_ME_OUT
|
|
YES
|
Sign out of Cisco WebEx when I close my Contacts List window.
|
NO
|
Do not sign out of Cisco WebEx when I close my Contacts List window.
|
SUPPORT_URL
|
|
<SupportURL>
|
Support URL specified by <SupportURL> value.
This value overrides the default URLs provided by Cisco WebEx.
The support URL can be set to your Cisco WebEx Organization'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.com GET_SCREEN_NAME_URL=http://register.mycompany.com
Where mycompany.com is the name of your Organization.
|
FORGOT_PASSWORD_URL
|
|
<ForgotPasswordURL>
|
URL for "forgot password" hyperlink, specified by <ForgotPasswordURL> value.
The value overrides the default URLs provided by Cisco WebEx.
Note: In organizations where Single sign-on is implemented, the Forgot Password? link on the client opens the URL the organization administrator has specified for this parameter. However, if a URL has not been is provided for this parameter, the Forgot Password page will display an error when you enter the user name and click Submit.
|
CONNECTION_SETTINGS_READONLY
|
|
Read-Only
|
Connection Settings are read-only. The entire string is encrypted and stored in system registry.
If the registry value cannot be decrypted (for example, was manually modified), the default value "Read-Only" is used.
If <Permission> is read-only, all fields in Connection Settings are disabled, including the proxy settings. The username and password fields should be enabled if "Connect using proxy" checkbox is selected.
|
Read-Write
|
Connection Settings are read-write.
|
USE_PROXY
|
|
UseProxy
|
Use proxy. The entire string is encrypted and stored in system registry.
|
NotUseProxy
|
Do not use proxy.
|
PROXY_NAME
|
|
<ProxyName>
|
Proxy name in Connection Settings. The value string is encrypted and stored in system registry.
The default value is a special GUID to indicate no proxy server to be used. If no proxy server is used, this value is ignored.
|
PROXY_PORT
|
|
HTTPS=443
HTTP=80
SOCKS4=1080
SOCKS5 =1080
|
Proxy port in Connection Settings. The value string is encrypted and stored in system registry.
The default value depends on proxy protocol value.
If no proxy server is used, this value is ignored.
|
PROXY_PROTOCOL
|
|
HTTPS
HTTP
SOCKS4
SOCKS5
|
Protocol in Connection Settings. The value string is encrypted and stored in system registry.
The default value depends on proxy protocol value:
HTTPS – 443, HTTP – 80, SOCKS4 -- 1080, SOCKS5 -- 1080
If no proxy server is used, this value is ignored.
|
DEBUG
|
|
DEBUG
|
Enables creating debug trace logs. When enabled, this parameter creates debug log files in the Cisco WebEx user's ...\Documents and Settings\<user's profile folder>\Application Data\WebEx Connect folder. Debug trace logs typically help in investigating any problems that may arise. The size of each log file is typically 10 Mb.
|
OFF
|
When this parameter is disabled, the apConfig.ini file appears as follows:
[Trace]
# OFF or DEBUG or INFO
Level=OFF
EnableWidgetTrace=1
Additionally, no log files will be generated.
|
INFO
|
The MSI will not set any default value for the parameter. The apConfig.ini file will contain a default value for this parameter when Cisco WebEx is installed. When you specify the INFO value, this default value will remain unchanged. Additionally, it generates debug log files, which provide very minimal information. The log file size is typically about 1 Mb.
We do not recommend setting the value for this parameter to INFO.
|
SSO_ORG_NAME
|
|
<OrgName>
|
Required when single sign-on is implemented for the Organization. The parameter enables single sign-on for the client and identifies the Organization to be used for single sign-on.
|
LANGUAGE
|
|
<parameter value>
|
Used for setting a default language. The following the parameter values:
- English = EN
- Chinese Simplified = ZH
- French = FR
- German = DE
- Italian = IT
- Japanese = JP
- Spanish = ES
|
When single sign-on is enabled, the Cisco WebEx client must be installed with a command specifying the organization name. This enables single sign-on in the client and identifies the organization to be used for single sign-on.
Use the following example for installing the Cisco WebEx client:
- 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
|