diff --git a/build.gradle b/build.gradle index ea74028d..12639529 100644 --- a/build.gradle +++ b/build.gradle @@ -7,19 +7,19 @@ // All rights reserved buildscript { - repositories { - maven { url 'http://dl.bintray.com/ecpluginsdev/maven' } - - jcenter() - } - dependencies { - classpath group: 'com.electriccloud.plugins', name: 'flow-gradle-plugin', version: '1.+' - } + repositories { + maven { url 'http://dl.bintray.com/ecpluginsdev/maven' } + + jcenter() + } + dependencies { + classpath group: 'com.electriccloud.plugins', name: 'flow-gradle-plugin', version: '2.+' + } } group = 'com.electriccloud' description = 'Plugins : EC-WebSphere' -version = '2.6.0' +version = '2.6.1' apply plugin: 'flow-gradle-plugin' apply plugin: 'license' @@ -27,26 +27,26 @@ apply plugin: 'license' license { header = file ('shortHeader.txt') exclude "**/project.xml" -} +} dependencies { - testCompile 'junit:junit:[4,)' - testCompile 'org.mockito:mockito-core:1.9.5' + testCompile 'junit:junit:[4,)' + testCompile 'org.mockito:mockito-core:1.9.5' } test { - Properties props = new Properties() + Properties props = new Properties() - systemProperties['COMMANDER_SERVER'] = "$commanderServer" - systemProperties['PLUGIN_VERSION'] = version - //TODO: load properties for WebSphere + systemProperties['COMMANDER_SERVER'] = "$commanderServer" + systemProperties['PLUGIN_VERSION'] = version + //TODO: load properties for WebSphere - testLogging { - // Show that tests are run in the command-line output - events 'started', 'passed' - exceptionFormat = 'full' - } + testLogging { + // Show that tests are run in the command-line output + events 'started', 'passed' + exceptionFormat = 'full' + } } task wrapper(type: Wrapper) { gradleVersion = '2.14' } diff --git a/htdocs/images/icon-plugin.svg b/htdocs/images/icon-plugin.svg new file mode 100644 index 00000000..d5e53c8c --- /dev/null +++ b/htdocs/images/icon-plugin.svg @@ -0,0 +1,20 @@ + + + + + + + + + diff --git a/pages/EC-WebSphere_help.xml b/pages/EC-WebSphere_help.xml index 2c6bea9f..0dccbb19 100644 --- a/pages/EC-WebSphere_help.xml +++ b/pages/EC-WebSphere_help.xml @@ -13,20 +13,20 @@

@PLUGIN_KEY@

Plugin version @PLUGIN_VERSION@

- -

Revised on November 09, 2018

- + +

Revised on January 14, 2019

+

Contents

Overview

@@ -99,13 +99,13 @@ Beginning Release 2.4 we do not certify this plugin on the 7.0 version of WAS co Please refer to this IBM Link

- - - + + + - +

Plugin Configurations

@@ -129,7 +129,7 @@ Please refer to this
Plugin configurations are sets of parameters that apply across some or all of the plugin procedures. @@ -137,7 +137,7 @@ They reduce repetition of common values, create predefined parameter sets for en 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 Parameters @@ -147,63 +147,63 @@ Each configuration is given a unique name that is entered in designated paramete - + - + - + - + - + - + - + - +
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.
Debug Level Debug level.
- +
- +

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

@@ -213,130 +213,130 @@ Each configuration is given a unique name that is entered in designated paramete - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
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:

@@ -354,20 +354,20 @@ Each configuration is given a unique name that is entered in designated paramete

- +
- +

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

@@ -377,100 +377,100 @@ Each configuration is given a unique name that is entered in designated paramete - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
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:

@@ -488,20 +488,20 @@ Each configuration is given a unique name that is entered in designated paramete

- +
- +

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

@@ -511,55 +511,55 @@ Each configuration is given a unique name that is entered in designated paramete - + - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
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.. i.e: '{ {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:

@@ -569,22 +569,22 @@ Each configuration is given a unique name that is entered in designated paramete

- +
- +

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

@@ -594,22 +594,22 @@ Each configuration is given a unique name that is entered in designated paramete - + - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
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? @@ -617,7 +617,7 @@ Each configuration is given a unique name that is entered in designated paramete If not checked ports in template will be used as is for server creation.
Source Type @@ -627,7 +627,7 @@ Each configuration is given a unique name that is entered in designated paramete After successful creation template will be deleted.
Source Template Name @@ -635,7 +635,7 @@ Each configuration is given a unique name that is entered in designated paramete Name of server template to be the source for a new server.
Source Template Location @@ -643,24 +643,24 @@ Each configuration is given a unique name that is entered in designated paramete 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 Flow interface, do these steps:

@@ -679,22 +679,22 @@ Each configuration is given a unique name that is entered in designated paramete

- +
- +

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

@@ -704,32 +704,32 @@ Each configuration is given a unique name that is entered in designated paramete - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
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 Flow interface, do these steps:

@@ -748,22 +748,22 @@ Each configuration is given a unique name that is entered in designated paramete

- +
- +

CreateApplicationServerTemplate

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

This procedure creates a template of an existing Application Server.

- - + +

CreateApplicationServerTemplate Parameters

@@ -773,49 +773,49 @@ Each configuration is given a unique name that is entered in designated paramete - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
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 Flow interface, do these steps:

@@ -834,22 +834,22 @@ Each configuration is given a unique name that is entered in designated paramete

- +
- +

DeleteApplicationServerTemplate

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

This procedure deletes an existing Application Server Template.

- - + +

DeleteApplicationServerTemplate Parameters

@@ -859,27 +859,27 @@ Each configuration is given a unique name that is entered in designated paramete - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
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 Flow interface, do these steps:

@@ -898,25 +898,25 @@ Each configuration is given a unique name that is entered in designated paramete

- +
- +

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

@@ -926,28 +926,28 @@ Each configuration is given a unique name that is entered in designated paramete - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
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 @@ -957,36 +957,36 @@ Each configuration is given a unique name that is entered in designated paramete 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? @@ -994,7 +994,7 @@ Each configuration is given a unique name that is entered in designated paramete If not checked ports in template will be used as is for server creation.
Server Resources Promotion Policy @@ -1005,12 +1005,12 @@ Each configuration is given a unique name that is entered in designated paramete Default is Cluster.
Add Cluster Members? If checked, additional cluster members will be added right after cluster creation.
Gen Unique Ports for Cluster Members? @@ -1018,31 +1018,31 @@ Each configuration is given a unique name that is entered in designated paramete If not checked ports in template will be used as is for server creation.
Weight of Each Cluster Member Weight of each cluster member from list.
Cluster Members List List of cluster members to be created in format NodeName:server1, NodeName2:server2.
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 Cluster

To Create Cluster in Flow interface, do these steps:

@@ -1061,25 +1061,25 @@ Each configuration is given a unique name that is entered in designated paramete

- +
- +

DeleteCluster

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

Deletes an existing cluster using the wsadmin tool

- - + +

This procedure delete the specified cluster.

- +

DeleteCluster Parameters

@@ -1089,27 +1089,27 @@ Each configuration is given a unique name that is entered in designated paramete - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Cluster Name The name of the cluster to delete.
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 Cluster

To Delete Cluster in Flow interface, do these steps:

@@ -1128,22 +1128,22 @@ Each configuration is given a unique name that is entered in designated paramete

- +
- +

ExportApplicationServer

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

This procedure exports the definition of an Application Server in an environment to an archive (with extension .car) in the filesystem, that can in turn be used import into another environment and create an identical server.

- - + +

ExportApplicationServer Parameters

@@ -1153,30 +1153,30 @@ Each configuration is given a unique name that is entered in designated paramete - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Node Name Name of application server node.
Application Server Name Name of the application server to be exported.
Archive Specifies the fully qualified path of the exported configuration archive.
- +

Export Application Server

To Export Application Server in Flow interface, do these steps:

@@ -1195,22 +1195,22 @@ Each configuration is given a unique name that is entered in designated paramete

- +
- +

ImportApplicationServer

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

This procedure imports an Application Server from an Archive and creates an identical server in the environment the Archive is imported into.

- - + +

ImportApplicationServer Parameters

@@ -1220,27 +1220,27 @@ Each configuration is given a unique name that is entered in designated paramete - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Node Name Name of the Node in which the Application Server is to be Imported.
Application Server Name Name of the Application Server to be created based on the server in the Imported Archive.
Archive Specifies the fully qualified path of the configuration archive.
Node Name in Archive @@ -1249,7 +1249,7 @@ Each configuration is given a unique name that is entered in designated paramete If there are multiple nodes in the Archive, mention the node name of the Server to be imported.
Server Name in Archive @@ -1258,22 +1258,22 @@ Each configuration is given a unique name that is entered in designated paramete If there are multiple servers in the Archive, mention the name of the Server to be imported.
Core Group Specifies the core group name to which the server should belong.
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.
- +

Import Application Server

To Import Application Server in Flow interface, do these steps:

@@ -1292,25 +1292,25 @@ Each configuration is given a unique name that is entered in designated paramete

- +
- +

ListClusterMembers

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

Lists all the members of cluster using wsadmin tool.

- - + +

This procedure lists down all the members (application servers) of the cluster using a Jython script.

- +

ListClusterMembers Parameters

@@ -1320,25 +1320,25 @@ Each configuration is given a unique name that is entered in designated paramete - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Cluster Name Name of the cluster of which members to list down.
Output Property Path Property where cluster members list is to be stored.
- +

List Cluster Members

To List Cluster Members in Flow interface, do these steps:

@@ -1357,25 +1357,25 @@ Each configuration is given a unique name that is entered in designated paramete

- +
- +

RemoveClusterMembers

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

Removes list of application servers from existing cluster

- - + +

This procedure removes specified application servers from the cluster using a Jython script.

- +

RemoveClusterMembers Parameters

@@ -1385,17 +1385,17 @@ Each configuration is given a unique name that is entered in designated paramete - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Cluster Name Name of cluster from which to remove/delete the members.
List of Cluster Members @@ -1403,17 +1403,17 @@ Each configuration is given a unique name that is entered in designated paramete Important note: server will be not only removed from cluster, but also 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.
- +

Remove Cluster Members

To Remove Cluster Members in Flow interface, do these steps:

@@ -1432,28 +1432,28 @@ Each configuration is given a unique name that is entered in designated paramete

- +
- +

SyncNodes

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

Synchronizes active nodes.

- - + +

Synchronizes Cell's Deployment Manager config repository with nodes of the cell. By default, WebSphere nodes are configured for auto-sync. This procedure should be used for manual nodes synchronization. For example: New custom property for node was added, and configuration was saved. Next, to make it available on each server it should be propagated to all servers of the node by nodes synchronization.

- +

SyncNodes Parameters

@@ -1463,35 +1463,35 @@ Next, to make it available on each server it should be propagated to all servers - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Wsadmin 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'.
- +
- +

CreateFirstClusterMember

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

Creates the First Cluster Member of an existing cluster.

- - + +

CreateFirstClusterMember Parameters

@@ -1501,38 +1501,38 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Cluster Name Name of the new cluster.
First Cluster Member Name Server Name of first cluster member.
First Cluster Member Node Node Name of first cluster member.
First Cluster Member Weight Weight of first cluster member.
Generate Unique Ports for First Cluster Member? @@ -1540,7 +1540,7 @@ Next, to make it available on each server it should be propagated to all servers If this option is not checked, ports in template will be used as is.
Server Resources Promotion Policy @@ -1551,7 +1551,7 @@ Next, to make it available on each server it should be propagated to all servers Default is Cluster.
First Cluster Member Creation Policy @@ -1560,31 +1560,31 @@ Next, to make it available on each server it should be propagated to all servers Template - Use app server template to create first 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.
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 First Cluster Member

To Create First Cluster Member in Flow interface, do these steps:

@@ -1603,22 +1603,22 @@ Next, to make it available on each server it should be propagated to all servers

- +
- +

CreateClusterMembers

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

Creates members under an existing cluster.

- - + +

CreateClusterMembers Parameters

@@ -1628,42 +1628,42 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Cluster Name A name of the cluster where servers is to be created.
Gen Unique Ports? Generate unique ports number if checked.
Cluster Member Weight Weight of each cluster member
List of Cluster Members List of cluster members.
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 Cluster Members

To Create Cluster Members in Flow interface, do these steps:

@@ -1682,22 +1682,22 @@ Next, to make it available on each server it should be propagated to all servers

- +
- +

StartApplicationServers

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

This procedure starts one or more Application Servers that can be spread across nodes.

- - + +

StartApplicationServers Parameters

@@ -1707,28 +1707,28 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Server List - List of Servers to be started. Provide them in this format : NodeName:ServerName. For example, + List of Servers to be started. Provide them in this format : NodeName:ServerName. For example, Node1:Server1, Node2:Server2, Node3:Server3, or Node4:* to start all servers within Node4.
Wait time Not Required. Time to wait until all servers are started. If not specified wait time will be treated as 0.
- +

Start Application Servers

To Start Application Servers in Flow interface, do these steps:

@@ -1747,22 +1747,22 @@ Next, to make it available on each server it should be propagated to all servers

- +
- +

StopApplicationServers

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

This procedure stops one or more Application Servers that can be spread across nodes.

- - + +

StopApplicationServers Parameters

@@ -1772,28 +1772,28 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Server List - List of Servers to be stopped. Provide them in this format : NodeName:ServerName. For example, + List of Servers to be stopped. Provide them in this format : NodeName:ServerName. For example, Node1:Server1, Node2:Server2, Node3:Server3, or Node4:* to stop all servers within Node4.
Wait time Not Required. Time to wait until all servers are stopped. If not specified wait time will be treated as 0.
- +

Stop Application Servers

To Stop Application Servers in Flow interface, do these steps:

@@ -1812,25 +1812,25 @@ Next, to make it available on each server it should be propagated to all servers

- +
- +

StartCluster

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

Starts cluster using wsadmin tool.

- - + +

This procedure starts a cluster.

- +

StartCluster Parameters

@@ -1840,27 +1840,27 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Cluster Name Name of the cluster to be started.
Timeout Specifies the waiting time before cluster start times out and returns an error.
- +

Start Cluster

To Start Cluster in Flow interface, do these steps:

@@ -1879,25 +1879,25 @@ Next, to make it available on each server it should be propagated to all servers

- +
- +

StopCluster

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

Stops cluster using wsadmin tool.

- - + +

This procedure stops a cluster.

- +

StopCluster Parameters

@@ -1907,32 +1907,32 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Cluster Name Name of the cluster to be stopped.
Timeout Specifies the waiting time before cluster stop times out and returns an error.
Perform Ripple Start? If checked, all servers within cluster will be stopped one-by-one and then started.
- +

Stop Cluster

To Stop Cluster in Flow interface, do these steps:

@@ -1951,22 +1951,22 @@ Next, to make it available on each server it should be propagated to all servers

- +
- +

StartDeploymentManager

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

This procedure starts the Deployment Manager in a WAS network deployment.

- - + +

StartDeploymentManager Parameters

@@ -1976,17 +1976,17 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
StartManager Location Absolute Physical path in Filesystem to location of startManager script i.e., /path/to/startManager.sh or startManager.bat
Deployment Manager Profile @@ -1994,27 +1994,27 @@ Next, to make it available on each server it should be propagated to all servers If this is not provided StartManager will start the DeploymentManager which has the default profile.
Log File Location Absolute Physical path in Filesystem to location of startManager.sh logs i.e., /path/to/startServer.log
Timeout Specifies the waiting time before deployment manager start times out and returns an error.
Additional Parameters This parameter can be used to either override defaults or pass Custom Properties. For example: -quiet, -nowait, -help.
- +

Start Deployment Manager

To Start Deployment Manager in Flow interface, do these steps:

@@ -2033,22 +2033,22 @@ Next, to make it available on each server it should be propagated to all servers

- +
- +

StopDeploymentManager

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

Stops Deployment Manager

- - + +

StopDeploymentManager Parameters

@@ -2058,17 +2058,17 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
StopManager Location Absolute Physical path in Filesystem to location of stopManager script i.e., /path/to/stopManager.sh or stopManager.bat
Deployment Manager Profile @@ -2076,27 +2076,27 @@ Next, to make it available on each server it should be propagated to all servers If this is not provided StopManager will stop the DeploymentManager which has the default profile.
Log File Location Absolute Physical path in Filesystem to location of stopManager.sh logs i.e., /path/to/stopServer.log
Timeout Specifies the waiting time before deployment manager stop times out and returns an error.
Additional Parameters This parameter can be used to either override defaults or pass Custom Properties. For example: -quiet, -nowait, -help.
- +

Stop Deployment Manager

