Add and remove Liberty addons and features using Installation Manager

We can use Installation Manager to add or remove addons and features in an existing installation. We can change both the optional embeddable EJB container and JPA client feature and Liberty addons and features.

Make sure the 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 modifying the installation, we can choose to access the IBM WebSphere Liberty Repository to install addons and features. Access to the IBM WebSphere Liberty Repository requires internet access. If the system does not have internet access or we 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. See Install assets using Installation Manager.

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.

Add or remove addons and features using the GUI

Stop all servers and applications on the WebSphere Application Server Liberty installation being modified.
Start Installation Manager.
Click Modify.
Select the package group to modify.
Click Next.
Note: If prompted to authenticate, use the IBM ID and password that you registered with on the program website.
Expand the IBM WebSphere Application Server Liberty product installed.
Check the check box to install the embeddable EJB container and JPA client feature, or clear the check box to remove the feature it is already installed. Then click Next.
Choose whether to add or remove Liberty addons and features.
- To add addons or features:
  1. Select Add addons and features. We can optionally choose to connect to the online IBM WebSphere Liberty Repository. Click Next.
  2. Select addons to install, and click Next.
    Only addons that are not already installed are displayed.
  3. Select features to install, and click Next.
    Only features that are not already installed are displayed.
  4. Accept the terms of the license agreement, then click Next.
  5. Review the addon and feature summary information, and click Next.
- To remove addons or features:
  1. Select Remove addons and features, and click Next.
  2. Select addons to remove, and click Next.
  3. Select features to remove, and click Next.
    If a feature depends on other features we want to uninstall, we must also uninstall the feature that has the dependency.
  4. Review the addon and feature summary information, and click Next.
Review the summary information, and click Modify.
Note: Only the addition or removal of the embeddable EJB container and JPA client feature is displayed.
- If the modification is successful, the program displays a message that indicates that installation is successful.
- If the modification is not successful, click View Log File to troubleshoot the problem.
Click Finish.
Click File > Exit to close Installation Manager.

Add or remove features from the command line

The offering name 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.

Adding and removing assets modifying an existing Liberty installation differs from initially installing 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 the installed Liberty addons and features remain installed unless we specifically remove them.

Note: We 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. See Install assets using Installation Manager. To install assets from the IBM WebSphere Liberty Repository, we must have access to the internet. To enable access to the Liberty Repository, on the -properties parameter, set the user.useLibertyRepository option to true. The Liberty Repository is the last of the repositories that are accessed during installation.

We can use installUtility find to list the short names of assets we can install.

Add the embeddablecontainer 0iInstallation Manager feature, the ndMemberBundle Liberty addon, and the mphealth-4.0 and mpMetrics-4.0 Liberty features. The mphealth-4.0, mpMetrics-4.0, and ndMemberBundle are specified using the short names.

imcl.sh modify com.ibm.websphere.liberty.ND
  -addFeatures embeddablecontainer
  -properties user.addAssets=ndMemberBundle,,com.ibm.websphere.appserver.mphealth-4.0,,mpMetrics-4.0
  -repositories http://www.ibm.com/software/repositorymanager/com.ibm.websphere.liberty.ND
  -installationDirectory "/IBM/WebSphere/Liberty"
  -secureStorageFile /credential.store -masterPasswordFile /password_file.txt
  -acceptLicense

Remove the embeddablecontainer Installation Manager feature, the ndMemberBundle Liberty addon, and the mphealth-4.0 and mpMetrics-4.0 Liberty features.

imcl.sh modify com.ibm.websphere.liberty.ND
  -removeFeatures embeddablecontainer
  -properties user.removeAssets=ndMemberBundle,,com.ibm.websphere.appserver.mphealth-4.0,,mpMetrics-4.0
  -installationDirectory "/IBM/WebSphere/Liberty"
  -secureStorageFile /credential.store -masterPasswordFile /password_file.txt

Add or remove features using a response file

The offering name of the Embeddable EJB container and JPA client feature is embeddablecontainer. To add this feature, specify the embeddablecontainer feature on the features attribute of the Liberty offering. If the feature is already installed and is not specified, it is removed. 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 we add features, we must also accept the user license.

<data key='user.addAssets' value='ndMemberBundle,,com.ibm.websphere.appserver.mphealth-4.0,,mpMetrics-4.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.mphealth-4.0,,mpMetrics-4.0'/>

By default, all of the installed Liberty addons and features remain installed unless we specifically remove them.

Windows: The following sample response file modifies an installation to add the embeddablecontainer Installation Manager feature, the ndMemberBundle Liberty addon, and the mphealth-4.0 and mpMetrics-4.0 Liberty features. The mphealth-4.0 feature is specified using the symbolic name, and ndMemberBundle and mpMetrics-4.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.ND'/>
</server>
<install modify='true'>
<offering id='com.ibm.websphere.liberty.ND' 
  profile='WebSphere Liberty' 
  features='embeddablecontainer'/>
</install>
<profile id='WebSphere Liberty' 
  installLocation='/IBM/WebSphere/Liberty'>
<data key='user.addAssets' value='ndMemberBundle,,com.ibm.websphere.appserver.mphealth-4.0,,mpMetrics-4.0'/>
<data key='user.accept.license' value='true'/>
</profile>
</agent-input>

Parent topic: Install and uninstall Liberty on distributed operating systems