imcl commands and arguments

imcl commands and options
Run "imcl command options from the tools directory. We cannot use the imcl commands from the IM installer if an earlier version of Installation Manager is installed. Enclose file paths that include spaces with double quotation marks.

Command Description
encryptString string Encrypt string. Use with -passwordKey.
exportInstallData outputFileName Export the installation data to the specified file in a compressed file format where outputFileName is the name of the generated file that contains the exported data.
help, -h, ?, -? help command, help all View available commands for imcl. When used with command, a short description of the command is shown. When used with the all option, more help commands are shown.
import Add existing packages that we installed with installation tools other than Installation Manager. By importing these packages, we can use Installation Manager to manage the packages. Use the -installationDirectory option to specify the directory where the existing package is installed. The import command is used only with IBM WebSphere Application Server products.
Use with options:
-eclipseLocation, -installationDirectory, -keyring (deprecated), -masterPasswordFile (-secureStorageFile), -password (deprecated), -preferences, -prompt, -properties, -repositories, -secureStorageFile, -sharedResourcesDirectory

Do not use the import command with these commands:
input, install, modify, rollback, uninstall, uninstallAll, updateAll

input response_file Response file for silent installation with the input command.
Use with options:
-installationDirectory, -keyring (deprecated), -masterPasswordFile (-secureStorageFile), -password: (deprecated), -prompt, -secureStorageFile, -variables

Do not use the input command with:

import, install, modify, rollback, uninstall, uninstallAll, updateAll

install packageId[_version][,featureID] Install packages, updates, fixes, or features. Packages are specified by a package ID. Separate a list of packages with spaces. Optionally, we can add an underscore with the version to the package ID and add a list of features that are separated by commas. If a version is not specified, the latest version of the package is installed. If a list of features is not specified, the default features are installed.
Use with options:
-acceptLicense, -connectPassportAdvantage, -eclipseLocation, -installationDirectory, -installFixes, -keyring (Deprecated), -masterPasswordFile (-secureStorageFile), -password (deprecated), -preferences, -prompt, -properties, -repositories, -secureStorageFile, -sharedResourcesDirectory, -useServiceRepository

Do not use the install command with these commands:
import, input, modify, rollback, uninstall, uninstallAll, updateAll,

listAvailableFixes packageID_version List all available fixes, including fixes that might not be appropriate to use in your environment.
Use with options:
-connectPassportAdvantage, -keyring (deprecated) , -long, -masterPasswordFile: (-secureStorageFile on), -password (deprecated), -prompt, -preferences, -repositories, -secureStorageFile, -showPlatforms, -useServiceRepository

listAvailablePackages List available packages, including packages that might not be appropriate to use in your environment. Options:
-connectPassportAdvantage, -features, -keyring (Deprecated), -long, -masterPasswordFile (-secureStorageFile) , -password (Deprecated), -prompt, -preferences, -repositories, -secureStorageFile, -showPlatforms, -useServiceRepository

listInstallationDirectories Print information to the console about the installation directory, the shared resources directory, the name of the package group, and installed translations.
-long, -verbose

listInstalledFeatures packageID_version Print information to the console about installed features for the specified package. Options:
-installationDirectory, -long

listInstalledPackages Print information to the console about the installed packages. Options:
-features, -installationDirectory, -long, -rollbackVersions, -verbose

modify packageID[_version] Change the installed software packages. Packages are specified by a package ID. Optionally, we can add an underscore with the version of the package ID. Features can be added or removed from the packages. Use the -addFeatures option to specify the features to add. Use the -removeFeatures option to specify the features to remove.
Use with options:
-addFeatures, -connectPassportAdvantage, -installationDirectory, -keyring (deprecated), -masterPasswordFile (-secureStorageFile) , -password (Deprecated), -prompt, -properties, -removeFeatures, -repositories, -secureStorageFile (available), -useServiceRepository

We must use at least one of these options when using the modify command: -addFeatures, -properties, or -removeFeatures. Do not use the modify command with these commands:
import, input, install, rollback, uninstall, uninstallAll, updateAll

