Silent installation preference keys

Silent installation preference keys
You specify preference keys in a response file for use during silent installation.
We can specify more than one preference key in a response file.

For some preferences, we can add the _EDITABLE option at the end of the preference key name. The _EDITABLE option enables or disables the preference for a user in the IBM Installation Manager interface. In the Installation Manager interface, users cannot edit a preference key that ends with the _EDITABLE option. Changes that are made to _EDITABLE preference keys are persistent.

For example, the com.ibm.cic.common.core.preferences.ssl.nonsecureMode preference key can be set in the Installation Manager interface. The com.ibm.cic.common.core.preferences.ssl.nonsecureMode_EDITABLE preference key cannot be set in the Installation Manager interface.

When you define preference keys in a response file, the XML code looks like this example:

<preference name = 'the key of the preference' value = 'the value of the preference to be set'> </preference>
Example:
<preference name = 'com.ibm.cic.common.core.preferences.searchForUpdates' value = 'false'> </preference>
Many but not all keys can be set in Installation Manager. The keys are provided in tables that correspond to the list of preferences in Installation Manager. To access the preferences in Installation Manager, click File > Preferences. On the OS X, the Preferences option is under the IBM Installation Manager menu. We can set these preferences in a response file:
Table 1 Repository keys
Table 2 Rollback keys
Table 3 Internet keys
Table 4 Passport Advantage keys
Table 5 Update keys
Table 6 Other keys
We cannot set these keys in a response file:
Appearance keys. To set the Appearance key in Installation Manager, click File > Preferences > Appearance.
Help keys. To set the Help key in Installation Manager, click File > Preferences > Help.

Credentials that are required for authenticating to repositories and proxy servers during silent installations are not saved in a response file or Installation Manager preferences. We must create a storage file for authenticating. For more information, see Store credentials.

Repository key Value Description

offering.service.repositories.areUsed true or false When this key is set to true, service repositories are searched when products are installed or updated. Change this key to false to disable the function.
Click File > Preferences > Repositories to set the Search service repositories during installation and updates preference in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.

For more information about using this preference in a response file, see Search for updates in silent mode.

For information about using this preference in the Installation Manager graphical user interface, see Search for updates in wizard mode.

offering.service.repositories.areUsed_EDITABLE true or false When this key is set to true, the Search service repositories during installation and updates preference cannot be checked or cleared in Installation Manager. The default value is true.
When the _EDITABLE option is included, we cannot set this preference in the Installation Manager interface.

com.ibm.cic.common.core.preferences.repositoryLocations_EDITABLE true or false Use this key to specify whether users can change the list of repositories. If set to false, users cannot modify the repository locations. The default value is true.
With the _EDITABLE option, we cannot set this preference in the Installation Manager interface.

Rollback key Value Description

com.ibm.cic.common.core.preferences.preserveDownloadedArtifacts true or false When this key is set to true, the files that are required to roll the package back to a previous version are stored on our computer.
When this key is set to false, files that are required for a rollback or an update are not stored.
If we do not store these files, we must connect to your original repository or media to roll back a package. When the preference is changed from true to false, the stored files are deleted the next time that we install, update, modify, roll back, or uninstall a package.

When we use the -preferences com.ibm.cic.common.core.preferences.preserveDownloadedArtifacts=false option in an imcl command, the stored files are deleted when the command runs.

Iin Installation Manager we can save files for rollback: click File > Preferences > Files for Rollback and then select Save files for rollback. On the OS X, the Preferences option is under the IBM Installation Manager menu.

com.ibm.cic.common.core.preferences.preserveDownloadedArtifacts_EDITABLE true or false When this key is set to true, the Save files for rollback check box can be checked or cleared in theInstallation Manager interface. True is the default value. Change the value to false to disable the key.
When the _EDITABLE option is included, we cannot set this preference in the Installation Manager interface.

com.ibm.cic.common.core.preferences.keepFetchedFiles true or false When this key is set to true, if an error occurs during the installation or the update process, the files that are downloaded are not deleted. The next time we download these files, the time to download the files decreases because some of the files are downloaded already.
When this key is set to false, files that are downloaded are deleted if an error occurs.

Internet key Value Description

HTTP: com.ibm.cic.common.core.preferences.http.proxyEnabled true or false Use this key to enable an HTTP or SOCKS proxy. After the proxy is enabled, the proxy is used for all server communications. Proxy servers enable connection to remote servers from behind the firewall. The default value is false.
Click File > Preferences > Internet > HTTP Proxy to set the Enable proxy server field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.

