Back to Top
IBM Installation Manager Execute Command
| Class Name | com.midvision.rapiddeploy.orchestration.tasks.binary.installers.IbmInstallationManagerExecuteCommandTask |
| Category | IBM Installation Manager |
IBM Installation Manager Execute Command Task
Description
This task will run the IBM Installation Manager client utility to install, modify, delete a product.Usage
For a full list of command options please look at the IBM Info Center website: IBM Installation ManagerParameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| dataLocation | java.lang.String | false | Specifies the directory location for the Installation Manager data directory. This location stores information about installed packages. Set this location when installing Installation Manager. The directory location must not be a subdirectory of the Installation Manager installation directory. If you specify a directory location for dataLocation that is not the default value, the specified location must be used each time you use Installation Manager or the Installation Manager installer. For the Installation Manager installer, each time you start the installer, you must specify the same directory location using the dataLocation option. The installed instance of Installation Manager uses the specified location automatically. | |
| failOnError | java.lang.Boolean | false | false | This task will not fail the deployment on error if set to false. This scope is parameter only. |
| imclCommand | java.util.List | false | Installation manager command action to execute. Valid values are: input,install,listAvailableFixes,listAvailablePackages,listInstallationDirectories,listInstalledFeatures,listInstalledPackages,modify,rollback,uninstall,uninstallAll,updateAll,version,viewLog | |
| input | java.lang.String | true | If the Installation manager command action to execute is 'input'. Then this value is the location of the response file to use. | |
| installationDirectory | java.lang.String | true | Specifies 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. | |
| installationManagerPath | java.lang.String | false | Path to IBM Installation manager root. | |
| installFixes | java.util.List | true | Choose to install or not to install fixes with the offering. Valid values are none, recommended, and all. Use with the commands: install: If the offering version is specified, the installFixes option defaults to none. If no offering version is specified, installFixes defaults to all. updateAll: If the installFixes option is not specified, the default value all is used. | |
| installPath | java.lang.String | true | Used to check the dataLocation is not a sub-directory of the install path. | |
| logPath | java.lang.String | true | Specifies 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 when recording a response file. | |
| nl | java.util.List | true | When you include the nl option and a language code with a command, the behavior of the command line adjusts according to the settings for the specified language. 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) | |
| packageFeatures | java.lang.String | true | A list of features that are separated by commas. e.g. For WAS Express v8.5: core.feature,ejbdeploy,thinclient,embeddablecontainer,com.ibm.sdk.6_32bit,liberty | |
| packageId | java.lang.String | true | 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. e.g. For WAS Express v8.5: com.ibm.websphere.EXPRESS.v85_8.5.0.20120501_1108 | |
| passwordKey | java.lang.String | true | Uses passwordKey to encrypt or decrypt passwords. | |
| projectRelativePathToPackage | java.lang.String | true | Project relative path to the package that contains the repository.confi file. | |
| properties | java.lang.String | true | Properties define the package group profile properties, such as languages. You can include a list of properties by separating each with a comma or a list of values by separating each with two commas. | |
| repositories | java.lang.String | true | Indicate the location that contains the installation files for the available packages. You can include a list of repositories by separating each repository with a comma. You can use a file path or a URL for the repositories value. Use with the commands: install, listAvailableFixes, listAvailablePackages, modify, rollback, updateAll. If not specified it will look within the package for a repository at the top level of the package. If the repository is not found there, it will look in the projectRelativePathToPackage location and unzip the package and look within that package. projectRelativePathToPackage is mainly used for codeDeploy projects. | |
| responseFile | java.lang.String | true | Generates a response file from actions in the Installation Manger UI, command line, or console mode, and specifies the location of the response file. | |
| sharedResourcesDirectory | java.lang.String | true | Set the shared parameters directory. A shared parameters directory is created the first time you install a package. You do not need to use this option when you install other packages. If a shared parameters directory exists, you must use that location. If you want to change the shared parameters directory, you must uninstall all packages and then install the packages using a new shared parameters location. Use with the command: install | |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
Back to Top
Installation Manager is a 32-bit application hence it requires 32-bit versions of OS system libraries in order to run. There are currently no plans to convert Installation Manager into a 64-bit application. See Installation Manager support for x86 64-bit Linux The work around for this is to enable 32-bit support for the 64-bit Linux OS. In Ubuntu this can be done by executing the following command as root:
sudo apt-get install ia32-libs
1) Contain the install file downloaded from the IBM website and its location must be set in the [projectRelativePathToPackage] option. 2) Use the WGet Task or another method to download the IM Installer zip file into the ${ARCHIVE_ROOT} from the IBM WebSite prior to running this task. For a full list of command options please look at the IBM Info Center website: IBM Installation Manager
Install IBM Installation Manager
| Class Name | com.midvision.rapiddeploy.orchestration.tasks.binary.installers.IbmInstallationManagerInstallTask |
| Category | IBM Installation Manager |
Install IBM Installation Manager Task
Description
This task will install IBM Installation Manager on the target server.Installation Manager is a 32-bit application hence it requires 32-bit versions of OS system libraries in order to run. There are currently no plans to convert Installation Manager into a 64-bit application. See Installation Manager support for x86 64-bit Linux The work around for this is to enable 32-bit support for the 64-bit Linux OS. In Ubuntu this can be done by executing the following command as root:
sudo apt-get install ia32-libs
Usage
The project must either:1) Contain the install file downloaded from the IBM website and its location must be set in the [projectRelativePathToPackage] option. 2) Use the WGet Task or another method to download the IM Installer zip file into the ${ARCHIVE_ROOT} from the IBM WebSite prior to running this task. For a full list of command options please look at the IBM Info Center website: IBM Installation Manager
Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| accessRights | java.util.List | true | Get the access rights. Defines whether Installation Manager operates in administrator, nonadministrator, or group mode. Only one administrator instance of Installation Manager can be installed. For nonadminstrators, install only one instance of Installation Manager for each user. If accessRights is not used, the default value is set based on current user permissions. Installation Manager reports an error when the user does not haveappropriate system permissions. Valid values are [admin|nonAdmin|group]. | |
| connectPassportAdvantage | java.lang.String | true | Add the Passport Advantage repository to the repository list when searching and copying the specified package. | |
| dataLocation | java.lang.String | true | Specifies the directory location for the Installation Manager data directory. This location stores information about installed packages. Set this location when installing Installation Manager. The directory location must not be a subdirectory of the Installation Manager installation directory. If you specify a directory location for dataLocation that is not the default value, the specified location must be used each time you use Installation Manager or the Installation Manager installer. For the Installation Manager installer, each time you start the installer, you must specify the same directory location using the dataLocation option. The installed instance of Installation Manager uses the specified location automatically. | |
| failOnError | java.lang.Boolean | false | false | This task will not fail the deployment on error if set to false. This scope is parameter only. |
| installFixes | java.util.List | true | Choose to install or not to install fixes with the offering. Valid values are [none|recommended|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. updateAll, -updateAll: If the -installFixes option is not specified, the default value all is used. | |
| installPath | java.lang.String | true | Specifies 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. | |
| keyring | java.lang.String | true | When specified, causes Eclipse to create keyring file if a keyring file does not exist. The password argument is optional. If the password is not specified, Eclipse uses a default password. You can provide stronger encryption by specifying a password to open the keyring file. The contents of the keyring file are encrypted. You must have write permissions for the keyring file. | |
| logPath | java.lang.String | true | Specifies 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 when recording a response file. | |
| nl | java.util.List | true | When you include the nl option and a language code with a command, the behavior of the command line adjusts according to the settings for the specified language. 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) | |
| password | java.lang.String | true | Optional password to the keyring. | |
| passwordKey | java.lang.String | true | Uses passwordKey to encrypt or decrypt passwords. | |
| preferences | java.lang.String | true | Preference keys are used to customize a package installation. You can include a list of preferences by separating each with a comma. | |
| projectRelativePathToPackage | java.lang.String | true | Only used in a code deploy project. The project relative path to the installation package. | |
| properties | java.lang.String | true | Properties define the package group profile properties, such as languages. You can include a list of properties by separating each with a comma or a list of values by separating each with two commas. | |
| repositories | java.lang.String | true | The source repository or repositories where the available packages are installed from. You can use the repositories option with the install, updateAll, uninstall, uninstallAll, listAvailableFixesand listAvailablePackages commands. 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. | |
| responseFile | java.lang.String | true | Generates a response file from actions in the Installation Manger UI, command line, or console mode, and specifies the location of the response file. | |
| sharedResourcesDirectory | java.lang.String | true | The shared parameters directory. If a shared parameters directory has already been created, you must use that location. If you want to change the shared parameters directory, you must uninstall all packages and install the packages into the new location. You can use sharedResourcesDirectory with install command. | |
| skipInstall | java.lang.String | true | Records 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 in the argument exist. Installation Manager does not create directories for response files. | |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
| useServiceRepository | java.lang.String | true | Use this option with the listAvailablePackages and listAvailableFixes commands to search repositories for a specified package |
Back to Top
Installation Manager is a 32-bit application hence it requires 32-bit versions of OS system libraries in order to run. There are currently no plans to convert Installation Manager into a 64-bit application. See Installation Manager support for x86 64-bit Linux The work around for this is to enable 32-bit support for the 64-bit Linux OS. In Ubuntu this can be done by executing the following command as root:
sudo apt-get install ia32-libs
Uninstall IBM Installation Manager
| Class Name | com.midvision.rapiddeploy.orchestration.tasks.binary.installers.IbmInstallationManagerUnInstallTask |
| Category | IBM Installation Manager |
Uninstall IBM Installation Manager Task
Description
This task will uninstall IBM Installation Manager from the target server.Installation Manager is a 32-bit application hence it requires 32-bit versions of OS system libraries in order to run. There are currently no plans to convert Installation Manager into a 64-bit application. See Installation Manager support for x86 64-bit Linux The work around for this is to enable 32-bit support for the 64-bit Linux OS. In Ubuntu this can be done by executing the following command as root:
sudo apt-get install ia32-libs
Usage
For a full list of command options please look at the IBM Info Center website: IBM Installation ManagerParameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| dataLocation | java.lang.String | false | Specifies the directory location for the Installation Manager data directory. This location stores information about installed packages. Set this location when installing Installation Manager. The directory location must not be a subdirectory of the Installation Manager installation directory. If you specify a directory location for dataLocation that is not the default value, the specified location must be used each time you use Installation Manager or the Installation Manager installer. For the Installation Manager installer, each time you start the installer, you must specify the same directory location using the dataLocation option. The installed instance of Installation Manager uses the specified location automatically. | |
| failOnError | java.lang.Boolean | false | false | This task will not fail the deployment on error if set to false. This scope is parameter only. |
| installPath | java.lang.String | true | Used to check the dataLocation is not a sub-directory of the install path. | |
| logPath | java.lang.String | true | Specifies 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 when recording a response file. | |
| nl | java.util.List | true | When you include the nl option and a language code with a command, the behavior of the command line adjusts according to the settings for the specified language. 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) | |
| passwordKey | java.lang.String | true | Uses passwordKey to encrypt or decrypt passwords. | |
| properties | java.lang.String | true | Properties define the package group profile properties, such as languages. You can include a list of properties by separating each with a comma or a list of values by separating each with two commas. | |
| responseFile | java.lang.String | true | Generates a response file from actions in the Installation Manger UI, command line, or console mode, and specifies the location of the response file. | |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |