WebSphere plugin

57 minute readExtensibilityDeveloper productivity

Use this plugin to interact with an IBM WebSphere Server.

  • Start and stop the server.

  • Manage applications within the server (start, deploy, undeploy, stop or custom task) using the provided WebSphere scripts in the bin directory under the installation home directory (wsadmin, startServer, stopServer).

  • Run Jython scripts that are provided by the user or defined when a procedure is created.

Plugin version 2.9.1.2022041311 Revised on April 16, 2022

Integrated Version

The plugin was tested on following WebSphere versions:

  • WAS and WASND 9.0 on Linux and Windows

  • WAS and WASND 8.5.5 on Linux and Windows

  • WAS and WASND 8.5.0 on Linux and Windows

  • WAS and WASND 8.0 on Linux and Windows

  • WAS 7.0 on Linux and Windows. Beginning Release 2.4 we do not certify this plugin on the 7.0 version of WAS considering that this version is not actively supported by IBM since April 2018. Please refer to this IBM Link

Plugin Configurations

Plugin configurations are sets of parameters that apply across some or all of the plugin procedures. They reduce repetition of common values, create predefined parameter sets for end users, and securely store credentials where needed. Each configuration is given a unique name that is entered in designated parameters on procedures that use them.

Creating Plugin Configurations

To create plugin configurations in CloudBees CD, do these steps:

  • Go to Administration >Plugins to open the Plugin Manager.

  • Find the EC-WebSphere-2.9.1.2022041311 row.

  • Click Configure to open the Configurations page.

  • Click Create Configuration as per the description of parameters below.

Note: After you perform the setup below it is important to make sure that the CloudBees CD agent machine on which WebSphere runs is registered as a resource that can be pinged.

Plugin configurations are sets of parameters that apply across some or all of the plugin procedures. They reduce repetition of common values, create predefined parameter sets for end users, and securely store credentials where needed. Each configuration is given a unique name that is entered in designated parameters on procedures that use them.

Configuration Procedure Parameters

Parameter Description

Configuration Name

Identifier of the configuration to create. i.e: myconfig

WSAdmin Absolute Path

Absolute path to wsadmin script.

Connection Type

Specifies type of connection to use to connect to the application server that you want to administer.

WebSphere Host

Hostname of the WebSphere Application Server to administer using wsadmin tool. For example: 10.200.1.234 or yourWSServer.

WebSphere Connector Port

Port of WebSphere Application server to which wsadmin should connect.Give the port number based on the type of connection you choose.For example, if you want to connect to application server using SOAP connection give the port number of SOAP connector of that server.

Login as

Credentials used to connect to WebSphere instance.

Test Connection?

Check if connection should be established during config creation to validate credentials.

Test Connection Resource

A resource which is used for the testing connection.

Debug Level

Debug level, higher debug level - more debug messages. Warning: on debug level 10 and more passwords will be revealed in a procedure logs.

Plugin Procedures

CreateEndToEndMailProvider

Creates a mail provider along with protocol provider and mail session.

This procedure creates mail provider with a protocol provider, a mail session and a custom property in the specified scope.

CreateEndToEndMailProvider Parameters

Parameter Description

Configuration Name

Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

Wsadmin Absolute Path

Path to wsadmin. If the location of wsadmin is in the PATH environment variable, then just the script name can be specified omitting its full path. E.g. '/path/to/wsadmin.sh' or 'wsadmin.bat'.

Scope

Specifies the scope in which the mail provider supports installed mail applications.For example, 'Cell=Cell01,Node=Node01,Server=server1' or 'Cell=Cell01,ServerCluster=testCluster'

Mail Provider Name

Specifies the name to be given to the new mail provider .

Mail Provider Description

Specifies the mail provider description.

Isolate this mail provider?

Specifies that this mail provider will be loaded in its own class loader. This allows the application server to load different versions or implementations of the same mail provider in the same Java Virtual Machine. Give each version or implementation of the mail provider a unique class path in following (Mail provider classpath) field that is appropriate for that version or implementation.

Mail Provider Classpath

Specifies the class path to a Java archive (JAR) file that contains the implementation classes for this mail provider.

Custom Property Name

Specifies the name of custom property to create.

Custom Property Value

Specifies the value to associate with this custom property of the resource.

Protocol Provider Name

Specifies the name to be given to the new protocol provider .

Protocol Provider Class Name

Specifies the implementation class of this protocol provider.

Protocol Provider Type

Specifies the type of protocol provider. Valid options are STORE(for incoming protocol provider) or TRANSPORT(for outgoing protocol provider).

Mail Session Name

Specifies the administrative name of the JavaMail session object.

Mail Session JNDI Name

Specifies the Java Naming and Directory Interface (JNDI) name for the resource, including any naming subcontexts.

Category

Optional string to use while classifying or grouping the resources.

Enable Debug Mode?

Select to print the interaction between mail application and mail server as well as the properties of this mail session to System.Out.log file.

Mail Session Description

Specifies optional description for mail session.

Incoming Mail Server

Specifies the host name server that is accessed when receiving mail.

Incoming Mail Server Port