rollback packageID[_version] Revert to an earlier version of installed packages. Packages are specified by a package ID. Optionally, we can add an underscore with the version of the package ID to roll back to. If the version is not specified, then the package rolls back to the previous version. When you specify multiple packages, all the packages must be installed to the same installation directory. We cannot roll back Installation Manager to an earlier version.
Use with options:
-connectPassportAdvantage, -installationDirectory, -keyring (Deprecated), -masterPasswordFile: (-secureStorageFile) -password (Deprecated), -prompt, -properties, -repositories, -secureStorageFile

Do not use the rollback command with these commands:
import, input, install, modify, uninstall, uninstallAll, updateAll,

uninstall packageID[_version][,featureID] Uninstall packages, updates, fixes, or features.
Packages are specified by a package ID. Optionally, we can add an underscore with the version to the package ID and add a list of features that are separated by commas. If a version is not specified, the latest version of the package is uninstalled. If a list of features is not specified, the default features are uninstalled.
Use with options:
-installationDirectory -keyring (deprecated) -masterPasswordFile (-secureStorageFile) on. -password (Deprecated) -preferences -properties -secureStorageFile

Do not use the uninstall command with these commands:
import, input, install, modify, rollback, uninstallAll, updateAll,

uninstallAll Uninstall all installed packages.
Use with options:
-installationDirectory, -keyring (Deprecated), -masterPasswordFile (-secureStorageFile) -password: (Deprecated) -properties -secureStorageFile

Use the -installationDirectory option to uninstall only the packages in the specified installation directory. Do not use the uninstallAll command with these commands:
import, input, install, modify, rollback, uninstall, updateAll

updateAll Update all installed packages from service repositories and repositories defined in the Installation Manager preferences.
Use with options:
-connectPassportAdvantage, -installationDirectory, -installFixes, -masterPasswordFile (-secureStorageFile), -prompt, -properties, -repositories, -secureStorageFile, -useServiceRepository

Use the -installationDirectory option to update only the packages in the specified installation directory. Do not use the updateAll command with these commands:
import, input, install, modify, rollback, uninstall, uninstallAll

version Show the version and internal version of Installation Manager. For 64-bit operating systems, information about the architecture shows. For 32-bit operating systems, the architecture information does not show.
viewLicense packageID_version New in version 1.7:
View license from the command line.
Use with options:
-connectPassportAdvantage, -keyring: (Deprecated) , -masterPasswordFile (-secureStorageFile), -password: (Deprecated) , -preferences, -prompt, -repositories, -secureStorageFile, -useServiceRepository

viewLog [logFile] View log files. If logFile is not specified, a list of log files is returned. If logFile is specified, entries from the specified log file are shown.

Command options

Options Description
-acceptLicense Indicate acceptance of the license agreement. If the package that we install requires that you accept the license agreement, we must include the -acceptLicense option with the installation command.
-addFeatures featureID1, featureID2 Specify the features to add using a comma-separated list. Use this option with this command: modify
-connectPassportAdvantage Add the IBM Passport Advantage repository to the repository list. Use with commands:
install, listAvailableFixes, listAvailablePackages, modify, rollback, updateAll

-consoleMode, -c Start Installation Manager in console mode. Use this option to start Installation Manager with an interactive user interface.
New in version 1.7:
We can use options -secureStorageFile and -masterPasswordFile with console mode (-c or -consoleMode).
-dataLocation, dL directory Location for the data directory, which stores information about installed packages. We set this location when we install Installation Manager. Use this option with the Installation Manager installer only. Do not use this option when starting an installed instance of Installation Manager. Do not change this argument after Installation Manager is installed. Changing this argument can damage the installation data. This damage can prevent you from modifying, updating, rolling back, or uninstalling installed packages. If we specify a directory location for -dataLocation that is not the default value, the same location must be used each time that we use the Installation Manager installer using the -datalocation option. The installed instance of Installation Manager uses the specified location automatically. The location that the -datalocation option sets must not be a subdirectory of the Installation Manager installation directory.
-eclipseLocation eclipse_directory Indicate the Eclipse target directory for installing into an existing Eclipse location. Use the option with this command:
import, install

-features Include information about features in the list of packages. Use with commands:
listAvailablePackages, listInstalledPackages

