Adding and removing Liberty addons and features on IBM i
You can use Installation Manager to add or remove addons and features in an existing installation. You can change both the optional embeddable EJB container feature and Liberty addons and features.
Before you begin
Make sure that your Installation Manager preferences are pointing to the appropriate web-based or local repositories that contain WebSphere® Application Server Liberty and any Liberty addons or features.
When you modify your installation, you can choose to access the Liberty Repository to install addons and features. Access to the Liberty Repository requires internet access. If your system does not have internet access or you want to install customized Liberty assets, set up an instance of the Liberty Asset Repository Service or a local directory-based repository, and then add the repository URL, directory path, or archive path in Installation Manager. For more information about the Liberty repositories, see Installing assets using Installation Manager.
Procedure
Choose one of the following options to modify your Liberty installation.
-
Add or remove features from the command line.
-
If the repository requires a username and password, create a credential-storage file to access
this repository.
Tip: When creating a credential-storage file, append /repository.config at the end of the repository URL location if the imutilsc command is unable to find the URL that is specified.
- Sign on to the IBM i system with a user profile that has *ALLOBJ and *SECADM special authorities.
- On a CL command line, run the STRQSH command to start the Qshell command shell.
- Change to the eclipse/tools subdirectory in the directory where you installed Installation Manager.
-
Run the
imcl modify
command.The feature ID of the Embeddable EJB container and JPA client feature is
embeddablecontainer
. The optional embeddablecontainer feature is added by specifying the -addFeatures option and removed by specifying the -removeFeatures option.Note: A removal notice was issued for the embeddable EJB container and JPA client feature as of the 16.0.0.2 fix pack, so the feature is eligible for future removal. For more information, see Removal notices.Adding and removing assets when you modify an existing Liberty installation differs from when you initially install the product. To add Liberty addons or features, specify the symbolic or short names on the user.addAssets property and specify the -acceptLicense parameter. To remove addons or features, specify the symbolic or short names on the user.removeAssets property, separated by double commas.
By default, all of your installed Liberty addons and features remain installed unless you specifically remove them.
Note: You can install assets from instances of the Liberty Asset Repository Service or local directory-based repositories with or without internet access. Add the repository URL, directory path, or archive file path on the -repositories parameter. These repositories are accessed in the order that they are specified. For more information about these asset repositories, see Installing assets using Installation Manager. To install assets from the IBM WebSphere Liberty Repository, you must have access to the internet. To enable access to the Liberty Repository, on the -properties parameter, set the user.useLibertyRepository option totrue
. The Liberty Repository is the last of the repositories that are accessed during installation.Tip: From your Liberty installation, use theinstallUtility find
action to list the short names of assets that you can install.The following example command adds theembeddablecontainer
Installation Manager feature, thendMemberBundle
Liberty addon, and theportlet-2.0
andportletserving-2.0
Liberty features. Theportlet-2.0
feature is specified using the symbolic name, andndMemberBundle
andportletserving-2.0
are specified using the short names../imcl modify com.ibm.websphere.liberty.CORE.ND -addFeatures embeddablecontainer -properties user.addAssets=ndMemberBundle,,com.ibm.websphere.appserver.portlet-2.0,,portletserving-2.0 -repositories http://www.ibm.com/software/repositorymanager/com.ibm.websphere.liberty.CORE.ND -installationDirectory /QIBM/ProdData/WebSphere/Liberty/LibertyCore -secureStorageFile $HOME/WASFiles/temp/credential.store -masterPasswordFile $HOME/WASFiles/password_file.txt -acceptLicense
The following example command removes theembeddablecontainer
Installation Manager feature, thendMemberBundle
Liberty addon, and theportlet-2.0
andportletserving-2.0
Liberty features../imcl modify com.ibm.websphere.liberty -removeFeatures embeddablecontainer -properties user.removeAssets=ndMemberBundle,,com.ibm.websphere.appserver.portlet-2.0,,portletserving-2.0 -installationDirectory /QIBM/ProdData/WebSphere/Liberty/LibertyCore -secureStorageFile $HOME/WASFiles/temp/credential.store -masterPasswordFile $HOME/WASFiles/password_file.txt
-
If the repository requires a username and password, create a credential-storage file to access
this repository.
-
Add or remove features by using a response file.
-
If the repository requires a username and password, create a credential-storage file to access
this repository.
Tip: When creating a credential-storage file, append /repository.config at the end of the repository URL location if the imutilsc command is unable to find the URL that is specified.
- Sign on to the IBM i system with a user profile that has *ALLOBJ and *SECADM special authorities.
- On a CL command line, run the STRQSH command to start the Qshell command shell.
- Change to the eclipse/tools subdirectory in the directory where you installed Installation Manager.
-
Run the
imcl input
command to input the response file../imcl input $HOME/WASFiles/temp/modify_response_file.xml -log $HOME/WASFiles/temp/modify_log.xml -secureStorageFile $HOME/WASFiles/temp/credential.store -masterPasswordFile $HOME/WASFiles/password_file.txt
The feature ID of the Embeddable EJB container and JPA client feature is
embeddablecontainer
. To add this feature, specify the embeddablecontainer feature on thefeatures
attribute of the Liberty offering. If the feature is already installed and is not specified, it is removed.Note: A removal notice was issued for the embeddable EJB container and JPA client feature as of the 16.0.0.2 fix pack, so the feature is eligible for future removal. For more information, see Removal notices.Adding and removing Liberty assets when you modify an existing Liberty installation differs from when you initially install the product. To add Liberty addons or features, specify the symbolic or short names on the user.addAssets property, separated by double commas. When you add features, you must also accept the user license.<data key='user.addAssets' value='ndMemberBundle,,com.ibm.websphere.appserver.portlet-2.0,,portletserving-2.0'/> <data key='user.accept.license' value='true'/>
To remove addons or features, specify the symbolic or short names on the user.removeAssets property.<data key='user.removeAssets' value='ndMemberBundle,,com.ibm.websphere.appserver.portlet-2.0,,portletserving-2.0'/>
By default, all of your installed Liberty addons and features remain installed unless you specifically remove them.
The following sample response file modifies an installation to add theembeddablecontainer
Installation Manager feature, thendMemberBundle
Liberty addon, and theportlet-2.0
andportletserving-2.0
Liberty features. Theportlet-2.0
feature is specified using the symbolic name, andndMemberBundle
andportletserving-2.0
are specified using the short names.<?xml version="1.0" encoding="UTF-8"?> <agent-input clean='true' temporary='true'> <server> <repository location='http://www.ibm.com/software/repositorymanager/com.ibm.websphere.liberty.CORE.ND'/> </server> <install modify='true'> <offering id='com.ibm.websphere.liberty.CORE.ND' profile='WebSphere Liberty' features='embeddablecontainer'/> </install> <profile id='WebSphere Liberty' installLocation='/QIBM/ProdData/WebSphere/Liberty/LibertyCore'> <data key='was.install.os400.profile.location' value='/QIBM/UserData/WebSphere/Liberty/LibertyCore'/> </profile> <data key='user.addAssets' value='ndMemberBundle,,com.ibm.websphere.appserver.portlet-2.0,,portletserving-2.0'/> <data key='user.accept.license' value='true'/> </profile> <preference name='com.ibm.cic.common.core.preferences.eclipseCache' value='/QIBM/UserData/InstallationManager/IMShared'/> </agent-input>
-
If the repository requires a username and password, create a credential-storage file to access
this repository.