To Stop Deployment Manager in Flow interface, do these steps:

@@ -2115,22 +2115,22 @@ Next, to make it available on each server it should be propagated to all servers

- +
- +

StartNode

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

This procedure starts a WAS node and optionally starts all Application Servers in that Node.

- - + +

StartNode Parameters

@@ -2140,17 +2140,17 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
StartNode Location Absolute Physical path in Filesystem to location of startNode script i.e., /path/to/startNode.sh or startNode.bat
Node Profile @@ -2158,37 +2158,37 @@ Next, to make it available on each server it should be propagated to all servers If this is not provided StartNode will start the Node which has the default profile.
Log File Location Absolute Physical path in Filesystem to location of startNode.sh logs i.e., /path/to/startServer.log
Timeout Specifies the waiting time before node start times out and returns an error.
Start all Application Servers? Start all application servers within node after nodeagent is started.
Node Name to start Servers Name of the node where application servers needs to be started.
Additional Parameters This parameter can be used to either override defaults or pass Custom Properties. For example: -quiet, -nowait, -help.
- +

Start Node

To Start Node in Flow interface, do these steps:

@@ -2207,22 +2207,22 @@ Next, to make it available on each server it should be propagated to all servers

- +
- +

StopNode

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

This procedure stops a WAS node and stops the Application Servers in that Node based on the Stop Node policy.

- - + +

StopNode Parameters

@@ -2232,17 +2232,17 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
StopNode Location Absolute Physical path in Filesystem to location of stopNode script i.e., /path/to/stopNode.sh or stopNode.bat
Node Profile @@ -2250,32 +2250,32 @@ Next, to make it available on each server it should be propagated to all servers If this is not provided StopNode will stop the Node which has the default profile.
Log File Location Absolute Physical path in Filesystem to location of stopNode.sh logs i.e., /path/to/stopServer.log
Timeout Specifies the waiting time before node stop times out and returns an error.
Node Stop Policy Policy that will be used for node stopping. It could be one of: Just Stop node agent, stop Spplication Servers, Save Node State.
Additional Parameters This parameter can be used to either override defaults or pass Custom Properties. For example: -quiet, -nowait, -help.
- +

Stop Node

To Stop Node in Flow interface, do these steps:

@@ -2294,20 +2294,20 @@ Next, to make it available on each server it should be propagated to all servers

- +
- +

StartServer

- - + +

Starts a WebSphere instance

- - + +

This procedure starts a WebSphere instance or an application server using startServer.sh.

- +

StartServer Parameters

@@ -2317,38 +2317,38 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - +
StartServer Absolute Path Absolute path of the start server script, including filename and extension. i.e: 'startServer.bat' or '/path/to/startServer.sh' or 'C:\Program Files\IBM\WebSphere\AppServer\bin\startServer.bat'.
Instance name The name of the instance of the server to be started. i.e: 'server01'.
Additional Commands Additional commands to be entered for the startup of the server.
- +
- +

StopServer

- - + +

Stops a WebSphere instance

- - + +

This procedure stops a WebSphere instance or an application server using stopServer.sh

- +

StopServer Parameters

@@ -2358,43 +2358,43 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Script Location Absolute path of the stop server script, including filename and extension. i.e: 'C:/Program Files/IBM/WebSphere/AppServer/bin/stopServer.bat', 'stopServer.bat', '/path/to/stopServer.sh'
Instance Name Server instance name of the server to be stopped. i.e: 'server01'.
Additional Commands Additional commands to be entered for stop the server.
- +
- +

RunCustomJob

- - + +

Runs a task using wsadmin

- - + +

This procedure runs a task using wsadmin and the Jython code files.

- +

RunCustomJob Parameters

@@ -2404,74 +2404,74 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Wsadmin Absolute Path Absolute path of wsadmin, including filename and extension. If the path in which wsadmin is stored in the path environmental variable, the absolute path is ommited. i.e: '/path/to/wsadmin.sh' or 'wsadmin.bat'.
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'.
Script File Absolute Path Path of a Jython script that will be run using wsadmin. i.e: '/path/to/scriptFile.jython' or 'c:/dir/scriptFile.jython'.
Script File Source Indicates either if a script file route or an embedded script file will be provided.
Script File Content of the script file to run if Embedded File is chosen in the Script File Source.
Additional Commands Additional commands to be entered for wsadmin.
- +

Running Custom Jobs

For a complete example, go to the Examples and Use Cases section.

- +
- +

ConfigureSession

- - + +

Configures the session management properties for the deployed application.

- - + +

This procedure configures the session management related properties for deployed application. For more information on each of the parameter, please refer to the WebSphere Knowledge Center Page.

- +

ConfigureSession Parameters

@@ -2481,80 +2481,80 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
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 web application to configure.
Enable SSL Tracking Specifies that session tracking uses Secure Sockets Layer (SSL) information as a session ID. Enabling SSL tracking takes precedence over cookie-based session tracking and URL rewriting.
Enable Cookies Specifies whether to enable cookies.
Enable URL Rewriting Specifies whether the session management facility uses rewritten URLs to carry the session IDs. If URL rewriting is enabled, the session management facility recognizes session IDs that arrive in the URL if the encodeURL method is called in the servlet.
Enable Protocol Switching This option is only applicable when Enable URL rewriting is selected. This option specifies that the session ID is added to a URL when the URL requires a switch from HTTP to HTTPS or from HTTPS to HTTP. If rewriting is enabled, the session ID is required to go between HTTP and HTTPS.
Max in-memory session count Specifies the maximum number of sessions to maintain in memory.
Allow Overflow Specifies whether the number of sessions in memory can exceed the value specified by the Max in-memory session count property. This option is valid only in non-distributed sessions mode..
Enable Serialized Session If selected, concurrent session access in a given server is not permitted.
Maximum Wait Time Specifies the maximum amount of time in seconds a servlet request waits on an HTTP session before continuing execution. The default is 5 seconds. Under normal conditions, a servlet request waiting for access to an HTTP session gets notified by the request that currently owns the given HTTP session when the request finishes.
Access Session On Timeout Specifies whether the servlet is started normally or aborted in the event of a timeout. If you specify true, the servlet is started normally. If you specify false, the servlet execution aborts and error logs are generated.
Invalid Timeout Specifies how long(in minutes) a session can go unused before it is no longer valid.
Session Persistence Mode Specifies whether to enable session persistence mode.
- +

Configure Session Management for application

To Configure Session Management for application, do these steps:

@@ -2572,20 +2572,20 @@ Next, to make it available on each server it should be propagated to all servers

- +
- +

MapSharedLibrary

- - + +

Maps shared library.

- - + +

This procedure maps shared library to already deployed application.

- +

MapSharedLibrary Parameters

@@ -2595,30 +2595,30 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
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'.
Library Name Shared Library Name.
Application Name Name of application to which shared library will be mapped.
- +

Map Shared Library to Application

To map shared library to application, do these steps:

@@ -2635,20 +2635,20 @@ Next, to make it available on each server it should be propagated to all servers

- +
- +

ModifyApplicationClassLoader

- - + +

Modify Application ClassLoader.

- - + +

This procedure modifies ClassLoader of the deployed Application.

- +

ModifyApplicationClassLoader Parameters

@@ -2658,35 +2658,35 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Wsadmin 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'.
Load Order The class-loader delegation mode, also known as the class loader order, determines whether a class loader delegates the loading of classes to the parent class loader.
ClassLoader Isolation Policy Application class loaders load EJB modules, dependency JAR files, embedded resource adapters, and application-scoped shared libraries. Depending on the application class-loader policy, an application class loader can be shared by multiple applications (Single) or unique for each application (Multiple). The application class-loader policy controls the isolation of applications that are running in the system. When set to Single, applications are not isolated. When set to Multiple, applications are isolated from each other.
Application Name Name of the existing web application, which ClassLoader should be modified.
- +

Modify Application's ClassLoader

To modify Application's ClassLoader do the following steps:

@@ -2703,20 +2703,20 @@ Next, to make it available on each server it should be propagated to all servers

- +
- +

StartApp

- - + +

Start an application using wsadmin

- - + +

This procedure starts an application using wsadmin. If the application is already running, a warning will be thrown.

- +

StartApp Parameters