Do not use the -features option with the -verbose option:
-installationDirectory installation_directory Specify the directory path to the installation location. The same package might be installed in more than one location. Use this option to specify the installation location. Use with commands:
import, input, install, listInstalledFeatures, listInstalledPackages, modify, rollback, uninstall, uninstallAll, updateAll

-installFixes none|recommended|all Choose to install or not to install fixes with the offering. Valid values are none, recommended, and all. Use with commands:

install: If the offering version is specified, the -installFixes option defaults to none. If no offering version is specified, the -installFixes option defaults to all.
updateAll: If the -installFixes option is not specified, the -installFixes option defaults to all.

-keyring keyring_file [ -password password ] The -keyring and -password options are deprecated. Use the -secureStorageFile and -masterPasswordFile options to store credentials.
Specify the key ring file that contains the credentials for authenticating with protected repositories, such as Passport Advantage.
If wer key ring file is protected, include the -password option and the password for the key ring file. See: Installation Manager command-line arguments for silent mode.
-log, -l log_file Specify a log file that records the result of Installation Manager operations. The log file is an XML file. The log file contains no entries if the installation, update, modify, roll back, or uninstall process completes successfully. The log file contains an error entry when the process is not successful. An example of a log file for a completed installation:
<?xml version="1.0" encoding="UTF-8"?>
<result>
</result>

Do not use the -log option when we record a response file.
-long Include information about the repository paths, the package IDs and versions, the display names and versions, and the feature IDs. Use with commands:
listAvailableFixes, listAvailablePackages, listInstallationDirectories, listInstalledFeatures, listInstalledPackages

Do not use the -long option with the option:
-verbose

-nl value Specify the language to use. When you include the nl option and a language code with an imcl command, the behavior of the command line adjusts according to the settings for the specified language. For example: -nl es. Our language choices apply to all packages installed in the package group. A list of language codes can be found at the Library of Congress site Codes for the Representation of Names of Languages. Installation Manager supports only some of the languages that are listed. Of those languages, Installation Manager uses the ISO 639-1 Code which specifies two-letter codes. Installation Manager does not use the ISO 639-2 Code which specifies three-letter codes. Some languages support only partial translations. When a language is partially translated, the non-translated content is presented in English. For a list of languages that Installation Manager supports, see Start Installation Manager. For a list of languages that a package supports, see the documentation for that package.
passwordKey -pK string Encrypt or decrypt passwords.
-portable Use this option to install or manage a portable installation of a product if the product supports it.
If we move a portable installation of a product to another location, the installation will still work.
-preferences key_1=value_1, key_2=value_2 Use preference keys to customize a package installation.
We can include a list of preferences by separating each preference with a comma.
See Silent installation preference keys for a list of available preferences.
-prompt Include the -prompt option when we must enter credentials to access a server.
Use with commands:
import
input
install
listAvailableFixes
listAvailablePackages
modify
rollback
updateAll

We cannot use -prompt with console mode (-c or -consoleMode).
-properties key_1=value_1a, value_1b, key_2=value_2 Define the package group profile properties, such as languages. We can include a list of properties by separating each with a comma. For properties that have multiple values, use two commas between the values: key_1=value_1a,,value_1b. The list contains the predefined property keys and related values:

eclipseLocation #xisting Eclipse location value, such as c:\myeclipse\eclipse.
cic.selector.arch Architecture to install: 32-bit or 64-bit.
cic.selector.os Operating system.
cic.selector.ws Type of window system.
cic.selector.nl Language pack to install using ISO-639 language codes such as zh, ja, and en.
If we install the translations for an offering, we must include the cic.selector.nl property key in your command. Example: -properties cic.selector.nl=en,,fr,,pt_BR. Our language choices apply to all packages installed in the package group.

We can find more property keys in the documentation for the product that we install. Use with commands:
import
install
modify
rollback
uninstall
uninstallAll
updateAll