Specifies the port of the server that is accessed when receiving mail.

Incoming Mail Server Credentials

Specifies the credential for the mail account when the incoming mail server requires authentication.

Outgoing Mail Server

Specifies the host name of server that is accessed when sending mail.

Outgoing Mail Server Port

Specifies the port of the server that is accessed when sending mail.

Outgoing Mail Server Credential

Specifies the user of the mail account when the outgoing mail server requires authentication.

Enable Strict Internet Address Parsing?

Specifies whether the recipient addresses must be parsed in strict compliance with RFC 822.

CreateEndToEndMailProvider

To create a new mail provider along with protocol provider and mail session, do these steps:

  • Go to the CreateEndToEndMailProvider procedure.

  • Enter the following parameters:

After the job runs, you can view the results, including the following job details, which show that OSGi application is deployed successfully:

In the CreateEndToEndMailProvider step, click the Log icon to see the diagnostic information. The output is similar to the following diagnostic report.

CreateMailSession

Creates a new JavaMail session using the wsadmin tool.

This procedure creates a JavaMail session object for default mail provider at specified scope.

CreateMailSession Parameters

Parameter Description

Configuration Name

Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

Wsadmin Absolute Path

Path to wsadmin. If the location of wsadmin is in the PATH environment variable, then just the script name can be specified omitting its full path. E.g. '/path/to/wsadmin.sh' or 'wsadmin.bat'.

Scope

Specifies the scope in which the mail session supports installed mail applications.For example, 'Cell=Cell01,Node=Node01,Server=server1' or 'Cell=Cell01,ServerCluster=testCluster'

Mail Session Name

Specifies the administrative name of the JavaMail session object.

Mail Session Description

Specifies optional description for mail session.

Mail Session JNDI Name

Specifies the Java Naming and Directory Interface (JNDI) name for the resource, including any naming subcontexts.

Category

Optional string to use while classifying or grouping the resources.

Enable Debug Mode?

Select to print the interaction between mail application and mail server as well as the properties of this mail session to System.Out.log file.

Outgoing Mail Server

Specifies the host name of server that is accessed when sending mail.

Outgoing Mail Server Port

Specifies the port of the server that is accessed when sending mail.

Outgoing Mail Server Protocol

Specifies the protocol to use when sending mail.

Outgoing Mail Server Credential

Specifies the user of the mail account when the outgoing mail server requires authentication.

Return E-mail Address

Represents the Internet email address that, by default, displays in the received message in the From or the Reply-To address. The recipient’s reply will come to this address.

Incoming Mail Server

Specifies the host name server that is accessed when receiving mail.

Incoming Mail Server Port

Specifies the port of the server that is accessed when receiving mail.

Incoming Mail Server Protocol

Specifies the protocol to use when receiving mail.

Incoming Mail Server Credentials

Specifies the credential for the mail account when the incoming mail server requires authentication.

Enable Strict Internet Address Parsing?

Specifies whether the recipient addresses must be parsed in strict compliance with RFC 822.

Create Mail Session

To create a mail session for default mail provider, do these steps:

  • Go to the CreateMailSession procedure.

  • Enter the following parameters:

After the job runs, you can view the results, including the following job details, which show that mail session is created successfully:

In the CreateMailSession step, click the Log icon to see the diagnostic information. The output is similar to the following diagnostic report.

PublishWSDL

Publishes WSDL files in each web services-enabled module to the file system location

This procedure publishes WSDL files in each web services-enabled module to the file system location.

PublishWSDL Parameters

Parameter Description

Configuration Name

Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

Wsadmin Absolute Path

Path to wsadmin. If the location of wsadmin is in the PATH environment variable, then just the script name can be specified omitting its full path. E.g. '/path/to/wsadmin.sh' or 'wsadmin.bat'.

Application Name

Name of the application of which to publish the WSDL file. i.e: 'webapp'.

Location to publish WSDL file

Filename and absolute path on the filesystem where published WSDL files should get stored.For example, 'C:/webservices/sampleWSDL.zip'

Commands

Commands to be entered to wsadmin. Use one command per line.

Java Parameters

Java options to be passed to wsadmin, separate them using semicolons (;).

Classpath

Jars to be passed to the wsadmin classpath. It is a string containing paths (semicolon-separated) the required JARs to execute wsadmin in a particular job. i.e: 'c:/MyDir/Myjar.jar;d:/yourdir/yourdir.jar' or '/MyDir/Myjar.jar;/yourdir/yourdir.jar'.

SOAP address prefixes

Give SOAP address prefix in format "{{module {{binding partial-url}}}}" to customize the WSDL SOAP address for each module. For example, '{ {AddressBookJ2WB.war {{http http://localhost:9080}}} {StockQuote.jar {{http https://localhost:9443}}} }'.

Additional Commands

Additional commands to be entered for wsadmin.

Publish WSDL

To publish WSDL files, do these steps:

  • Go to the PublishWSDL procedure.

  • Enter the following parameters:

CreateApplicationServer

(Applicable only for WebSphere Network Deployment installation.)

This procedure creates an Application Server identical to an existing Application Server or an Application Server definition which is part of a template. In addition it will synchronize nodes if checked.