HTTP: com.ibm.cic.common.core.preferences.http.proxyUseSocks true or false The default value is false. Set to true to define a SOCKS proxy.
The com.ibm.cic.common.core.preferences.http.proxyEnabled key must be set to true to define the com.ibm.cic.common.core.preferences.http.proxyUseSocks key.

HTTP: com.ibm.cic.common.core.preferences.http.proxyHost Host name or IP address Click File > Preferences > Internet > HTTP Proxy to set the Proxy host field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.

HTTP: com.ibm.cic.common.core.preferences.http.proxyPort Port number Click File > Preferences > Internet > HTTP Proxy to set the Proxy port field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.

HTTP: com.ibm.cic.common.core.preferences.HTTP11.proxyHost.for.http Host name or IP address To use different proxy settings for HTTP and HTTPS servers, set the HTTP proxy server using this HTTP preference. For HTTPS, use the com.ibm.cic.common.core.preferences.HTTP11.proxyHost.for.https key to define the HTTPS proxy server. This key overrides the com.ibm.cic.common.core.preferences.http.proxyHost key, if that key is defined.
We cannot set this preference in the Installation Manager interface.

HTTP: com.ibm.cic.common.core.preferences.HTTP11.proxyPort.for.http Port number Use this key only when the com.ibm.cic.common.core.preferences.HTTP11.proxyHost.for.http key is defined.
We cannot set this preference in the Installation Manager interface..

HTTP: com.ibm.cic.common.core.preferences.http.disablePreemptiveAuthentication true or false The default value is false.
You cannot set this preference in the Installation Manager interface.

HTTPS: com.ibm.cic.common.core.preferences.https.proxyEnabled true or false When this key is set to false or if the value is not defined, the HTTP settings are used for HTTPS access. The default value is false. When this key is set to true, we can use different proxy settings for HTTP and HTTPS servers.
We cannot set this preference in the Installation Manager interface.

HTTPS: com.ibm.cic.common. core.preferences.https. proxyUseSocks true or false The default value is false. When this key is set to true, the specified SOCKS proxy uses thecom.ibm.cic.common.core.preferences.SOCKS.proxyHost and com.ibm.cic.common.core.preferences.SOCKS.proxyPort keys for connections.

HTTPS: com.ibm.cic.common.core.preferences.ssl.nonsecureMode true or false When this key is set to true, Nonsecure SSL Mode is enabled and is set as permanent by default. Restriction:
If we are using this preference key with the imutils saveCredential command, this preference is not persisted.
You cannot enable Nonsecure SSL Mode with the session setting in a response file.

When this key is set to false, Nonsecure SSL Mode is disabled. The default value is false.

If you start Installation Manager and use a nonsecure SSL repository location, we are prompted to either remain in the secure mode or switch to a nonsecure mode. The nonsecure mode can be either permanent or for the current session only. We can switch to the nonsecure mode even if this preference is set to false. The Permanent and Sessions options that are available in Installation Manager do not have a preference key.

In Installation Manager, we have the Permanent and Sessions options. When Permanent is checked, Nonsecure SSL Mode remains enabled the next time you start Installation Manager. When the Session option is checked, Nonsecure SSL Mode is enabled only for this session.

Click File > Preferences > Internet to set the Nonsecure SSL Mode field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.

HTTPS com.ibm.cic.common.core.preferences.ssl.nonsecureMode_EDITABLE true or false When this key is set to false, the Nonsecure SSL Mode option is disabled in Installation Manager. The default value is true.
We cannot set this preference in the Installation Manager interface.

HTTPS: com.ibm.cic.common.core.preferences.HTTP11.proxyHost.for.https Host name or IP address To use different proxy settings for HTTP and HTTPS servers, set the HTTPS proxy server using this preference. For HTTP, use the com.ibm.cic.common.core.preferences.HTTP11.proxyHost.for.http key to define the HTTP proxy server. This key overrides the com.ibm.cic.common.core.preferences.http.proxyHost key, if that key is defined. This key is used only when the com.ibm.cic.common.core.preferences.https.proxyEnabled key is defined.
We cannot set this preference in the Installation Manager interface.

HTTPS: com.ibm.cic.common.core.preferences.HTTP11.proxyPort.for.https Port number This key overrides the com.ibm.cic.common.core.preferences.http.proxyPort key, if that key is defined. This key is used only when the com.ibm.cic.common.core.preferences.HTTP11.proxyHost.for.https key is defined.
We cannot set this preference in the Installation Manager interface..