@@ -2726,55 +2726,55 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Wsadmin Absolute Path Absolute path of wsadmin, including filename and extension. If the path in which wsadmin is stored in the path environmental variable, the absolute path is ommited. i.e: '/path/to/wsadmin.sh' or 'wsadmin.bat'.
Application Name Name of the application to start. i.e: 'webapp'.
Cluster Name Name of the cluster on which application is deployed. Not required in WebSphere Base Edition.
Server Name Name of the server on which application is deployed. Specify server in the form Node=server. For e.g. Node01=Server1. Not required in WebSphere Base Edition.
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'.
Additional Commands Additional commands to be entered for wsadmin.
- +

Starting Applications

To start an application, do these steps:

@@ -2791,20 +2791,20 @@ Next, to make it available on each server it should be propagated to all servers report.

- +
- +

StopApp

- - + +

Stop an application using wsadmin

- - + +

This procedure stops an application using wsadmin. If the application is already stopped, a warning will be thrown.

- +

StopApp Parameters

@@ -2814,55 +2814,55 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Wsadmin Absolute Path Absolute path of wsadmin, including filename and extension. If the path in which wsadmin is stored in the path environmental variable, the absolute path is ommited. i.e: '/path/to/wsadmin.sh' or 'wsadmin.bat'.
Application Name Name of the application to stop. i.e: 'webapp'.
Cluster Name Name of the cluster on which application is deployed. Not required in WebSphere Base Edition.
Server Name Name of the server on which application is deployed. Specify server in the form Node=server. For e.g. Node01=Server1. Not required in WebSphere Base Edition.
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'.
Additional Commands Additional commands to be entered for wsadmin.
- +

Stopping Applications

To stop an application, do these steps:

@@ -2879,20 +2879,20 @@ Next, to make it available on each server it should be propagated to all servers report.

- +
- +

CreateJDBCProvider

- - + +

Creates a JDBC Provider using the wsadmin tool

- - + +

This procedure creates a JDBC provider using a Jython script.

- +

CreateJDBCProvider Parameters

@@ -2902,60 +2902,60 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Wsadmin Absolute Path Absolute path of wsadmin, including filename and extension. If the path in which wsadmin is stored in the path environmental variable, the absolute path is ommited. i.e: '/path/to/wsadmin.sh' or 'wsadmin.bat'.
JDBC Provider Name Name of the JDBC Provider.
JDBC Provider Description A description for the JDBC Provider.
Cell Scope Parent object where the JDBC Provider will be created. This determines the visibility scope of the JDBC Provider. When the Cell Scope is provided, if the node and server scopes are not provided, then the scope will be the 'cell'; if the node is provided and the server not, then the scope will be the 'node'; if the server is provided and the node not, then the scope will be the 'server'. At least the Cell, the Node or the Server scope must be provided. i.e: 'wsaspluginNode01Cell'.
Cluster Scope When the Cluster Scope is provided, then the scope will be the cluster. i.e: 'cluster1'.
Node Scope When the Node Scope is provided, if the cell and server scopes are not provided, then the scope will be the 'node'; if the cell is provided and the server not, then the scope will be the 'node'; if the server is provided and the cell not, then the scope will be the 'server'. i.e: 'wsaspluginNode01'.
Server Scope When the Server Scope is provided, then the scope will be the Node and the server always, even if the Node and the Cell Scopes are not provided. i.e: 'server1'.
Implementation Class Name Java class name of the JDBC provider implementation.
Driver Class Path A path for the resource provider classes.
- +

Creating a JDBC Providers

To create a JDBC provider, do these steps:

@@ -2974,20 +2974,20 @@ Next, to make it available on each server it should be propagated to all servers report.

- +
- +

DeleteJDBCProvider

- - + +

Deletes a JDBC Provider using the wsadmin tool

- - + +

This procedure deletes a JDBC provider using a Jython script.

- +

DeleteJDBCProvider Parameters

@@ -2997,25 +2997,25 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Wsadmin Absolute Path Absolute path of wsadmin, including filename and extension. If the path in which wsadmin is stored in the path environmental variable, the absolute path is ommited. i.e: '/path/to/wsadmin.sh' or 'wsadmin.bat'.
JDBC Provider Name A unique name that identifies the JDBC Provider to delete in the WebSphere domain.
- +

Deleting JDBC Providers

To delete a JDBC provider, do these steps:

@@ -3033,20 +3033,20 @@ Next, to make it available on each server it should be propagated to all servers

- +
- +

CreateDatasource

- - + +

Creates a datasource using the wsadmin tool. The scope assigned to the datasource is provided by the JDBC Provider.

- - + +

The procedure creates a datasource by using a Jython script.

- +

CreateDatasource Parameters

@@ -3056,55 +3056,55 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Wsadmin Absolute Path Absolute path of wsadmin, including filename and extension. If the path in which wsadmin is stored in the path environmental variable, the absolute path is ommited. i.e: '/path/to/wsadmin.sh' or 'wsadmin.bat'.
JDBC Provider Name of an existing JDBC Provider.
Datasource Name A unique name that identifies this Datasource in the WebSphere domain.
Datasource Description A description for the datasource.
JNDI Name The JNDI path to where this Datasource is bound.
Statement Cache Size Specifies the number of statements that can be cached per connection. The application server caches a statement after you close that statement.
Authentication Alias Name Provide the authentication data alias.
Datasource Helper Class Name Provide the datasource helper class name.
- +

To create a datasource, do the following steps:

    @@ -3122,20 +3122,20 @@ Next, to make it available on each server it should be propagated to all servers report.

    - +
- +

DeleteDatasource

- - + +

Deletes a datasource using the wsadmin tool

- - + +

This procedure deletes a datasource using a Jython script.

- +

DeleteDatasource Parameters

@@ -3145,25 +3145,25 @@ Next, to make it available on each server it should be propagated to all servers - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Wsadmin Absolute Path Absolute path of wsadmin, including filename and extension. If the path in which wsadmin is stored in the path environmental variable, the absolute path is ommited. i.e: '/path/to/wsadmin.sh' or 'wsadmin.bat'.
Datasource Name A unique name that identifies the datasource to delete in the WebSphere domain.
- +

Deleting Datasources

To delete a datasource, do these steps:

@@ -3181,20 +3181,20 @@ the following diagnostic report.

- +
- +

CreateJMSProvider

- - + +

Creates a JMS Provider using the wsadmin tool

- - + +

This procedure creates a new JMS provider using a Jython script.

- +

CreateJMSProvider Parameters

@@ -3204,75 +3204,75 @@ report.

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

A Configuration defines connection details and can be created by going to plugin configuration page.
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 a scope of cell, node, server, or cluster for the JMS provider. E.g. Cell=Cell01,Node=Node01,Server=server1
JMS Provider Name Specifies the name to assign to the new JMS provider.
Initial Context Factory Specifies the Java class name of the initial context factory for the JMS provider.
JMS provider URL Specifies the JMS provider URL for external JNDI lookups.
Classpath Specifies a list of paths or Java archive (JAR) file names which together form the location for the resource provider classes. Use a semicolon (;) to separate class paths.
Description Specifies a description of the JMS Provider.
Isolated Class Loader If set to true, specifies that the resource provider is loaded in its own class loader.
Native Path Specifies an optional path to any native libraries, such as *.dll and *.so. Native path entries are separated by a semicolon (;).
Provider Type Specifies the JMS provider type that this JMS provider uses.
Property Set Specifies resource properties in the following format: [[['name','nameValue1'],['type','typeValue1'],['value','valueValue1']]... [['name','nameValuen'],['type','typeValuen'],['value','valueValuen']]]
Supports ASF If set to true, specifies that the JMS provider supports Application Server Facilities (ASF), which provides concurrency and transactional support for applications.
- +

Create JMS Provider

To create a new JMS provider, do these steps:

@@ -3282,20 +3282,20 @@ report.

DeleteJMSProvider

- - + +

Deletes JMS Provider

- - + +

This procedure deletes an existing JMS Provider.

- +

DeleteJMSProvider Parameters

@@ -3305,25 +3305,25 @@ report.

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

A Configuration defines connection details and can be created by going to plugin configuration page.
JMS Provider Scope Scope of the WebSphere messaging provider to be deleted.
JMS Provider Administartive Name The administrative name of JMS Provider to be deleted.
- +

Delete JMS Provider

To delete JMS Provider in Commander interface, do these steps:

@@ -3357,20 +3357,20 @@ report.

- +
- +

CreateOrUpdateJMSQueue

- - + +

Creates or updates JMS Queues

- - + +

This procedure creates a new JMS Queue or updates an existing JMS Queue.

- +

CreateOrUpdateJMSQueue Parameters

@@ -3380,58 +3380,58 @@ report.

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

