WebSphere Deployer Plugin

Skip to end of metadata
Go to start of metadata

Plugin Information

Plugin ID websphere-deployer Changes In Latest Release
Since Latest Release
Latest Release
Latest Release Date
Required Core
1.3.4 (archives)
Aug 15, 2015
Source Code
Issue Tracking
Pull Requests
Open Issues
Pull Requests
Greg Peters (id: n/a)
Valerio Ponte (id: n/a)
Usage Installations 2014-Nov 364
2014-Dec 371
2015-Jan 382
2015-Feb 404
2015-Mar 441
2015-Apr 462
2015-May 491
2015-Jun 532
2015-Jul 548
2015-Aug 572
2015-Sep 608
2015-Oct 615

This is a collection of two separate plugins that provide deployment functionality to most versions of IBM WebSphere Application Server, IBM WebSphere Portal and IBM WebSphere Liberty Profile.

Current Beta Release

websphere-deployer-v1.4.0.hpi (beta)

Please add comments if your issues are addressed on your version of WebSphere, note the fixes proposed in the Change Log below.

Plugin Features

  • Deployment to a running remote or local instance of WebSphere 6.0.x - 8.5.x
  • Deployment to a running remote or local instance of WebSphere Liberty Edition 8.x.x
  • Support for deployments when SSL is activated on WebSphere (Global Security)
  • Support for most versions of WebSphere (Portal,Liberty,ND,Extreme Scale, Express, Standard, etc...)
  • Support for updating JSR286/JSR186 Portlets
  • Support for deploying to different WebSphere instances/types per build
  • Support for node, cell, and server level deployments
  • Support for pre-compiling JSPs on WebSphere during deployment (When stress testing as part of build process)
  • Support for disabling JSP reloading (When stress testing as part of build process)
  • Support for not starting application after deployment
  • Support for updating an existing application (to prevent losing application settings after redeployment)
  • Supports fully stopping, uninstalling, installing and starting an application during deployment process
  • Smart detection of existing deployed application state (to prevent failures when a system admin stops your application without you knowing)

Configuration Steps

Deploying portlets to IBM WebSphere Portal (Email me directly)
Deploying to IBM WebSphere Application Server
Deploying to IBM WebSphere Liberty Server

You will most likely run out of PermGen space if you're using the default JVM values on your application server/servlet container that's hosting Jenkins (Please update your JVM memory requirements).

  • NOTE: Make sure the application server/servlet container is not running Jenkins as 'root' user. This can cause file permissions issues with maven or other tools and prevent deployable artifacts from making it to the final build location. You can try, but it may not work correctly.

Required Libraries For Deployments To IBM WebSphere Application Server

Jar File Source Location Destination Required
$WAS_INSTALL_ROOT/runtimes $USER_HOME/.jenkins/plugins/websphere-deployer/WEB-INF/lib

com.ibm.ws.orb_*.jar (if not IBM JRE) $WAS_INSTALL_ROOT/runtimes $USER_HOME/.jenkins/plugins/websphere-deployer/WEB-INF/lib Yes (otherwise 'No' if running under IBM J9 JRE)

Required Libraries For Deployments To IBM WebSphere Liberty Profile

Jar File Source Location Destination Required
com.ibm.websphere.appserver.api.basics_*.jar $LIBERTY_INSTALL_ROOT/dev/api/ibm $USER_HOME/.jenkins/plugins/websphere-deployer/WEB-INF/lib Yes
com.ibm.websphere.appserver.api.endpoint_*.jar $LIBERTY_INSTALL_ROOT/dev/api/ibm $USER_HOME/.jenkins/plugins/websphere-deployer/WEB-INF/lib Yes
com.ibm.websphere.appserver.api.restConnector_*.jar $LIBERTY_INSTALL_ROOT/dev/api/ibm $USER_HOME/.jenkins/plugins/websphere-deployer/WEB-INF/lib
restConnector.jar $LIBERTY_INSTALL_ROOT/clients $USER_HOME/.jenkins/plugins/websphere-deployer/WEB-INF/lib


1) Why can't I deploy from a Jenkins Slave?

    Only deployments from a Jenkins Master are supported at this time.

2) Why does my test connection connect successfully but my install/upload fails?

    The connection simply uses IBM standard APIs to connect via JMX over the specified SOAP port, when deploying an artifact, the artifacts are uploaded using the WebSphere Administration Console via an HTTP/S connection. This upload is performed by the IBM APIs behind the scenes.

    a). Make sure you can ping the administration console via IP address, long DNS & short DNS within your domain (Reference: http://www-01.ibm.com/support/docview.wss?uid=swg21450962)
    b). Make sure the certificate used by the WebSphere Administration Console(i.e. https://<websphere:9043/ibm/console) is trusted by the server that Jenkins is running under
    c). Make sure you can telnet to the the WebSphere Administration Console port (typically 9043). This is the port used for uploading artifacts to WebSphere

Issues or Feature Requests


  • Add rollback support for install/update failures to prevent breaking applications for QA/UAT teams
  • Add promotion support for other environments (QA,STAGE,PRE-PROD, etc.) without repackaging EAR/WAR
  • Add support for multiple target deployments
  • Add support for Jenkins slaves
  • Fix path issue when locating artifacts to deploy
  • Provide support for Liberty Profile (support confirmed, will be available soon)
  • Provide support for EAR/WAR/WAB/OSGI deployments to Liberty Profile (support confirmed, will be available soon)
  • Remove external dependency on client jars for each configuration (to simplify initial configuration) (not possible)
  • Send notifications when application fails to start (outside of build process)
  • Add cluster support (release v1.3)
  • Support for WAR deployments on WebSphere Application Servers (Full Profile)

Change Log

Version 1.4.0 (beta) - WAS Full Profile Updates

Added reloading support
Fixed JSP reloading issue
Fixed classloader order bug
Added classloader policy suppoort
Added context override for generated EARs
Added support for multiple target deployments (cluster or multiple nodes)
Changed UI layout

Version 1.3.4 (release) - WAS Full Profile Updates

Several bug fixes and enhancements (see details below)
Added "operations" to allow for either updating or complete re-installation of artifacts
Added support for path variables (contribution)
Tested support for updating Portlets on a remote WebSphere Portal Instance

Version 1.3.3 (beta) - WAS Full Profile Updates

Disabled host verification for complex deployment environments.
Provided option for verbose logging.

Version 1.3.2 (beta) - WAS Full Profile Updates

Added more connector options.
Fixed SSL caching so multiple deployments to different servers should work.

Version 1.3.1 (beta) - WAS Full Profile Updates

Added support for updating applications instead of complete reinstallation of artifacts.

Version 1.3 (beta) - WAS Full Profile Updates

Fix for generated EARs
Java EE7 support
Timeout parameter for large EAR deployments (contribution)
Classloader policy support
Context fix for generated EAR (contribution)
WebSphere ND support when deploying through Deployment Manager
Cluster support (experimental)

Version 1.2 - Liberty / WAS Full Profile Updates

Support for WebSphere Liberty Profile
Fixed path issues with WebSphere Application Server (full profile)

Version 1.1

Initial release performed

Version 1.0

Beta Testing Passed for WebSphere v8.5.5 for both remote and local deployments


plugin-post-build plugin-post-build Delete
plugin-notifier plugin-notifier Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Add Comment