FTP: com.ibm.cic.common.core.preferences.ftp.proxyEnabled true or false False is the default value. When set to true, the specified SOCKS proxy uses the com.ibm.cic.common.core.preferences.SOCKS.proxyHost and com.ibm.cic.common.core.preferences.SOCKS.proxyPort keys for FTP connections.
Click File > Preferences > Internet > FTP Proxy to set the SOCKS proxy host field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.

FTP: com.ibm.cic.common.core.preferences.SOCKS.proxyHost Host name or IP address Click File > Preferences > Internet > FTP Proxy to set the Enable proxy server field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.

FTP: com.ibm.cic.common.core.preferences.SOCKS.proxyPort Port number Click File > Preferences > Internet > FTP Proxy to set the SOCKS proxy port field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.

For UNIX:
http.ntlm.auth.kind

Values: LM, NTLM, or NTLMv2
This key specifies the type of authentication scheme used. The default value is NTLM. Definition of values:
LM: LANMANAGER authentication is used
NTLM: NTLM version 1 authentication is used
NTLMv2: NTLM versions 2 authentication is used.

We cannot set this preference in the Installation Manager interface.

For information about authentication schemes, see Supported authentication schemes

Authentication schemes for Windows are configured using the LMCompatibilityLevel registry key.

Passport Advantage key Value Description

PassportAdvantageIsEnabled true or false The default value is false. Click File > Preferences > Passport Advantage to set the Connect to Passport Advantage field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.

PassportAdvantageIsEnabled_EDITABLE true or false When this key is set to true, the key enables the Connect to Passport Advantage preference. True is the default value. When set to false, the preference is disabled.
We cannot set this preference in the Installation Manager interface.

PassportAdvantageSiteId Site number for Passport Advantage

Update key Value Description

com.ibm.cic.common.core.preferences.searchForUpdates true or false When this key is set to true, a search for updates occurs first when we run a silent installation. The default value is false.
Click File > Preferences > Updates to set the Search for Installation Manager updates field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.

When the key is set to false and the IBM product we are installing requires a newer version of Installation Manager, a message shows when we run the silent installation. The message indicates that a later version of Installation Manager is required. The silent installation stops.

For more information about using this preference in a response file, see Search for updates in silent mode.

For information about using this preference in the Installation Manager graphical user interface, see Search for updates in wizard mode.

com.ibm.cic.common.core.preferences.searchForUpdates_EDITABLE true or false When this key is set to true, the Search for Installation Manager updates preference cannot be selected or cleared. The default value is true.
You cannot set this preference in the Installation Manager interface.

Other keys Value Description

com.ibm.cic.common.core.preferences.logLocation The value for this key specifies the location of Installation Manager log file.
This key is optional.
If we do not specify a location for the log file, both silent installations and interactive installations use the same location.
We cannot set this preference in the Installation Manager interface.

com.ibm.cic.license.policy.location Use this key to specify a URL that defines the location of the remote license policy file.
We cannot set this preference in the Installation Manager interface.

com.ibm.cic.common.core.preferences.eclipseCache The default value is provided by the product we are installing. This key specifies the location of the shared resources directory. The shared resource directory is specified the first time we install a package. We cannot change this location after we install a package.
This preference is set during the installation process when using the Installation Manager interface.

com.ibm.cic.common.core.preferences.http.enableGzipAcceptEncoding true or false When this key is set to true or when this key is not in the response file, a request is issued for a repository.xml file over HTTP or HTTPS. This request includes an Accept-Encoding:gzip request header. The default value for this preference is false.
When this key set to false, the request does not include the Accept-Encoding:gzip request header.

You cannot set this preference in the Installation Manager interface.

com.ibm.cic.common.core.preferences.connectTimeout Time is expressed in a numeral for the number of seconds. The default value is 30 seconds.
You cannot set this preference in the Installation Manager interface.

com.ibm.cic.common.core.preferences.readTimeout Time is expressed in a numeral for the number of seconds. The default value is 30 seconds.
You cannot set this preference in the Installation Manager interface.

com.ibm.cic.common.core.preferences.downloadAutoRetryCount A numeral to express the number of times to try the operation again. The default value is 0.
You cannot set this preference in the Installation Manager interface.

com.ibm.cic.common.core.preferences.import.enabled true or false When this key is set to true the Import wizard opens in Installation Manager. The default value is false.
The Import wizard is used only with IBM WebSphere products, see Import existing installed packages in Installation Manager.
We cannot set this preference in the Installation Manager interface.