A Configuration defines connection details and can be created by going to plugin configuration page.
Messaging System Type The name of the messaging provider. Pass in either WMQ or SIB.
Queue Scope Scope of the messaging provider at which the JMS Queue is to be created.
Queue Administrative Name The administrative name assigned to this WebSphere MQ messaging provider queue.
Queue Name Name of the Queue.
JNDI Name The name used to bind this object into WebSphere Application Server JNDI.
Queue Manager Name Queue manager that hosts the queue.
Queue Administrative Description An administrative description assigned to queue.
Additional Options - This parameter can be used to either override defaults or pass Custom Properties. + This parameter can be used to either override defaults or pass Custom Properties. For example: -ccsid 1208 -readAhead YES
- +

Create or update JMS Queue

To create or update JMS Queue in Commander interface, do these steps:

@@ -3465,20 +3465,20 @@ report.

- +
- +

DeleteJMSQueue

- - + +

Deletes JMS Queues

- - + +

This procedure deletes an existing JMS Queue.

- +

DeleteJMSQueue Parameters

@@ -3488,30 +3488,30 @@ report.

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

A Configuration defines connection details and can be created by going to plugin configuration page.
Messaging System Type The name of the messaging provider. Pass in either WMQ or SIB.
Queue Scope Scope of the messaging provider at which the JMS Queue is to be deleted.
Queue Administrative Name The administrative name assigned to this WebSphere MQ messaging provider queue.
- +

Delete JMS Queue

To delete JMS Queue in Commander interface, do these steps:

@@ -3545,20 +3545,20 @@ report.

- +
- +

CreateOrUpdateJMSTopic

- - + +

Creates or updates JMS Topics

- - + +

This procedure creates a new JMS Topic or updates an existing JMS Topic.

- +

CreateOrUpdateJMSTopic Parameters

@@ -3568,53 +3568,53 @@ report.

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

A Configuration defines connection details and can be created by going to plugin configuration page.
Messaging System Type The name of the messaging provider. Pass in either WMQ or SIB.
Topic Scope Scope of the messaging provider at which the JMS Topic is to be created.
Topic Administrative Name The administrative name assigned to this WebSphere MQ messaging provider Topic.
Topic Name Name of the Topic.
JNDI Name The name used to bind this object into WebSphere Application Server JNDI.
Topic Administrative Description An administrative description assigned to Topic.
Additional Options - This parameter can be used to either override defaults or pass Custom Properties. + This parameter can be used to either override defaults or pass Custom Properties. For example: -readAhead YES -ccsid 1208
- +

Create or update JMS Topic

To create or update JMS Topic in Commander interface, do these steps:

@@ -3648,20 +3648,20 @@ report.

- +
- +

DeleteJMSTopic

- - + +

Deletes JMS Topics

- - + +

This procedure deletes an existing JMS Topic.

- +

DeleteJMSTopic Parameters

@@ -3671,30 +3671,30 @@ report.

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

A Configuration defines connection details and can be created by going to plugin configuration page.
Messaging System Type The name of the messaging provider. Pass in either WMQ or SIB.
Topic Scope Scope of the messaging provider at which the JMS Topic is to be deleted.
Topic Administrative Name The administrative name assigned to this WebSphere MQ messaging provider topic.
- +

Delete JMS Topic

To delete JMS Topic in Commander interface, do these steps:

@@ -3728,20 +3728,20 @@ report.

- +
- +

CreateOrUpdateSIBJMSActivationSpec

- - + +

Creates or updates SIB JMS Activation Specs

- - + +

This procedure creates a new JMS Activation Spec or updates an existing JMS Activation Spec.

- +

CreateOrUpdateSIBJMSActivationSpec Parameters

@@ -3751,42 +3751,42 @@ report.

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

A Configuration defines connection details and can be created by going to plugin configuration page.
Scope of the Activation Spec Scope of the WebSphere Default messaging provider at which the Activation Spec is to be created.
Activation Spec Administrative Name The administrative name assigned to this Activation Spec.
JNDI Name The name and location used to bind this object into WebSphere Application Server JNDI.
Destination JNDI Name The JNDI name of the destination JMS queue or topic used by the message-driven bean.
Activation Spec Administrative Description An Administrative description assigned to Activation Spec.
Destination Type An option to determine whether the message_driven bean uses a JMS queue or a JMS topic.
Message Selector @@ -3799,15 +3799,15 @@ report.

- + - +

CreateOrUpdateWMQJMSActivationSpec

- - + +

Creates or updates WMQ JMS Activation Specs

- - + +

This procedure creates a new JMS Activation Spec or updates an existing JMS Activation Spec.

- +

CreateOrUpdateWMQJMSActivationSpec Parameters

@@ -3864,62 +3864,62 @@ report.

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

A Configuration defines connection details and can be created by going to plugin configuration page.
Scope of the Activation Spec Scope of the WebSphere MQ messaging provider at which the Activation Spec is to be created.
Activation Spec Administrative Name The administrative name assigned to this Activation Spec.
JNDI Name The name and location used to bind this object into WebSphere Application Server JNDI.
Destination JNDI Name The JNDI name of the destination JMS queue or topic used by the message-driven bean.
Destination JNDI Type The type of the destination specified by "Destination JNDI Name" parameter.
Activation Spec Administrative Description An Administrative Description assigned to Activation Spec.
Client Channel Definition URL A URL to a client channel definition table to use, for this Activation Spec, when contacting WebSphere MQ.
Client Channel Definition Queue Manager A queue manager name, used to select one or more entries from a client channel definition table.
Additional Options Used to either override defaults or pass Custom Properties.
- +

Create or update WMQ JMS Activation Spec

To create or update WMQ JMS Activation Spec in Commander interface, do these steps:

@@ -3953,20 +3953,20 @@ report.

- +
- +

DeleteJMSActivationSpec

- - + +

Deletes JMS Activation Specs

- - + +

This procedure deletes an existing JMS ActivationSpec.

- +

DeleteJMSActivationSpec Parameters

@@ -3976,30 +3976,30 @@ report.

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

A Configuration defines connection details and can be created by going to plugin configuration page.
Messaging System Type The name of the messaging provider. Pass in either WMQ or SIB.
Scope of the Activation Spec Scope of the messaging provider at which the JMS Activation Spec is to be deleted.
Activation Spec Administrative Name The administrative name assigned to this WebSphere MQ messaging provider Activation Spec.
- +

Delete JMS Activation Spec

To delete JMS Activation Spec in Commander interface, do these steps:

@@ -4037,20 +4037,20 @@ report.

- +
- +

CreateOrUpdateSIBJMSConnectionFactory

- - + +

Creates or updates SIB JMS Connection Factories

- - + +

This procedure creates a new SIB JMS Connection Factory or updates an existing JMS Connection Factory.

- +

CreateOrUpdateSIBJMSConnectionFactory Parameters

@@ -4060,38 +4060,38 @@ report.

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

A Configuration defines connection details and can be created by going to plugin configuration page.
Scope of the Connection Factory Scope of the WebSphere Default messaging provider at which the Connection Factory is to be created.
Connection Factory Administrative Name The administrative name assigned to this Connection Factory.
Bus Name Name of the service integration bus to which connections are made.
JNDI Name The name and location used to bind this object into WebSphere Application Server JNDI.
Connection Factory Type @@ -4101,20 +4101,20 @@ report.

- + - +

CreateOrUpdateWMQJMSConnectionFactory

- - + +

Creates or updates WMQ JMS Connection Factories

- - + +

This procedure creates a new WMQ JMS Connection Factory or updates an existing JMS Connection Factory.

- +

CreateOrUpdateWMQJMSConnectionFactory Parameters

@@ -4171,26 +4171,26 @@ report.

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

A Configuration defines connection details and can be created by going to plugin configuration page.
Scope of the Connection Factory Scope of the WebSphere MQ messaging provider at which the Connection Factory is to be created.
Connection Factory Administrative Name The administrative name assigned to this Connection Factory.
Connection Factory Type @@ -4199,39 +4199,39 @@ report.

JNDI Name		 The name and location used to bind this object into WebSphere Application Server JNDI.
Connection Factory Administrative Description An Administrative description assigned to Connection Factory.
Client Channel Definition URL A URL to a client channel definition table to use, for this Connection Factory, when contacting WebSphere MQ.
Client Channel Definition Queue Manager A queue manager name, used to select one or more entries from a client channel definition table.
Additional Options Used to either override defaults or pass Custom Properties.
- +

