Command-line arguments for imcl
Use this reference table to learn more about using the commands in the Installation Manager command line (imcl).
You must run imcl commands from the tools directory. See Locating the tools directory for more information about the tools directory.
- You cannot use imcl from the installer if an earlier version of Installation Manager is installed.
- Include quotation marks around filepaths that have spaces.
imcl commands
Commands Description imcl encryptString stringToEncryptEncrypts the entered string. Use encryptString with -passwordKey to increase encryption security. imcl exportInstallData outputFileNameExports installation data to the specified file in a .zip format where outputFileName is the name of the generated file that contains the exported data. imcl help, -help, -h, ?, -? imcl help command imcl help allRun the help command to view the available commands for Installation Manager. When the help command is used with another command, a short description of the command shows. When used with all, additional help commands display.
imcl input response_fileSpecify a response file for silent installation with the input command. Do not use input with the following commands:
imcl install id_version,feature -optionsInstall packages, updates, fixes, or features. Packages are specified by a package ID. Separate a list of packages with spaces. Optionally, you 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.
Do not use install with the following commands:
- input, -input
- installAll, -installAll
- updateAll, -updateAll
- uninstall
- uninstallAll
imcl installAllinstallAll is deprecated starting in Installation Manager version 1.4.4. It is recommended that you do not use this command because of a number of potential issues related to installing multiple products at the same time. For example:
- The installation fails if the packages have the same default installation directories but the packages cannot be installed into the same package group.
- The installation might be problematic for packages requiring additional information for installation. The user must provide required data using the -properties option that can cause data collisions among packages.
- You cannot control where extension packages are installed.
- Installation of many packages at the same time might require a significant amount of disk space and might take a long time to complete.
Install all packages in a specified repository. This command installs all packages from accessible repositories into their default installation directories. It can install only selected packages by default package features.
Do not use installAll with the following commands:
- input, -input
- install
- updateAll, -updateAll
- uninstall
- uninstallAll
imcl listAvailableFixesPrint information to the console about the available fixes for the specified package. Use the listAvailableFixes command with:
- -connectPassportAdvantage: add the IBM Passport Advantage repository to the repository list when searching and copying the specified package.
- -long: includes more details in the output.
- -repositories: specifies the repositories to use.
- -useServiceRepository: searches service repositories for the specified package.
If the -long option is used, the following information is printed:
repository : packageId_packageInternalVersion : recommend= True | False
listAvailableFixes shows all available fixes, including fixes that might not be appropriate to use in your environment.
imcl listAvailablePackagesPrint information to the console about the available packages. If the -features option is used, information about the features is printed. If the -long option is used, the following information is printed: repository : packageId_packageInternalVersion : package_name : package_version
- listAvailablePackages shows all available packages, including packages that might not be appropriate to use in your environment.
- The -features option shows all features, including features that might not be appropriate to use in your environment.
imcl listInstallationDirectoriesPrint information to the console about the installation directory, the shared resources directory, the name of the package group and installed translations. If the -long option is used, the following information is printed:
* | shared_resources_directory
installation_directory : package_group_name : installed_translationsIf the -verbose option is used, the following information is printed:
[Shared]
Shared resources directory: shared_resources_directory
[Package group]
Name: package_group_name
Installation directory: installation_directory
Translations: installed_translationsFor -long, the installed languages are returned in the ISO-639 language codes format: es, ja anden. For -verbose, the name of the language is returned: Spanish, Japanese, and English.
imcl listInstalledFeaturesPrint information to the console about installed features for the specified package. If the -long option is used, the following information is printed: feature_id : feature_name. An error is returned if a specified package is found in more than one installation directory. Use the -installationDirectory option to specify the installation directory.
imcl listInstalledPackagesPrint information to the console about the installed packages. If the -features option is used, information about the installed features is printed. If the -long option is used, the following information is printed: installation_directory : packageId_packageInternalVersion : package_name : package_version : features_list
imcl uninstallUninstall packages, updates, fixes, or features. Packages are specified by a package ID. Optionally, you can add an underscore with the version to the package ID and add a list of features that are separated by commas. Use the -installationDirectory option to identify the location of the packages. Use the -properties option to identify the package ID and optionally, the version and feature list.
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.
Do not use uninstall with the following commands:
- input, -input
- install
- installAll, -installAll
- updateAll, -updateAll
- uninstallAll
imcl uninstallAllUninstall all installed packages. Use the -installationDirectory option to identify the location of the packages. Use the -properties option to identify the package ID.
Do not use uninstallAll with the following commands:
- input, -input
- install
- installAll, -installAll
- updateAll, -updateAll
- uninstall
imcl updateAllUpdate installed packages. Use the updateAll command to update installed packages from service repositories and repositories defined in the Installation Manager preferences.
Use the updateAll command with:
- -installFixes: installs fixes.
- -properties: defines the profile properties of the package group.
- -repositories: overrides the list of repositories in Installation Manager and specifies where the packages are located.
Do not use updateAll with the following commands:
- input, -input
- install
- installAll, -installAll
- uninstall
- uninstallAll
imcl versionShows the version and internal version of Installation Manager. For backwards compatibility, this command can be used with a dash: -version. .
imcl options
Options Description -acceptLicenseIf the package you are installing requires that the license agreement is accepted, include the -acceptLicense option with the installation command. -accessRights modeSee Installation Manager command-line arguments in the Installation Manager information center for more information about -accessRights. You cannot change the mode that the installed packages are run in with the -accessRights option. -accessRights specifies only the mode to run Installation Manager in.
-connectPassportAdvantageAdd the Passport Advantage repository to the repository list when searching and copying the specified package. If you are obtaining your installation files from Passport Advantage, include the -connectPassportAdvantage option with the listAvailableFixes or listAvailablePackages command that you are running. This command can be used only with listAvailableFixes and listAvailablePackages.
-consoleMode, -cStart Installation Manager in console mode. Use this command to start Installation Manager with an interactive text user interface.
-dataLocation, dL directorySee Installation Manager command-line arguments in the Installation Manager information center for more information about -dataLocation. The directory location set by -datalocation must not be a subdirectory of the Installation Manager installation directory.
-eclipseLocation eclipse_directoryThe Eclipse target directory for installing into an existing Eclipse location. You can use the -eclipseLocation option with the install or installAll commands. installAll is deprecated starting in Installation Manager version 1.4.4. It is recommended that you do not use this command because of a number of potential issues related to installing multiple products at the same time.
-featuresYou can include features in the list of packages you return with the listAvailablePackages or listInstalledPackages commands using the -features option. -installationDirectory installation_directoryDirectory 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 -installationDirectory installation_directory with the following commands:
- input: provides an installation directory for an install command in the input file that does not have a directory specified.
- install: installs packages into the specified directory.
- listInstalledPackages: lists the packages installed in the specified directory.
- uninstall, uninstallAll: uninstalls packages from the specified directory.
-installFixes [none|recommended|all]Choose to install or not to install fixes with the offering. Valid values are none, recommended, and all. This option can be used with the following commands:
- install: If the offering version is specified, the -installFixes option defaults to none . If no offering version is specified, -installFixes defaults to all.
- installAll, -installAll: If the -installFixes option is not specified, the default value none is used.
- updateAll, -updateAll: If the -installFixes option is not specified, the default value all is used.
installAll is deprecated starting in Installation Manager version 1.4.4. It is recommended that you do not use this command because of a number of potential issues related to installing multiple products at the same time.
-keyring keyring_file -password passwordSpecify the keyring file that contains the credentials for authenticating with protected repositories, such as Passport Advantage. If your keyring file is protected, include the password option and the password for the keyring file. This option is not unique to imcl. See Installation Manager command-line arguments in the Installation Manager information center for more information about keyring files.
-log, -l log_fileSpecifies a log file that records the result of the silent installation. The log file is an XML file. When your silent installation completes, the log file contains the root element of result/result. When errors occur during the installation, the silent installation log file contains error elements and messages.
Do not use -log when recording a response file.
-longWhen specified, your summary includes the repository paths, the package IDs and versions, the display names and versions, and the feature IDs. Use with the listAvailableFixes, listAvailablePackages, listInstallationDirectories, listInstalledFeatures and listInstalledPackages commands to view additional information about packages and features.
Do not use -long with the -verbose option.
-mode wizard is deprecated starting in Installation Manager version 1.4.4.
-mode wizard
Runs the Install wizard with the specified response file. You must use input when using -mode wizard. For version 1.4.4, use IBMIM input response_file -acceptlicense to start the Install wizard.
-nl valueWhen 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. Example: -nl es The following list contains the currently supported language codes that can be listed as locale values:
- Arabic (ar)
- Czech (cs)
- Danish (da)
- English (en)
- French (fr)
- German (de)
- Greek (el)
- Hungarian (hu)
- Italian (it)
- Japanese (ja)
- Korean (ko)
- Lithuanian (li)
- Polish (pl)
- Portuguese (pt_BR)
- Russian (ru)
- Simplified Chinese (zh_CN)
- Slovenian (sl)
- Spanish (es)
- Traditional Chinese (Taiwan) (zh_TW)
- Turkish (tr)
Some languages support only partial translations. When a language is partially translated, the untranslated content defaults to English.
-passwordKey, -pK stringUse -passwordKey to encrypt or decrypt passwords. -preferences key_1=value_1, key_2=value_2Preference keys are used to customize a package installation. You can include a list of preferences by separating each with a comma.
See Silent installation preference keys for a list of available preferences.
-properties key_1=value_1a,,value_1b, key_2=value_2Properties define the package group profile properties, such as languages. You can use the -properties option with the install, installAll, updateAll, uninstall and uninstallAll commands. installAll is deprecated starting in Installation Manager version 1.4.4. It is recommended that you do not use this command because of a number of potential issues related to installing multiple products at the same time.
You can include a list of properties by separating each with a comma or a list of values by separating each with two commas.
The following list contains the currently supported property keys and related values for Installation Manager installations:
- The eclipseLocation key specifies an existing Eclipse location value, such as c:\myeclipse\eclipse.
- The cic.selector.nl key specifies the language pack to be installed, using ISO-639 language codes such as zh, ja and en. If you are installing the translations for an offering, include cic.selector.nl property key in your command. Example: -properties cic.selector.nl=en,,fr,,pt_br. Your language choices apply to all packages installed in the package group.
You can find additional property keys in the documentation for the product you are installing.
For a complete list of language codes, see the -nl option .
-record responseFileGenerates a response file from actions in the Installation Manager UI, command line, or console mode, and specifies the location of the response file. -repositories source_repository_1, source_repository_2The source repository or repositories where the available packages are installed from. You can use the -repositories option with the install, installAll, updateAll, uninstall, uninstallAll, listAvailableFixesand listAvailablePackages commands. installAll is deprecated starting in Installation Manager version 1.4.4. It is recommended that you do not use this command because of a number of potential issues related to installing multiple products at the same time.
You can include a list of repositories by separating each with a comma.
You can use a file path or a URL for the -repositories value.
-sharedResourcesDirectory shared_directoryThe shared resources directory. If a shared resources directory has already been created, you must use that location. If you want to change the shared resources directory, you must uninstall all packages and install the packages into the new location. You can use -sharedResourcesDirectory with install and installAll commands. installAll is deprecated starting in Installation Manager version 1.4.4. It is recommended that you do not use this command because of a number of potential issues related to installing multiple products at the same time.
-showProgress, -sPShows a progress bar on the console. -showVerboseProgress, -sPShows progress text on the console. For example, the text Reboot the machine to complete the install. is shown when restarting the computer is required. Starting with version 1.4.4, -silent is deprecated.
-silent, -s
- -silent installAll -nosplash --launcher.suppressErrors
- -silent updateAll -nosplash --launcher.suppressErrors
Specifies that the installer or Installation Manager run in silent mode. Use -silent installAll -nosplash --launcher.suppressErrors to silently install all available packages.
Use -silent updateAll -nosplash --launcher.suppressErrors to silently update all installed packages.
Do not use the input command with the installAll and updateAll commands. With installAll, the default features for a package are installed. To specify the features that are installed, you must use input responseFile. The response file contains the information about the features to install.
When you record a response file, you can select the features to install.
installAll is deprecated starting in Installation Manager version 1.4.4. It is recommended that you do not use this command because of a number of potential issues related to installing multiple products at the same time. For more information, see installAll .
-skipInstall, -sI dataLocationRecords a response file without installing the IBM product. The dataLocation value specifies the directory location for the installation folders and files. Although the IBM product is not installed, the files and folders that are required for installation are created and stored in the specified directory. The directory must be writable. Verify that the file paths exist. Installation Manager does not create directories for response files.
Do not specify an existing dataLocation directory for the new dataLocation location value. See Agent data location for default locations of the dataLocation directory.
When you record a response file using the -skipInstall option, you must keep the directory, folders, and files that are created. By keeping the dataLocation directory, you can modify the installation later. When you record a new response file to modify the installation, you specify the same directory for dataLocation.
Use a different dataLocation value for each version of an IBM product that you install.
You must first record an installation of an IBM product using -skipInstall before you record an update.
-useServiceRepositoryUse this option with the listAvailablePackages and listAvailableFixes commands to search repositories for a specified package. For information about service repositories, see Searching service repositories