Search for updates in silent mode
We can set preferences in a response file to automatically search for updates to installed packages or to Installation Manager. These preferences work together to find updates when we are installing with a response file.
Enable and disable preferences
As an administrator, we can remove the ability for users to edit preferences to prevent unauthorized changes. By using a response file, we can disable editing capabilities for preferences after Installation Manager is installed. Preferences that cannot be edited are shown as disabled in the Installation Manager user interface.

Home

Internet key	Value	Description
HTTP: com.ibm.cic.common.core.preferences.http.proxyEnabled	true or false	Use this key to enable an HTTP or SOCKS proxy. After the proxy is enabled, the proxy is used for all server communications. Proxy servers enable connection to remote servers from behind the firewall. The default value is false. Click File > Preferences > Internet > HTTP Proxy to set the Enable proxy server field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.
HTTP: com.ibm.cic.common.core.preferences.http.proxyUseSocks	true or false	The default value is false. Set to true to define a SOCKS proxy. The com.ibm.cic.common.core.preferences.http.proxyEnabled key must be set to true to define the com.ibm.cic.common.core.preferences.http.proxyUseSocks key.
HTTP: com.ibm.cic.common.core.preferences.http.proxyHost	Host name or IP address	Click File > Preferences > Internet > HTTP Proxy to set the Proxy host field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.
HTTP: com.ibm.cic.common.core.preferences.http.proxyPort	Port number	Click File > Preferences > Internet > HTTP Proxy to set the Proxy port field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.
HTTP: com.ibm.cic.common.core.preferences.HTTP11.proxyHost.for.http	Host name or IP address	To use different proxy settings for HTTP and HTTPS servers, set the HTTP proxy server using this HTTP preference. For HTTPS, use the com.ibm.cic.common.core.preferences.HTTP11.proxyHost.for.https key to define the HTTPS proxy server. This key overrides the com.ibm.cic.common.core.preferences.http.proxyHost key, if that key is defined. We cannot set this preference in the Installation Manager interface.
HTTP: com.ibm.cic.common.core.preferences.HTTP11.proxyPort.for.http	Port number	Use this key only when the com.ibm.cic.common.core.preferences.HTTP11.proxyHost.for.http key is defined. We cannot set this preference in the Installation Manager interface..
HTTP: com.ibm.cic.common.core.preferences.http.disablePreemptiveAuthentication	true or false	The default value is false. You cannot set this preference in the Installation Manager interface.
HTTPS: com.ibm.cic.common.core.preferences.https.proxyEnabled	true or false	When this key is set to false or if the value is not defined, the HTTP settings are used for HTTPS access. The default value is false. When this key is set to true, we can use different proxy settings for HTTP and HTTPS servers. We cannot set this preference in the Installation Manager interface.
HTTPS: com.ibm.cic.common. core.preferences.https. proxyUseSocks	true or false	The default value is false. When this key is set to true, the specified SOCKS proxy uses thecom.ibm.cic.common.core.preferences.SOCKS.proxyHost and com.ibm.cic.common.core.preferences.SOCKS.proxyPort keys for connections.
HTTPS: com.ibm.cic.common.core.preferences.ssl.nonsecureMode	true or false	When this key is set to true, Nonsecure SSL Mode is enabled and is set as permanent by default. Restriction: If we are using this preference key with the imutils saveCredential command, this preference is not persisted. You cannot enable Nonsecure SSL Mode with the session setting in a response file. When this key is set to false, Nonsecure SSL Mode is disabled. The default value is false. If you start Installation Manager and use a nonsecure SSL repository location, we are prompted to either remain in the secure mode or switch to a nonsecure mode. The nonsecure mode can be either permanent or for the current session only. We can switch to the nonsecure mode even if this preference is set to false. The Permanent and Sessions options that are available in Installation Manager do not have a preference key. In Installation Manager, we have the Permanent and Sessions options. When Permanent is checked, Nonsecure SSL Mode remains enabled the next time you start Installation Manager. When the Session option is checked, Nonsecure SSL Mode is enabled only for this session. Click File > Preferences > Internet to set the Nonsecure SSL Mode field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.
HTTPS com.ibm.cic.common.core.preferences.ssl.nonsecureMode_EDITABLE	true or false	When this key is set to false, the Nonsecure SSL Mode option is disabled in Installation Manager. The default value is true. We cannot set this preference in the Installation Manager interface.
HTTPS: com.ibm.cic.common.core.preferences.HTTP11.proxyHost.for.https	Host name or IP address	To use different proxy settings for HTTP and HTTPS servers, set the HTTPS proxy server using this preference. For HTTP, use the com.ibm.cic.common.core.preferences.HTTP11.proxyHost.for.http key to define the HTTP proxy server. This key overrides the com.ibm.cic.common.core.preferences.http.proxyHost key, if that key is defined. This key is used only when the com.ibm.cic.common.core.preferences.https.proxyEnabled key is defined. We cannot set this preference in the Installation Manager interface.
HTTPS: com.ibm.cic.common.core.preferences.HTTP11.proxyPort.for.https	Port number	This key overrides the com.ibm.cic.common.core.preferences.http.proxyPort key, if that key is defined. This key is used only when the com.ibm.cic.common.core.preferences.HTTP11.proxyHost.for.https key is defined. We cannot set this preference in the Installation Manager interface..
FTP: com.ibm.cic.common.core.preferences.ftp.proxyEnabled	true or false	False is the default value. When set to true, the specified SOCKS proxy uses the com.ibm.cic.common.core.preferences.SOCKS.proxyHost and com.ibm.cic.common.core.preferences.SOCKS.proxyPort keys for FTP connections. Click File > Preferences > Internet > FTP Proxy to set the SOCKS proxy host field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.
FTP: com.ibm.cic.common.core.preferences.SOCKS.proxyHost	Host name or IP address	Click File > Preferences > Internet > FTP Proxy to set the Enable proxy server field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.
FTP: com.ibm.cic.common.core.preferences.SOCKS.proxyPort	Port number	Click File > Preferences > Internet > FTP Proxy to set the SOCKS proxy port field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.
For UNIX: http.ntlm.auth.kind	Values: LM, NTLM, or NTLMv2	This key specifies the type of authentication scheme used. The default value is NTLM. Definition of values: LM: LANMANAGER authentication is used NTLM: NTLM version 1 authentication is used NTLMv2: NTLM versions 2 authentication is used. We cannot set this preference in the Installation Manager interface. For information about authentication schemes, see Supported authentication schemes Authentication schemes for Windows are configured using the LMCompatibilityLevel registry key.