Create or update WMQ JMS Connection Factory

To create or update WMQ JMS Connection Factory in Commander interface, do these steps:

@@ -4265,20 +4265,20 @@ report.

- +
- +

DeleteJMSConnectionFactory

- - + +

Deletes JMS Connection Factories

- - + +

This procedure deletes an existing JMS ConnectionFactory.

- +

DeleteJMSConnectionFactory Parameters

@@ -4288,32 +4288,32 @@ report.

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

A Configuration defines connection details and can be created by going to plugin configuration page.
Messaging System Type The name of the messaging provider. Pass in either WMQ or SIB.
Scope of the Connection Factory Scope of the WebSphere messaging provider at which the Connection Factory is to be deleted.
Connection Factory Administrative Name The administrative name assigned to this Connection Factory.
- +

Delete JMS ConnectionFactory

To delete JMS ConnectionFactory in Commander interface, do these steps:

@@ -4347,20 +4347,20 @@ report.

- +
- +

DeployApp

- - + +

Deploys an application using AdminApp.install

- - + +

This procedure undeploys an application using a Jython script and invoking AdminApp.uninstall.

- +

DeployApp Parameters

@@ -4370,50 +4370,50 @@ report.

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

A Configuration defines connection details and can be created by going to plugin configuration page.
Wsadmin Absolute Path Absolute path of wsadmin, including filename and extension. If the path in which wsadmin is stored in the path environmental variable, the absolute path is ommited. i.e: '/path/to/wsadmin.sh' or 'wsadmin.bat'.
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'
Application Name Name of the web application to be deploy. i.e: 'webapp'.
Application Path Absolute path of the application to deploy. i.e: '/path/to/webapp.war' or 'c:/mydir/webapp.war'.
Additional Commands Additional commands to be entered for wsadmin.
- +

Deploying Applications

To deploy an application, do these steps:select the following @@ -4432,20 +4432,20 @@ report.

- +
- +

DeployEnterpriseApp

- - + +

Deploys an enterprise application using wsadmin tool

- - + +

This procedure deploys java enterprise application (.EAR) or java web application (.WAR) on given targets. If application is already deployed, procedure updates application.

- +

DeployEnterpriseApp Parameters

@@ -4455,183 +4455,183 @@ report.

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

A Configuration defines connection details and can be created by going to plugin configuration page.
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 Specifies logical name to be given to installing enterprise application. Do not include whitespaces in application name.
Application Path Absolute path of the application to deploy. Use "/" as the path separator on both linux and windows i.e: '/path/to/webapp.war' or 'c:/mydir/webapp.war'.
Target cluster Name of the cluster on which to deploy enterprise application. Not required in WebSphere Base Edition. Enter either target cluster or target server(s).
Target server(s) Specify single or list of standalone application servers on which to deploy enterprise application. Specify servers in the form Node=server. For e.g. Node01=Server1,Node02=Server2. Not required in WebSphere Base Edition.
Map modules to servers Specify deployment targets where you want to install the modules that are contained in your application. Modules can be installed on the same deployment target or dispersed among several deployment targets. Give input in format [ "Module1Name" Module1URL server1][ "Module2Name" Module2URL server2 ] E.g. [ "Increment EJB module" Increment.jar,META-INF/ejb-jar.xml WebSphere:cell=Cell01,node=Node01,server=singleServer ]
Additional deployment parameters Specify any additional options for AdminApp. Install object in case not listed in this input form. For more information about each of the supported arguments, refer to 'http://www-01.ibm.com/support/knowledgecenter/SSAW57_8.5.5/com.ibm.websphere.nd.doc/ae/rxml_taskoptions.html'.
Directory to install application Specifies the directory to which the enterprise archive (EAR) file will be installed. Default is profile_root/installedApps/cell_name/application_name.ear directory.
Precompile JavaServer Pages files? Specify whether to precompile JavaServer Pages (JSP) files as a part of installation. The default is not to precompile JSP files.
Distribute application? Specifies whether the product expands application binaries in the installation location during installation.
Use binary configuration? Specifies whether the application server uses the binding, extensions, and deployment descriptors located with the application deployment document, the deployment.xml file (default), or those located in the enterprise archive (EAR) file. Default is to use bindings located in deployment.xml.
Deploy enterprise beans? Specifies whether the EJBDeploy tool runs during application installation. Default is false(true for EJB 3.0 modules).
Create MBeans for resources? Specifies whether to create MBeans for resources such as servlets or JSP files within an application when the application starts. Default is create MBeans.
Override class reloading settings for web and EJB modules? Specifies whether the product run time detects changes to application classes when the application is running. If yes, then on such changes application is stopped and restarted to reload updated classes.
Deploy web services? Specifies whether to deploy web services. Default is do not enable Deploy web services.
Process embedded configuration? Specifies whether the embedded configuration should be processed. An embedded configuration consists of files such as resource.xml, variables.xml, and deployment.xml.
Allow EJB reference targets to resolve automatically? Specifies whether the embedded configuration should be processed.
Deploy client modules? Select if the file to deploy has one or more client modules and want to configure environment entries for the client modules. Default is do not enable Client Module.
Validate schema? Specifies whether to validate the deployment descriptors against published Java EE deployment descriptor schemas.
Synchronize active nodes? Specify whether to synchronize active nodes. Applicable only for Network Deployment installation. Enabled by default.
Start application? Specify whether to start application or not. Enabled by default.
Reload interval in seconds Specifies the number of seconds to scan the application's file system for updated files. Default is 3 seconds.
Validate resource references Specifies whether websphere examines the application references specified during application installation or updating and, if validation is enabled, warns you of incorrect references or fails the operation.
File permission Specifies access permissions for application binaries.
Customized file permission Provide custom file permissions if not listed in File permissions drop down.
Business level application name Specifies whether websphere creates a new business-level application with the enterprise application that you are installing or makes the enterprise application a composition unit of an existing business-level application. The default is to create a new business-level application.
Client deployment mode Specifies whether to deploy client modules to an isolated deployment target (Isolated), a federated node of a deployment manager (Federated), or an application server (Server Deployed). Default is Isolated
Wsadmin Commands Commands to be entered to wsadmin. Use one command per line.
Wsadmin 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'.
Wsadmin Java Parameters Java options to be passed to wsadmin, separate them using semicolons (;).
Wsadmin Additional Arguments Additional arguements to be passed to wsadmin.
Context root Applicable only to web applications (WAR). Specifies the context root of the web application (WAR). A context root for each web module is defined in the application deployment descriptor during application assembly. Use this field to assign a different context root to a web module. The context root is combined with the defined servlet mapping (from the WAR file) to compose the full URL that users type to access the servlet. For example, if the context root is /gettingstarted and the servlet mapping is MySession, then the URL is http://host:port/gettingstarted/MySession.
- +

Deploy Enterprise Application

To deploy an enterprise application, do these steps:

@@ -4649,20 +4649,20 @@ A context root for each web module is defined in the application deployment desc

- +
- +

UndeployApp

- - + +

Undeploys an application using AdminApp.uninstall

- - + +

This procedure undeploys an application using a Jython script and invoking AdminApp.uninstall.

- +

UndeployApp Parameters

@@ -4672,45 +4672,45 @@ A context root for each web module is defined in the application deployment desc - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Wsadmin Absolute Path Absolute path of wsadmin, including filename and extension. If the path in which wsadmin is stored in the path environmental variable, the absolute path is ommited. i.e: '/path/to/wsadmin.sh' or 'wsadmin.bat'.
Application Name Name of the application to undeploy. i.e: 'webapp'.
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'
Additional Commands Additional commands to be entered for wsadmin.
- +

Undeploying Applications

To undeploy an application, do these steps:

@@ -4727,20 +4727,20 @@ A context root for each web module is defined in the application deployment desc report.

- +
- +

UpdateApp

- - + +

Updates existing application

- - + +

This procedure updates already deployed application in units of files, modules or entire application.

- +

UpdateApp Parameters