CreateApplicationServer Parameters

Parameter Description

Configuration Name

Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

Node Name

Name of the node where application server is to be created.

Server Name

Name of application server to be created.

Generate Unique Ports?

By default ports generated during server creation will be created uniquely. If not checked ports in template will be used as is for server creation.

Source Type

Type of source which should be used for server creation. Select Template or Application Server. In case of template, application server template will be used for server creation, in case of Application Server, template will be created from existing application server and new server will be created from this template then. After successful creation template will be deleted.

Source Template Name

This parameter is applicable only when the source is a Template. Name of server template to be the source for a new server.

Source Template Location

The configuration Id that represents the location of a template. This parameter is applicable only when the source is a Template.

Source Server Name

Name of application server to be the source for a new server in format nodename:servername.

Sync Nodes?

The syncNode command forces a configuration synchronization to occur between the node and the deployment manager for the cell in which the node is configured.

Create Application Server

To Create Application Server in CloudBees CD interface, do these steps:

  • Create Pipeline.

  • Create task.

  • In task definition choose Plugin and choose following parameters:

  • Click on arrow.

  • Enter the following parameters:

After the pipeline runs, you can view the results, including the following step details:

In the CreateApplicationServer step, click the Log icon to see the diagnostic information. The output is similar to the following diagnostic report.

DeleteApplicationServer

(Applicable only for WebSphere Network Deployment installation.)

This procedure deletes an existing Application Server. In addition it will synchronize nodes if checked.

DeleteApplicationServer Parameters

Parameter Description

Configuration Name

Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

Node Name

Name of the node where application server to be deleted.

Server Name

Name of application server to be deleted.

Sync Nodes?

The syncNode command forces a configuration synchronization to occur between the node and the deployment manager for the cell in which the node is configured.

Delete Application Server

To Delete Application Server in CloudBees CD interface, do these steps:

  • Create Pipeline.

  • Create task.

  • In task definition choose Plugin and choose following parameters:

  • Click on arrow.

  • Enter the following parameters:

After the pipeline runs, you can view the results, including the following step details:

In the DeleteApplicationServer step, click the Log icon to see the diagnostic information. The output is similar to the following diagnostic report.

CreateApplicationServerTemplate

(Applicable only for WebSphere Network Deployment installation.)

This procedure creates a template of an existing Application Server.

CreateApplicationServerTemplate Parameters

Parameter Description

Configuration Name

Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

Node Name

Name of the node where application server is located.

Application Server Name

Name of the application server the template will be based out of.

Template Name

Application server template name to be created.

Template Location

Specifies a configuration Id that represents the location to place the template.

Template Description

Description of application server template.

Sync Nodes?

The syncNode command forces a configuration synchronization to occur between the node and the deployment manager for the cell in which the node is configured.

Create Application Server Template

To Create Application Server Template in CloudBees CD interface, do these steps:

  • Create Pipeline.

  • Create task.

  • In task definition choose Plugin and choose following parameters:

  • Click on arrow.

  • Enter the following parameters:

After the pipeline runs, you can view the results, including the following step details:

In the CreateApplicationServerTemplate step, click the Log icon to see the diagnostic information. The output is similar to the following diagnostic report.

DeleteApplicationServerTemplate

(Applicable only for WebSphere Network Deployment installation.)

This procedure deletes an existing Application Server Template.

DeleteApplicationServerTemplate Parameters

Parameter Description

Configuration Name

Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

Template Name

Application server template name to be deleted.

Sync Nodes?

The syncNode command forces a configuration synchronization to occur between the node and the deployment manager for the cell in which the node is configured.

Delete Application Server Template

To Delete Application Server Template in CloudBees CD interface, do these steps:

  • Create Pipeline.

  • Create task.

  • In task definition choose Plugin and choose following parameters:

  • Click on arrow.

  • Enter the following parameters:

After the pipeline runs, you can view the results, including the following step details:

In the DeleteApplicationServerTemplate step, click the Log icon to see the diagnostic information. The output is similar to the following diagnostic report.

CreateCluster

(Applicable only for WebSphere Network Deployment installation.)

Creates a new Application Server cluster.

This procedure creates a cluster, adds members to it, and can deploy an application in it using a Jython script.

CreateCluster Parameters

Parameter Description

Configuration Name

Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

Cluster Name

Name of the new cluster.

Prefer Local?

Specifies whether enterprise bean requests are routed to the node on which the client resides whenever such a routing is possible.

Create First Cluster Member?

If not checked, empty cluster will be created

First Cluster Member Creation Policy

Controls how 1st cluster member is to be created Existing - use existing server as template Convert - convert existing server to 1st cluster member Template - use app server template to create 1st cluster member

Source Template Name

Name of server template to be the source for first cluster member.

Source Server Name

Name of application server to be the source for a new server in format nodename:servername.

First Cluster Member Node

Node name where first cluster member will be created.

First Cluster Member Name

Name of the server that will be created as a first cluster member.

First Cluster Member Weight

Weight of first cluster member.

Generate Unique Ports for First Cluster Member?

<