-record responseFile Generate a response file from actions in the Installation Manager UI, command line, or console mode, and specify the location of the response file.
-reinstallIM Install the same version or a later version of Installation Manager when you have issues with the current installation of Installation Manager. We must specify the location of the current installation; otherwise Installation Manager is installed into the default installation location. If the current installation is not in the default directory, we can use the -installationDirectory option to specify the directory of the current installation.
If we do not use the -installationDirectory option and the current installation is in a non-default directory, instead of updating the current installation, the -reinstallIM option places a new installation in the default directory and you have two different installations on our computer. Installation Manager is uninstalled and then installed when we use this option. We do not have to uninstall any of the installed packages. When we use the -reinstallIM option with the install command, we must specify the Installation Manager package, com.ibm.cic.agent, in the command. When we use the -reinstallIM option with the input command, the response file must specify a version of Installation Manager for installation. See Modify a response file to install a package and Installation Manager. Use with these commands:
install
input

-removeFeatures featureID1,featureID2 Specify the features to remove using a comma-separated list. Use the option with this command:
modify

For more information about the -removeFeatures option, see Modify packages using imcl commands.
-rollbackVersions New in version 1.7: List the package versions that we can roll back to. Use with commands:
listInstalledPackages
Do not use the -rollbackVersions option with options:
-verbose

-repositories source_rep_1, source_rep_2 Indicate the location that contains the installation files for the available packages. We can include a list of repositories by separating each repository with a comma. We can use a file path or a URL for the -repositories value. Use with commands:
import
install
listAvailableFixes
listAvailablePackages
modify
rollback
updateAll

-secureStorageFile storage_file
-masterPasswordFile master_password_file Use these options to store credentials for repository authentication. The -secureStorageFile option specifies the file and path to the storage file. The -masterPasswordFile option specifies the file and path to the master password file. The master password file is a text file that contains a passphrase and used to encrypt sensitive contents in the storage file.
Use with commands:
import
input
install
listAvailableFixes
listAvailablePackages
modify
rollback
uninstall
uninstallAll
updateAll

Do not use the -secureStorageFile option or the -masterPasswordFile with this option: -password
New in version 1.7: Installation Manager uses Equinox Secure Storage mechanism (instead of the keyring mechanism).
If we do not specify the -secureStorageFile option, then Installation Manager generates a default storage file in the user_home/.eclipse/org.eclipse.equinox.security/secure_storage folder.
If we do not specify the -masterPasswordFile option, Installation Manager uses a predefined password. To specify the password at the command line, use the -prompt option.
-sharedResourcesDirectory shared_directory Set the shared resources directory. A shared resources directory is created the first time that we install a package. We do not have to use this option when we install other packages. If a shared resources directory exists, use that location.
To change the shared resources directory, we must uninstall all packages and then install the packages and use a new shared resources location. Use the option with this command:
import
install

-showPlatforms Lists the operating system and architecture values that a package supports. Use with commands:
listAvailableFixes
listAvailablePackages

The -showPlatforms option returns information about the operating system, os, and the architecture, arch. For fixes, if the fix supports the same platforms as the package that the fix applies to, the SAME_AS_PACKAGE keyword shows instead of an os.arch value. For information about the os and arch values that this option returns, see Values for cic.selector.key keys.
Check the package documentation to determine the supported operating systems and architectures for that package.
-showProgress, -sP Show a progress bar on the console.
-showVerboseProgress, -sVP Show progress text on the console. For example, the following text is shown when the computer must be restarted: Reboot the machine to complete the install.
-stopBlockingProcesses On Windows, stops running processes that lock package files. Installation Manager must be able to access or modify these locked files.
The -stopBlockingProcesses option works only if a package enables support for this option.
-useServiceRepository Search the service repositories. If the source repository contains the package that you specified using an ID and version, the service repositories are not searched.
Use with commands:
install, listAvailableFixes, listAvailablePackages, modify, updateAll

The -useServiceRepository option overrides the -preferences offering.service.repositories.areUsed=false option. See Search service repositories.
-variables name1=value1,name2=value2 Set or override a response file variable value on the command line. If the value of a variable contains a comma (,), use two commas.

-variables name1=value1partA,,value1partB

Use with commands:
input response_file

See Response file variables.
-verbose Show more information when we run a command. Use with commands:
listInstallationDirectories, listInstalledPackages