@@ -4750,60 +4750,60 @@ A context root for each web module is defined in the application deployment desc - + - + - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
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 web application to be updated. i.e: 'webapp'.
Content Type Specifies to type of content to update. Use File option for updating a single file, Partial Application option for updating application partially, Module option to add/update a module to the deployed application, Application option for updating the entire deployed application.
Operation Specifies to type of operation to perform as part of update procedure. Use Add option to add new content, Update option to update existing content, AddUpdate option to add content and to replace if already exist, Delete option to remove existing content respectively.
Content Specifies the file that contains the content that you want to update. For example, depending on the content type, the file could be an EAR file, a module, a partial zip, or a single file.Not required for Delete operation.
Content URI The relative path beginning with the installed application archive file to the file to be replaced or added. For example, if the file is located at com/company/greeting.class in module hello.jar, specify hello.jar/com/company/greeting.class for the relative path
Cluster Name Name of the cluster on which application is deployed.
Server Name Name of the server on which application is deployed.
Additional Parameters Additional parameters to pass while updating entire application or module/s, if required. For e.g. -nodeployejb, -BindJndiForEJBNonMessageBinding etc.
- +

Update Application

To update application , do these steps:

@@ -4821,20 +4821,20 @@ A context root for each web module is defined in the application deployment desc

- +
- +

CheckApp

- - + +

Checks if a web application is ready

- - + +

This procedure checks if a web application is ready by using a Jython script.

- +

CheckApp Parameters

@@ -4844,22 +4844,22 @@ A context root for each web module is defined in the application deployment desc - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Wsadmin Absolute Path Absolute path of wsadmin, including filename and extension. i.e: '/path/to/wsadmin.sh' or 'wsadmin.bat'.
Application Name Name of the web application to be checked. i.e: 'webapp'.
Application State Checked @@ -4867,15 +4867,15 @@ A context root for each web module is defined in the application deployment desc Any state that is not the desired state after any applicable retries, will be returned as a failure by the procedure.
Wait Time Maximum duration of check application state retries.
- +

Checking Application State

To check Application State, do these steps:

@@ -4904,25 +4904,25 @@ A context root for each web module is defined in the application deployment desc

- +
- +

CheckNodeStatus

- +

(Applicable only for WebSphere Network Deployment installation.)

- - + +

Checks Node Status.

- - + +

This procedure checks WebSphere node status. It checks Node Agent and all servers associated with node by it's name.

- +

CheckNodeStatus Parameters

@@ -4932,43 +4932,43 @@ A context root for each web module is defined in the application deployment desc - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Wsadmin 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'.
Name of the Node Name of the Node, which should be checked.
Success Criteria Conditions that must be met for successful completion of the procedure.
- +
- +

CheckPageStatus

- - + +

Check the status of a page on a given URL

- - + +

This procedure checks the status of the page with the specified URL.

- +

CheckPageStatus Parameters

@@ -4978,30 +4978,30 @@ A context root for each web module is defined in the application deployment desc - + - + - + - + - +
Credentials to be entered The credentials needed to check the status of the page.
Target URL URL of the page to be checked.
Maximum Elapsed Time Defines the maximum time in seconds that the job will try to check into the server. Blank implies no wait time (URL only checked one time).
Success Criteria Indicates the expected correct result to be obtained when running checking the server.
- +

Checking the Status of a Page

To check the status of page at a specific URL, do the following steps:

@@ -5019,20 +5019,20 @@ A context root for each web module is defined in the application deployment desc report.

- +
- +

CheckServerStatus

- - + +

Check the status of the given server URL

- - + +

This procedure checks the status of the specified server URL.

- +

CheckServerStatus Parameters

@@ -5042,43 +5042,43 @@ A context root for each web module is defined in the application deployment desc - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
Maximum Elapsed Time Defines the maximum time in seconds that the job will try to check into the server. Blank implies no wait time (URL only checked one time).
Success Criteria Indicates the expected correct result to be obtained when running checking the server.
- +

- +
- +

ConfigEJBContainer

- - + +

Configures EJB container using the wsadmin tool

- - + +

This procedure configures EJB container properites using a Jython script.

- +

ConfigEJBContainer Parameters

@@ -5088,70 +5088,70 @@ A context root for each web module is defined in the application deployment desc - + - + - + - + - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
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'.
Cell Name Name of cell to which EJB container belongs to.
Node Name Name of node to which EJB container belongs to.
Server Name Name of application server to which EJB container belongs to.
Passivation Directory Specifies the directory into which the container saves the persistent state of passivated stateful session beans. This directory must already exist. It is not automatically created.Default is ${USER_INSTALL_ROOT}/temp.
Cache Size Number of buckets in the active instance list within the EJB container.Input value range - greater than 0. The container selects the next largest prime number equal to or greater than the specified value.Default is 2053
Cleanup Interval Interval (in milliseconds)at which the container attempts to remove unused items from the cache.Default is 3000. Allowed range is 0 to 2147483647
Inactive Pool Cleanup Interval Specifies the interval at which the container examines the pools of available bean instances to determine if some instances can be deleted to reduce memory usage.
Enable stateful session bean fail over using memory-to-memory replication? Specifies that failover is enabled for all stateful session beans installed in this EJB container.Replication domains must already exist to failover feature to work.
Replication domain Specifies the replication domain in which HTTP sessions are replicated.
Replication Mode The mode specifies whether data is only sent (client), only received (server), or both. Select client if sessions need to be replicated. Select server if sessions need to be stored. Select both client and server if sessions need to be replicated and stored. The default is both.
- +

Configure EJB Container

To Configure EJB Container, do these steps:

@@ -5169,20 +5169,20 @@ A context root for each web module is defined in the application deployment desc

- +
- +

DeployOSGiApp

- - + +

Deploy OSGi application using the wsadmin tool

- - + +

This procedure deploys the OSGi application.It optionally configures external OSGi bundle library if the application to be deployed reference bundles that are stored in an external bundle repository. This procedure can also add the bundles to internal bundle repository, if required.

- +

DeployOSGiApp Parameters

@@ -5192,55 +5192,55 @@ A context root for each web module is defined in the application deployment desc - + - + - + - + - + - + - + - + - + - +
Configuration Name Name of the configuration to be used. URL, port and credentials are retrieved from the given configuration.

A Configuration defines connection details and can be created by going to plugin configuration page.
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'.
Want to add external bundle repository? If your OSGi applications reference bundles that are stored in an external bundle repository, you must configure a link (name and URL) to the repository so that the provisioner can retrieve the bundles when required.
External Bundle Repository Name Name of the external bundle repository to configure.
External Bundle Repository URL URL of the external bundle repository to configure.
List of bundles to add to local repository Comma separated list of bundles to add to internal bundle repository.E.g. C:/installableApps/com.ibm.samples.websphere.osgi.logging.api.jar,C:/installableApps/com.ibm.samples.websphere.osgi.logging.impl.jar
EBA file Path Absolute path of the OSGi application to deploy. i.e: '/path/to/blog.eba' or 'c:/mydir/blog.eba'.
Application Name Name to be given to newly deployed OSGi application.
Target Deployment Unit Deployment Unit on which to deploy the OSGi application. For e.g cluster=cluster1 or node=node01,server=server1
- +

Deploy OSGi Application

To deploy an OSGi application, do these steps:

@@ -5258,17 +5258,17 @@ A context root for each web module is defined in the application deployment desc

- +
- +

Discover

- - + +

Discover WebSphere instance configuration on a resources or environment

- - + +

Discover Parameters

@@ -5278,33 +5278,38 @@ A context root for each web module is defined in the application deployment desc - + - + - +
Configuration Name The plugin's configuration name.
Resource Names List of resources, on which discovery procedure should run. Enter multiple values on separate lines.
- +
- - - + + +

Release Notes

- -

@PLUGIN_KEY@ 2.6.0

+ +

@PLUGIN_KEY@ 2.6.1

+
    +
  • The plugin icon has been updated.
    • +
+ +