Passport Advantage key	Value	Description
PassportAdvantageIsEnabled	true or false	The default value is false. Click File > Preferences > Passport Advantage to set the Connect to Passport Advantage field in Installation Manager. On the OS X, the Preferences option is under the IBM Installation Manager menu.
PassportAdvantageIsEnabled_EDITABLE	true or false	When this key is set to true, the key enables the Connect to Passport Advantage preference. True is the default value. When set to false, the preference is disabled. We cannot set this preference in the Installation Manager interface.
PassportAdvantageSiteId	Site number for Passport Advantage

Other keys	Value	Description
com.ibm.cic.common.core.preferences.logLocation		The value for this key specifies the location of Installation Manager log file. This key is optional. If we do not specify a location for the log file, both silent installations and interactive installations use the same location. We cannot set this preference in the Installation Manager interface.
com.ibm.cic.license.policy.location		Use this key to specify a URL that defines the location of the remote license policy file. We cannot set this preference in the Installation Manager interface.
com.ibm.cic.common.core.preferences.eclipseCache	The default value is provided by the product we are installing.	This key specifies the location of the shared resources directory. The shared resource directory is specified the first time we install a package. We cannot change this location after we install a package. This preference is set during the installation process when using the Installation Manager interface.
com.ibm.cic.common.core.preferences.http.enableGzipAcceptEncoding	true or false	When this key is set to true or when this key is not in the response file, a request is issued for a repository.xml file over HTTP or HTTPS. This request includes an Accept-Encoding:gzip request header. The default value for this preference is false. When this key set to false, the request does not include the Accept-Encoding:gzip request header. You cannot set this preference in the Installation Manager interface.
com.ibm.cic.common.core.preferences.connectTimeout	Time is expressed in a numeral for the number of seconds.	The default value is 30 seconds. You cannot set this preference in the Installation Manager interface.
com.ibm.cic.common.core.preferences.readTimeout	Time is expressed in a numeral for the number of seconds.	The default value is 30 seconds. You cannot set this preference in the Installation Manager interface.
com.ibm.cic.common.core.preferences.downloadAutoRetryCount	A numeral to express the number of times to try the operation again.	The default value is 0. You cannot set this preference in the Installation Manager interface.
com.ibm.cic.common.core.preferences.import.enabled	true or false	When this key is set to true the Import wizard opens in Installation Manager. The default value is false. The Import wizard is used only with IBM WebSphere products, see Import existing installed packages in Installation Manager. We cannot set this preference in the Installation Manager interface.