Do not use the -verbose option with the options:
-long, -features, -rollbackVersions

Values for cic.selector.key

Platform cic.selector.os value cic.selector.arch value cic.selector.ws value cic.selector.nl value

32-bit 64-bit
AIX aix ppc ppc64 motif
gtk
HP-UX hpux ia64_32 ia64 motif
gtk
IBM i os400 ppc ppc64 motif
Linux linux ppc
s390
x86
ppc64
s390x
x86_64
gtk
OS X macosx x86 x86_64 cocoa
Solaris solaris sparc
x86
sparc64
x86_64
gtk
Windows win32 x86 x86_64 win32
IBM z/OS zos s390 s390x motif

We can access a list of language codes at the Library of Congress site Codes for the Representation of Names of Languages. Installation Manager supports only some of the languages that are listed. Of those languages, Installation Manager uses the ISO 639-1 Code, which uses the two-letter codes and not the ISO 639-2 Code, which uses the three-letter codes. Some languages support only partial translations. When a language is partially translated, the non-translated content is presented in English. For a list of languages that Installation Manager supports, see Start Installation Manager. For a list of languages that a package supports, see the documentation for that package.
Home

Command	Description
encryptString string	Encrypt string. Use with -passwordKey.
exportInstallData outputFileName	Export the installation data to the specified file in a compressed file format where outputFileName is the name of the generated file that contains the exported data.
help, -h, ?, -? help command, help all	View available commands for imcl. When used with command, a short description of the command is shown. When used with the all option, more help commands are shown.
import	Add existing packages that we installed with installation tools other than Installation Manager. By importing these packages, we can use Installation Manager to manage the packages. Use the -installationDirectory option to specify the directory where the existing package is installed. The import command is used only with IBM WebSphere Application Server products. Use with options: -eclipseLocation, -installationDirectory, -keyring (deprecated), -masterPasswordFile (-secureStorageFile), -password (deprecated), -preferences, -prompt, -properties, -repositories, -secureStorageFile, -sharedResourcesDirectory Do not use the import command with these commands: input, install, modify, rollback, uninstall, uninstallAll, updateAll
input response_file	Response file for silent installation with the input command. Use with options: -installationDirectory, -keyring (deprecated), -masterPasswordFile (-secureStorageFile), -password: (deprecated), -prompt, -secureStorageFile, -variables Do not use the input command with: import, install, modify, rollback, uninstall, uninstallAll, updateAll
install packageId[_version][,featureID]	Install packages, updates, fixes, or features. Packages are specified by a package ID. Separate a list of packages with spaces. Optionally, we can add an underscore with the version to the package ID and add a list of features that are separated by commas. If a version is not specified, the latest version of the package is installed. If a list of features is not specified, the default features are installed. Use with options: -acceptLicense, -connectPassportAdvantage, -eclipseLocation, -installationDirectory, -installFixes, -keyring (Deprecated), -masterPasswordFile (-secureStorageFile), -password (deprecated), -preferences, -prompt, -properties, -repositories, -secureStorageFile, -sharedResourcesDirectory, -useServiceRepository Do not use the install command with these commands: import, input, modify, rollback, uninstall, uninstallAll, updateAll,
listAvailableFixes packageID_version	List all available fixes, including fixes that might not be appropriate to use in your environment. Use with options: -connectPassportAdvantage, -keyring (deprecated) , -long, -masterPasswordFile: (-secureStorageFile on), -password (deprecated), -prompt, -preferences, -repositories, -secureStorageFile, -showPlatforms, -useServiceRepository
listAvailablePackages	List available packages, including packages that might not be appropriate to use in your environment. Options: -connectPassportAdvantage, -features, -keyring (Deprecated), -long, -masterPasswordFile (-secureStorageFile) , -password (Deprecated), -prompt, -preferences, -repositories, -secureStorageFile, -showPlatforms, -useServiceRepository
listInstallationDirectories	Print information to the console about the installation directory, the shared resources directory, the name of the package group, and installed translations. -long, -verbose
listInstalledFeatures packageID_version	Print information to the console about installed features for the specified package. Options: -installationDirectory, -long
listInstalledPackages	Print information to the console about the installed packages. Options: -features, -installationDirectory, -long, -rollbackVersions, -verbose
modify packageID[_version]	Change the installed software packages. Packages are specified by a package ID. Optionally, we can add an underscore with the version of the package ID. Features can be added or removed from the packages. Use the -addFeatures option to specify the features to add. Use the -removeFeatures option to specify the features to remove. Use with options: -addFeatures, -connectPassportAdvantage, -installationDirectory, -keyring (deprecated), -masterPasswordFile (-secureStorageFile) , -password (Deprecated), -prompt, -properties, -removeFeatures, -repositories, -secureStorageFile (available), -useServiceRepository We must use at least one of these options when using the modify command: -addFeatures, -properties, or -removeFeatures. Do not use the modify command with these commands: import, input, install, rollback, uninstall, uninstallAll, updateAll
rollback packageID[_version]	Revert to an earlier version of installed packages. Packages are specified by a package ID. Optionally, we can add an underscore with the version of the package ID to roll back to. If the version is not specified, then the package rolls back to the previous version. When you specify multiple packages, all the packages must be installed to the same installation directory. We cannot roll back Installation Manager to an earlier version. Use with options: -connectPassportAdvantage, -installationDirectory, -keyring (Deprecated), -masterPasswordFile: (-secureStorageFile) -password (Deprecated), -prompt, -properties, -repositories, -secureStorageFile Do not use the rollback command with these commands: import, input, install, modify, uninstall, uninstallAll, updateAll,
uninstall packageID[_version][,featureID]	Uninstall packages, updates, fixes, or features. Packages are specified by a package ID. Optionally, we can add an underscore with the version to the package ID and add a list of features that are separated by commas. If a version is not specified, the latest version of the package is uninstalled. If a list of features is not specified, the default features are uninstalled. Use with options: -installationDirectory -keyring (deprecated) -masterPasswordFile (-secureStorageFile) on. -password (Deprecated) -preferences -properties -secureStorageFile Do not use the uninstall command with these commands: import, input, install, modify, rollback, uninstallAll, updateAll,
uninstallAll	Uninstall all installed packages. Use with options: -installationDirectory, -keyring (Deprecated), -masterPasswordFile (-secureStorageFile) -password: (Deprecated) -properties -secureStorageFile Use the -installationDirectory option to uninstall only the packages in the specified installation directory. Do not use the uninstallAll command with these commands: import, input, install, modify, rollback, uninstall, updateAll
updateAll	Update all installed packages from service repositories and repositories defined in the Installation Manager preferences. Use with options: -connectPassportAdvantage, -installationDirectory, -installFixes, -masterPasswordFile (-secureStorageFile), -prompt, -properties, -repositories, -secureStorageFile, -useServiceRepository Use the -installationDirectory option to update only the packages in the specified installation directory. Do not use the updateAll command with these commands: import, input, install, modify, rollback, uninstall, uninstallAll
version	Show the version and internal version of Installation Manager. For 64-bit operating systems, information about the architecture shows. For 32-bit operating systems, the architecture information does not show.
viewLicense packageID_version	New in version 1.7: View license from the command line. Use with options: -connectPassportAdvantage, -keyring: (Deprecated) , -masterPasswordFile (-secureStorageFile), -password: (Deprecated) , -preferences, -prompt, -repositories, -secureStorageFile, -useServiceRepository
viewLog [logFile]	View log files. If logFile is not specified, a list of log files is returned. If logFile is specified, entries from the specified log file are shown.

Platform	cic.selector.os value	cic.selector.arch value	cic.selector.ws value	cic.selector.nl value
		32-bit	64-bit
AIX	aix	ppc	ppc64	motif gtk
HP-UX	hpux	ia64_32	ia64	motif gtk
IBM i	os400	ppc	ppc64	motif
Linux	linux	ppc s390 x86	ppc64 s390x x86_64	gtk
OS X	macosx	x86	x86_64	cocoa
Solaris	solaris	sparc x86	sparc64 x86_64	gtk
Windows	win32	x86	x86_64	win32
IBM z/OS	zos	s390	s390x	motif