@PLUGIN_KEY@ 2.6.0

    - +
  • Following new procedures have been added to support management of clusters:
    • CreateFirstClusterMember
      • @@ -5321,12 +5326,12 @@ The Interface for the Following procedures have been Improved (for moving WSADMI
    Error Reporting has been improved by leveraging postp to capture granular error messages in Diagnostics.
    • - +
- +

@PLUGIN_KEY@ 2.5.0

    - +
  • Following New procedures have been added to support application server management:
    • CreateApplicationServer
      • @@ -5347,19 +5352,19 @@ Error Reporting has been improved by leveraging postp to capture granular error
  • WSAdmin Absolute path has been changed from non-required to required in plugin configuration.
    • - +
- +

@PLUGIN_KEY@ 2.4.1

    - +
  • Configured the plugin to allow the ElectricFlow UI to create configs inline of procedure form.
    • - +
- +

@PLUGIN_KEY@ 2.4.0

    - +
  • Following New procedures have been added to support the entire set of IBM JMS functionality:
    • - +
- +

@PLUGIN_KEY@ 2.3.1

    - +
  • Help links have been updated for DeleteJMSTopic and DeleteJMSQueue procedures.
    • - +
  • Configured the plugin to allow the ElectricFlow UI to render the plugin procedure parameters entirely using the configured form XMLs.
    • - +
  • Enabled the plugin for managing the plugin configurations in-line when defining an application process step or a pipeline stage task.
    • - +
- +

@PLUGIN_KEY@ 2.3.0

    - +
  • Following New procedures have been added:
    • DeleteJMSQueue
      • @@ -5440,220 +5445,220 @@ Error Reporting has been improved by leveraging postp to capture granular error
    • Procedure has been improved and now it could check for different application states.
    • - +
- +

@PLUGIN_KEY@ 2.2.4

    - +
  • Documentation has been improved.
    • - +
  • Cluster Scope field has been added to CreateJDBCProvider procedure.
    • - +
- +

@PLUGIN_KEY@ 2.2.3

    - +
  • Added support of parallel execution for all plugin procedures.
    • - +
  • Added "Context root" parameter for Deploy Enterprise Application procedure.
    • - +
  • Bug fixes in CheckPageStatus procedure.
    • - +
  • Added warning instead of stack trace in the Stop/StartApp procedures if app was already stoped or started.
    • - +
- +

@PLUGIN_KEY@ 2.2.2

    - +
  • Added new procedures - SyncNodes, CheckNodeStatus.
    • - +
  • Added following optional parameters to DeployEnterpriseApplication procedure:
    • "Synchronize active nodes": Sync active nodes after application deployment. Enabled by default.
    • "Start application": Start the deployed application after deploying the application. Enabled by default.
    • - +
  • Changed default value for "Distribute application" from unchecked to checked. (Deploy Enterprise Application procedure).
    • - +
- +

@PLUGIN_KEY@ 2.2.1

    - +
  • Added new procedures - StartCluster, StopCluster, MapSharedLibrary, ModifyApplicationClassLoader.
    • - +
  • DeployEnterpriseApp procedure will now update the application if it is already deployed. This procedure was refactored.
    • - +
  • Added debugging in DeployEnterpriseApp procedure.
    • - +
  • Bug fixes in DeployEnterpriseApplication procedure on WASND 8.5.5 Windows platform.
    • - +
  • Bug fixes in UpdateApp procedure on WAS 8.5 and WASND 8.5.5 Windows platform.
    • - +
  • Added application name to step log when ModifyApplicationClassLoader procedure fails to find application.
    • - +
  • Added debug flag to plugin configurations.
    • - +
- +

@PLUGIN_KEY@ 2.2.0

    - +
  • Added suport for discovering WebSphere configuraiton on ElectricFlow resource.
    • - +
  • Moved 'Connection Type' parameter for all plugin procedures to plugin's configuration.
    • - +
  • Added 'Cluster Name' and 'Server Name' optional parameter to 'Start Application' and 'Stop Application' procedures.
    • - +
- +

@PLUGIN_KEY@ 2.1.2

    - +
  • Fixed issue with configurations being cached for IE.
    • - +
- +

@PLUGIN_KEY@ 2.1.1

    - +
  • Added link to plugin Configuration Page in plugin step panels.
    • - +
- +

@PLUGIN_KEY@ 2.1.0

    - +
  • Added support for WebSphere Network Deployment 8.5
    • - +
  • Added support to create a cluster, add application servers to it, deploy applications in the cluster, remove cluster members, and delete the cluster.
    • - +
  • Added support to deploy Java enterprise applications (EARs) and web archives (WARs).
    • - +
  • Added support to update deployed applications.
    • - +
  • Added support to deploy OSGi applications and to configure external and internal bundle repositories.
    • - +
  • Added support to configure session management component for deployed applications.
    • - +
  • Added support for setting the EJB container properties for improved memory consumption and stateful session bean failover.
    • - +
  • Added support for the JavaMail session.
    • - +
- +

@PLUGIN_KEY@ 2.0.6

    - +
  • Fixed the DeployApp procedure to not include the password in the log file.
    • - +
  • Fixed the problem about attaching credentials in the CheckApp procedure.
    • - +
  • Fixed the problem where the wsadmin password appeared when you view job step log files and property information.
    • - +
  • Fixed instructions to create WebSphere plugin configurations.
    • - +
  • Fixed instructions to access plugins in ElectricFlow.
    • - +
- +

@PLUGIN_KEY@ 2.0.5

    - +
  • Fix minor bugs.
    • - +
- +

@PLUGIN_KEY@ 2.0.4

    - +
  • [Add four new procedures:CreateDatasources, DeleteDatasources, CreateJDBCProviders, and DeleteJDBCProviders.]
    • - +
  • Fix minor bugs.
    • - +
- +

@PLUGIN_KEY@ 2.0.3

    - +
  • Change the procedure names in the step picker section.
    • - +
- +

@PLUGIN_KEY@ 2.0.2

    - +
  • Make improvements to the help document.
    • - +
- +

@PLUGIN_KEY@ 2.0.1

    - +
  • Features and Enhancements in EC-WebSphere 2.0.1.
    • - +
  • Use the new Parameter Form XML.
    • - +
  • Add a link directly to the new help document.
    • - +
- +

@PLUGIN_KEY@ 2.0.0

    - +
  • Use the new help page format.
    • - +
  • Add new parameter panels for each procedure.
    • - +
- +

@PLUGIN_KEY@ 1.3.0

    - +
  • Add the CheckPageStatus procedure.
    • - +
  • Remove the CURL dependency from the CheckServerStatus procedure.
    • - +
  • Fix minor bugs.
    • - +
  • The procedures now have only one step using ec-perl to execute the necessary commands.
    • - +
- +

@PLUGIN_KEY@ 1.2.1

    - +
  • Fix a minor bug on the Configuration List page.
    • - +
- +

@PLUGIN_KEY@ 1.2.0

    - +
  • Add the StartApp, StopApp, DeployApp, and UndeployApp procedures.
    • - +
- +

@PLUGIN_KEY@ 1.1.1

    - +
  • Jython commands can now be entered manually in the RunCustomJob procedure.
    • - +
  • The absolute path of executable files now requires the path and filename with an extension.
    • - +
- +

@PLUGIN_KEY@ 1.1.0

    - +
  • RunCustomJob procedure has been added.
    • - +
- + diff --git a/src/main/resources/project/project.xml b/src/main/resources/project/project.xml index b450785d..b70dfab5 100644 --- a/src/main/resources/project/project.xml +++ b/src/main/resources/project/project.xml @@ -6,6 +6,12 @@ Integration with WebSphere + + + ec_icon + images/icon-plugin.svg + + @@ -274,7 +280,7 @@ create_cluster_members.py - + check_app.py @@ -3159,7 +3165,7 @@ standard - + wasNodeName @@ -3170,7 +3176,7 @@ - + wasAppServerName @@ -3181,7 +3187,7 @@ - + wasTemplateName @@ -3485,7 +3491,7 @@ - + @@ -3503,7 +3509,7 @@ wasServersList - List of Servers to be started. Provide them in this format : NodeName:ServerName. For example, + List of Servers to be started. Provide them in this format : NodeName:ServerName. For example, Node1:Server1, Node2:Server2, Node3:Server3, or Node4:* to start all servers within Node4. 1 @@ -3605,7 +3611,7 @@ - + @@ -3623,7 +3629,7 @@ wasServersList - List of Servers to be stopped. Provide them in this format : NodeName:ServerName. For example, + List of Servers to be stopped. Provide them in this format : NodeName:ServerName. For example, Node1:Server1, Node2:Server2, Node3:Server3, or Node4:* to stop all servers within Node4. 1 @@ -11726,7 +11732,7 @@ - + @@ -11888,7 +11894,7 @@ - + @@ -11981,7 +11987,7 @@ parameters - + configname @@ -12048,7 +12054,7 @@ - + @@ -12163,7 +12169,7 @@ parameters - + configname @@ -12230,7 +12236,7 @@ - + @@ -12290,7 +12296,7 @@ - + StartDeploymentManager 0 @@ -12348,7 +12354,7 @@ parameters - + configname @@ -12424,7 +12430,7 @@ - + @@ -12547,7 +12553,7 @@ parameters - + configname @@ -12930,7 +12936,7 @@ - + @@ -12975,7 +12981,7 @@ entry - + wasFirstClusterMemberGenUniquePorts @@ -13160,7 +13166,7 @@ - +