Back to Top

ConditionalBackupTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.ConditionalBackupTask
Category IBM WebSphere 8

Back up selected files (prior to upgrading WebSphere, for example).

Table of task Resources

Name Type Default Value Optional Description
backupList java.lang.String   false The list of Files or Directories to backup (separated by a ;)
backupLocation java.lang.String   true The temporary location to use for backing up the files to, defaults to platform dependent temporary directory. /tmp on Unix/Linux.
backupRoot java.lang.String install true The location of the files to be backed up [install, or absolute path]
checkType java.lang.String fileExists false The conditional check to perform. One of [fileExists]. If set to fileExists, the existence of a file, defined by fileName and fileLocation, will trigger the backup.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
fileLocation java.lang.String fileExists false If checkType is "fileExists", the location of the file or directory [profile,install,or absolute path]. If profile or install are chosen, the profile or install root will be used.
fileName java.lang.String fileExists false If checkType is "fileExists", the name of the file or directory that must exist to trigger the backup
installPath java.lang.String   false The path to the binary installation.
restoreRequired java.lang.Boolean false true Set to true if restore is required
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
tmpPath java.lang.String   true Directory to store temporary files. Leave this blank to use default /tmp path
userID java.lang.String   true The user who is used to run this task.


Back to Top

ConfigIHSPluginPrimaryServersTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.ConfigIHSPluginPrimaryServersTask
Category IBM WebSphere 8

Modifies the PrimaryServers element for a certain cluster in the plugin-cfg.xml file

Description

This task gets a list of cluster memebers (servers) of a certain cluster and modifies the PrimaryServers element of that cluster in the plugin-cfg.xml file to keep only the elements specified in the list.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
clones java.lang.String   false The list of cluster memebers you want to keep as PrimaryServers for that certain cluster. Every element of the list has to be separated by a blank space, e.g.: "rafaelruiz-MVNode01_Cluster_Server01_clone3 rafaelruiz-MVNode01_Cluster_Server01_clone5 rafaelruiz-MVNode01_Cluster_Server01_clone6"
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
fileLocation java.lang.String fileLocation false The absolute path to the plugin-cfg.xml file to modify.
newFileLocation java.lang.String DeploymentManager false The absolute path to the new file already modified.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

DeployConfigurationViaJmxTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.was.DeployConfigurationTask
Category IBM WebSphere 8

WebSphere Configuration Deployment Task using JMX.

Description

This task deploys all the configuration contained within the deployment archive template into the WebSphere server. This task uses JMX to deploy an XML based configuration template.

Task Entries

This task is able to handle Environment Variables that you can specify as a task entries with type "PROPERTY" The following optional properties may be specified:
NameTypeScopeDefault ValueOptionalDescription
BINDINGSjava.lang.StringPropertyfalseWebSphere Admin hostname.
ADMIN_PORTjava.lang.StringPropertyfalseWebSphere Admin (SOAP) Port
SOAP_CLIENT_PROPS_PATHjava.lang.StringPropertytruePath to the soap.client.props file to source connection data.
USERNAMEjava.lang.StringPropertytrueAdmin username, if not using soap.client.props because SOAP_CLIENT_PROPS_PATH is not set.
PASSWORDjava.lang.StringPropertytrueAdmin password, if not using soap.client.props because SOAP_CLIENT_PROPS_PATH is not set.
KEY_STORE_PATHjava.lang.StringPropertytrueKey store path, if not using soap.client.props because SOAP_CLIENT_PROPS_PATH is not set.
KEY_STORE_PASSWORDjava.lang.StringPropertytrueKey store password, if not using soap.client.props because SOAP_CLIENT_PROPS_PATH is not set.
TRUST_STORE_PATHjava.lang.StringPropertytrueTrust store path, if not using soap.client.props because SOAP_CLIENT_PROPS_PATH is not set.
TRUST_STORE_PASSWORDjava.lang.StringPropertytrueTrust store password, if not using soap.client.props because SOAP_CLIENT_PROPS_PATH is not set.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

DeployFileViaJmxTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.was.JmxDeployFileTask
Category IBM WebSphere 8

WebSphere Ear/War Deployment Task using JMX.

Description

This task deploys ear/war files contained within the deployment archive into the WebSphere domain. This task uses JMX to perform the deployment.

Task Entries

This task is able to handle Environment Variables that you can specify as a task entries with type "PROPERTY" The following optional properties may be specified:
These will be sourced in order of the precedence above.
The Scope value specifies the possible source of the variable.
NameTypeScopeDefault ValueOptionalDescription
BINDINGSjava.lang.StringPropertyfalseWebSphere Admin hostname.
ADMIN_PORTjava.lang.StringPropertyfalseWebSphere Admin (SOAP) Port
SOAP_CLIENT_PROPS_PATHjava.lang.StringPropertytruePath to the soap.client.props file to source connection data.
USERNAMEjava.lang.StringPropertytrueAdmin username, if not using soap.client.props because SOAP_CLIENT_PROPS_PATH is not set.
PASSWORDjava.lang.StringPropertytrueAdmin password, if not using soap.client.props because SOAP_CLIENT_PROPS_PATH is not set.
KEY_STORE_PATHjava.lang.StringPropertytrueKey store path, if not using soap.client.props because SOAP_CLIENT_PROPS_PATH is not set.
KEY_STORE_PASSWORDjava.lang.StringPropertytrueKey store password, if not using soap.client.props because SOAP_CLIENT_PROPS_PATH is not set.
TRUST_STORE_PATHjava.lang.StringPropertytrueTrust store path, if not using soap.client.props because SOAP_CLIENT_PROPS_PATH is not set.
TRUST_STORE_PASSWORDjava.lang.StringPropertytrueTrust store password, if not using soap.client.props because SOAP_CLIENT_PROPS_PATH is not set.
TARGET_MAPPINGSjava.lang.StringPropertyIf this value is set to DEFAULT or is not present, then the application defined by the property file name will be deployed to the application server instance defined in the property file name.falseMap enterprise applications to WebSphere AppServer or Cluster targets
MapWebModToVH or any other IBM supported task optionsjava.lang.StringPropertyfalseSee the example below for task option mappings.

Example Target Mappings

The TARGET_MAPPINGS may be specified with the following syntax:
TARGET_MAPPINGS=earFile1=appServer1 appserver2,earFile2=appServer3 cluster4, ...

This deploys the earFile1 application onto the appServer1 and appserver2 WebSphere Application Servers and
deploys the earFile2 application onto the appServer3 WebSphere Application Server and the and cluster4 cluster.

Example Application Task Options

The following example demonstrates the MapWebModToVH mapping. However any other supported IBM WebSphere application task options are also supported.
Please see: IBM Documentation for additional task options.
                     			MapWebModToVH=[[Petstore Web Application, rapiddeploy-test-war-3.0.3-SNAPSHOT.war,WEB-INF/web.xml, DEFAULTServer]]
                     			

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
APPDEPL_PRECOMPILE_JSP java.lang.Boolean false true Please see WebSphere specific documentation for the meaning of this AppDeploy option.
APPDEPL_RELOADENABLED java.lang.Boolean   true Please see WebSphere specific documentation for the meaning of this AppDeploy option.
APPDEPL_RELOADINTERVAL java.lang.String   true Please see WebSphere specific documentation for the meaning of this AppDeploy option.
APPDEPL_USE_BINARY_CONFIG java.lang.Boolean false true Please see WebSphere specific documentation for the meaning of this AppDeploy option.
APPDEPL_VALIDATE_APP java.lang.Boolean false true Please see WebSphere specific documentation for the meaning of this AppDeploy option.
APPDEPL_WEB_CONTEXTROOT java.lang.String   true Please see WebSphere specific documentation for the meaning of this AppDeploy option.
APPDEPL_WEBMODULE_CONTEXTROOT java.lang.String   true Please see WebSphere specific documentation for the meaning of this AppDeploy option.
deployAll java.lang.Boolean false true If set to true, this will deploy all ear files defined in the properties file to all targets.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

DmgrChangeOwnerTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.DmgrChangeOwnerTask
Category IBM WebSphere 8

Deployment Manager Change Owner Task.

Description

Change the ownership (recursively) of the files in a WebSphere dmgr profile.

Restrictions

Task only available if you are the root user on a Unix OS.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
cellID java.lang.String   true cellID, profileLocation, dmgrProfile - These three values can be used to determine the profile location. However, the profile location will have been determined by the run IIP task which will typically have been run earlier in the orchestration.
directoryName java.lang.String   true The top level directory to to set ownership of. If not provided, the property installPath will be used (for the base install).
dmgrProfile java.lang.String   true cellID, profileLocation, dmgrProfile - These three values can be used to determine the profile location. However, the profile location will have been determined by the runIIP task which will typically have been run earlier in the orchestration.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
newOwner java.lang.String wasadmin:dev false owner:group to set ownership to.!line If not set then the userId, as set by the Initialization task, will be used.
profileLocation java.lang.String   true cellID, profileLocation, dmgrProfile - These three values can be used to determine the profile location. However, the profile location will have been determined by the run IIP task which will typically have been run earlier in the orchestration.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

EarExpanderWebSphereTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.EarExpanderWebSphereTask
Category IBM WebSphere 8

Ear Expander WebSphere Task.

Sets: operationDir

Description

Java based task that expands/collapses an ear file into/from a temporary location. Any war files held within the ear will also be expanded/collapsed, to facilitate other tasks such as search/replace.

Restrictions

WebSphere specific EarExpander utility. This task may only be used for WebSphere deployments.

Usage

This task will typically be used in groups of two instances of this task. Firstly in expand mode and then in collapse mode. Other tasks will be used in-between these two tasks that work on the expanded ear file. These intermediate tasks must support operationDir, the location of the expanded ear file.
.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
earExpanderPath java.lang.String @@earExpanderPath@@ false Absolute path to the 'EAR expander' command in the target server including its extension: sh or bat, e.g. ${WAS_DM_HOME}/bin/EARExpander.sh
earFileRelativePath java.lang.String j2ee/DefaultApplication.ear false Relative path to the EAR file in the archive. If this is not specified it will be determined from the application name passed in to orchestration. The first matching file will be used.
expansionFlags java.util.List war true Optional expansion flag. One of: [war, all]. Defaults to war if not set. Determines whether to expand war or all files residing inside the ear file.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
operation java.util.List expand false One of: expand, collapse.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
temporaryDirectory java.lang.String   true The temporary directory to store the expanded EAR in. Defaults to the system defined temporary directory (/tmp or /var/tmp on unix/linux). This value may be left blank in most cases.


Back to Top

FederateNodeTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.FederateNodeTask
Category IBM WebSphere 8

Federate Node Profile Task.

Description

This task is WebSphere specific. This task will federate the newly created node profile with its Deployment Manager.

Task Entries

This task is able to handle Environment Variables that you can specify as a task entries with type "VARIABLE"

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
adminPassword java.lang.String   true Admin user password.
adminUserName java.lang.String   true Admin user to be created for this cell (dmgr and node profile).
cellID java.lang.String   true Id of the cell (dmgr and node profile).
dmgrHost java.lang.String   true The deployment manager hostname or ip address (Required for node profile only).
dmgrPort java.lang.String   true The deployment manager (SOAP) port (Required for node profile only).
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
hostName java.lang.String   true hostname (dmgr and node profile).
profileLocation java.lang.String   true Path to the created profile. If set to "default" or if cellID is unset, uses the WAS_HOME/profiles location. For example: installPath/../cellID
profilePath java.lang.String   true Full path to the profile. Typically, leave unset as it will be generated from the profileLocation and the profileName.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
startingPort java.lang.String   true Starting port for this profiles port range (dmgr and node profile).
userID java.lang.String   true The user Id to run the task under. This ID is valid if the user running the task is root on Linux/Unix.


Back to Top

IbmWebsphereBaseInstallTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.was.IbmWebsphereBaseInstallTask
Category IBM WebSphere 8

IBM WebSphere Base Install Task

Description

Installs WebSphere Base AS products using a IIP package.

Usage

This project must contain the file created using IBM Installation Factory and its location must be set in the [projectRelativePathToPackage] option. The scope of all the resources can be either a parameter or a resource.

Task Entries

This task is able to handle Environment Variables that you can specify as a task entries with type "VARIABLE"

Resources/Parameter

The following resources/parameters may be set on this task:
Only a sub-set of available options are displayed here in this help.
For a full list of command options please look at the IBM Info Center website.

Table of task Resources

Name Type Default Value Optional Description
adminPassword java.lang.String   true Specify the password for the administrative security user ID specified by adminUserName.
adminUserName java.lang.String   true Specify the user ID that is used for administrative security.
cellName java.lang.String   true Specifies the cell name of the profile. Use a unique cell name for each profile. Use a unique name even though you plan to federate the custom profile or standalone profile into a deployment manager cell. Federation requires unique cell names before it can make the node part of the deployment manager cell. A cell name must be unique in any circumstance in which the product is running on the same physical machine or cluster of machines, such as a sysplex. Additionally, a cell name must be unique in any circumstance in which network connectivity between entities is required either between the cells or from a client that must communicate with each of the cells. Cell names must also be unique if their namespaces are federated. Otherwise, you might encounter symptoms such as a javax.naming.NameNotFoundException error, in which case, create uniquely named cells.
enableAdminSecurity java.lang.String   true Enables administrative security. Valid values include true or false. The default value is false. When enableAdminSecurity is set to true, you must also specify the parameters adminUserName and adminPassword along with the values for these parameters. You cannot use the enableAdminSecurity parameter to enable administrative security for a custom profile. For security to be enabled for a custom profile, the custom profile must be federated into a deployment manager. Administrative security enabled for the deployment manager is required to enable security for the federated custom profile.
failOnError java.lang.Boolean false false This task will not fail the deployment on error if set to false. This scope is resource only.
hostName java.lang.String   true Specifies the host name where you are creating the profile. This should match the host name that you specified during installation of the initial product. The default value for this parameter is the long form of the domain name system. The value for this parameter must be a valid IPv6 host name and must not contain spaces or any characters that are not valid such as the following: *, ?, ", <, >, ,, /, \, |, and so on.
installPath java.lang.String   false The path to the binary installation.
nodeName java.lang.String   true Specifies the node name for the node that is created with the new profile. Use a unique value within the cell or on the machine. Each profile that shares the same set of product binaries must have a unique node name.
profileName java.lang.String   true Specifies the name of the profile. Use a unique value when creating a profile. Each profile that shares the same set of product binaries must have a unique name. The default profile name is based on the profile type and a trailing number, for example: profile_type_profile_number where profile_type is a value such as AppSrv, Dmgr, AdminAgent, JobMgr, or Custom profile_number is a sequential number that creates a unique profile name
profilePath java.lang.String   true Specifies the fully qualified path to the profile, which is referred to as the profile_root. Specify the full path to avoid an Ant scripting limitation that can cause a failure when federating the profile into a cell. For example, the default is: WS_WSPROFILE_DEFAULT_PROFILE_HOME/profileName. The WS_WSPROFILE_DEFAULT_PROFILE_HOME element is defined in the wasprofile.properties file in the app_server_root/properties directory. The value for this parameter must be a valid path for the target system and must not be currently in use. [AIX Solaris HP-UX Linux Windows] You must have permissions to write to the directory. [IBM i] The QEJBSVR profile must have permissions to write to the directory.
profileType java.lang.String standAlone true Possible values are standAlone, management or none.
serverName java.lang.String   true Specifies the server name for the node that is created with the new profile.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
startingPort java.lang.Integer   true Specifies the starting port number for generating and assigning all ports for the profile. [AIX Solaris HP-UX Linux Windows] Port values are assigned sequentially from the startingPort value, omitting those ports that are already in use. The system recognizes and resolves ports that are currently in use and determines the port assignments to avoid port conflicts. [IBM i] Port values are assigned sequentially from the startingPort value. Do not use this parameter with the defaultPorts or portsFile parameters. During profile creation, the manageprofiles command uses an automatically generated set of recommended ports if you do not specify the startingPort parameter, the defaultPorts parameter or the portsFile parameter. The recommended port values can be different than the default port values based on the availability of the default ports. Attention: Do not use this parameter if you are using the managed profile template.
userID java.lang.String   true The user who is used to run this task.


Back to Top

IbmWebsphereManageProfileTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.was.IbmWebsphereManageProfileTask
Category IBM WebSphere 8

IBM WebSphere Manage Profile Task

Description

Use the manageprofiles command to create, delete, augment, back up, and restore profiles, which define runtime environments. Using profiles instead of multiple product installations saves disk space and simplifies updating the product because a single set of core product files is maintained.

Task Entries

This task is able to handle Environment Variables that you can specify as a task entries with type "VARIABLE"

Resources/Parameter

The following resources/parameters may be set on this task:
Only a sub-set of available options are displayed here in this help.
For a full list of command options please look at the IBM Info Center website: managing profiles

Table of task Resources

Name Type Default Value Optional Description
adminPassword java.lang.String   true Specify the password for the administrative security user ID specified by adminUserName.
adminUserName java.lang.String   true Specify the user ID that is used for administrative security.
cellName java.lang.String   true Specifies the cell name of the profile. Use a unique cell name for each profile. Use a unique name even though you plan to federate the custom profile or standalone profile into a deployment manager cell. Federation requires unique cell names before it can make the node part of the deployment manager cell. A cell name must be unique in any circumstance in which the product is running on the same physical machine or cluster of machines, such as a sysplex. Additionally, a cell name must be unique in any circumstance in which network connectivity between entities is required either between the cells or from a client that must communicate with each of the cells. Cell names must also be unique if their namespaces are federated. Otherwise, you might encounter symptoms such as a javax.naming.NameNotFoundException error, in which case, create uniquely named cells.
enableAdminSecurity java.lang.String   true Enables administrative security. Valid values include true or false. The default value is false. When enableAdminSecurity is set to true, you must also specify the parameters adminUserName and adminPassword along with the values for these parameters. You cannot use the enableAdminSecurity parameter to enable administrative security for a custom profile. For security to be enabled for a custom profile, the custom profile must be federated into a deployment manager. Administrative security enabled for the deployment manager is required to enable security for the federated custom profile.
failOnError java.lang.Boolean false false This task will not fail the deployment on error if set to false. This scope is resource only.
hostName java.lang.String   true Specifies the host name where you are creating the profile. This should match the host name that you specified during installation of the initial product. The default value for this parameter is the long form of the domain name system. The value for this parameter must be a valid IPv6 host name and must not contain spaces or any characters that are not valid such as the following: *, ?, ", <, >, ,, /, \, |, and so on.
installPath java.lang.String   false Fully qualified path to the WebSphere installation directory. This path should contain /bin/manageprofiles.sh or /bin/manageprofiles.bat.
manageProfileAction java.lang.String   false Specifies the action the manage profile command will execute. Possible values are: create, delete, augment, unaugment, unaugmentAll, deleteAll, listProfiles, listAugments, getName, getPath, validateRegistry, validateAndUpdateRegistry, getDefaultName, setDefaultName, backupProfile, restoreProfile, response
nodeName java.lang.String   true Specifies the node name for the node that is created with the new profile. Use a unique value within the cell or on the machine. Each profile that shares the same set of product binaries must have a unique node name.
profileName java.lang.String   true Specifies the name of the profile. Use a unique value when creating a profile. Each profile that shares the same set of product binaries must have a unique name. The default profile name is based on the profile type and a trailing number, for example: profile_type_profile_number where profile_type is a value such as AppSrv, Dmgr, AdminAgent, JobMgr, or Custom profile_number is a sequential number that creates a unique profile name
profilePath java.lang.String   true Specifies the fully qualified path to the profile, which is referred to as the profile_root. Specify the full path to avoid an Ant scripting limitation that can cause a failure when federating the profile into a cell. For example, the default is: WS_WSPROFILE_DEFAULT_PROFILE_HOME/profileName. The WS_WSPROFILE_DEFAULT_PROFILE_HOME element is defined in the wasprofile.properties file in the app_server_root/properties directory. The value for this parameter must be a valid path for the target system and must not be currently in use. [AIX Solaris HP-UX Linux Windows] You must have permissions to write to the directory. [IBM i] The QEJBSVR profile must have permissions to write to the directory.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
startingPort java.lang.Integer   true Specifies the starting port number for generating and assigning all ports for the profile. [AIX Solaris HP-UX Linux Windows] Port values are assigned sequentially from the startingPort value, omitting those ports that are already in use. The system recognizes and resolves ports that are currently in use and determines the port assignments to avoid port conflicts. [IBM i] Port values are assigned sequentially from the startingPort value. Do not use this parameter with the defaultPorts or portsFile parameters. During profile creation, the manageprofiles command uses an automatically generated set of recommended ports if you do not specify the startingPort parameter, the defaultPorts parameter or the portsFile parameter. The recommended port values can be different than the default port values based on the availability of the default ports. Attention: Do not use this parameter if you are using the managed profile template.
templatePath java.lang.String   true Specifies the directory path to the template files in the installation root directory. Within the profileTemplates directory are various directories that correspond to different profile types and that vary with the type of product installed. The profile directories are the paths that you indicate while using the templatePath option. You can specify profile templates that lie outside the installation root, if you happen to have any. [AIX Solaris HP-UX Linux Windows] You can specify a relative path for the -templatePath parameter if the profile templates are relative to theapp_server_root/profileTemplates directory. Otherwise, specify the fully qualified template path. [IBM i] The default template path is app_server_root/profileTemplates/default. You can use a relative path for the -templatePath parameter. The path is relative to the current working directory or to app_server_root/profileTemplates, in that order.
userID java.lang.String   true The user who is used to run this task.


Back to Top

IsServerInstalledTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.IsServerInstalledTask
Category IBM WebSphere 8

Check if the server is already installed. If this is an install (not an uninstall), and a poroduct is detected, this task will throw an error halting the deployment.

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installPath java.lang.String   false The path to the binary installation.
installType java.lang.String installNew false This setting defines which file extension should be used to load the properties from the deployment archive
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
userID java.lang.String   true The user who is used to run this task.


Back to Top

ModifyHeapTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.ModifyHeapTask
Category IBM WebSphere 8

Modify Heap Task.

Description

Modify the JVM Heap sixe of a Dmgr or Nodeagent server.

Task Entries

This task is able to handle Environment Variables that you can specify as a task entries with type "VARIABLE"

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
nodeName java.lang.String cellID + nodeSuffix true Node name.
profilePath java.lang.String   true Full path to the profile. Typically, leave unset as it will be generated from the profileLocation and the profileName.
serverName java.lang.String dmgr false The server to apply the heap changes to.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
tmpPath java.lang.String   true Directory to store temporary files. Leave this blank to use default /tmp path
Xms java.lang.String 256 false The Minimum Heap Size, in Mb.
Xmx java.lang.String 1024 false The Maximum Heap Size, in Mb.


Back to Top

NifEnhancerTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.NifEnhancerTask
Category IBM WebSphere 8

Nif Enhancer Task.

Description

Update theNif Registry on the target server.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installPath java.lang.String   false The path to the binary installation.
installType java.util.List installNew true Valid options are installNew for base nif, installEJB3 for EJB3 nif and installWEBSV for WEBSVNif.
NIFrequired java.lang.Boolean false true Check if NIF is required.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

NodeChangeOwnerTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.NodeChangeOwnerTask
Category IBM WebSphere 8

Node Change Owner Task.

Description

Change the ownership (recursively) of the files in a WebSphere node profile.

Restrictions

Task only available if you are the root user on a Unix OS.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
cellID java.lang.String   true cellID, profileLocation, dmgrProfile - These three values can be used to determine the profile location. However, the profile location will have been determined by the run IIP task which will typically have been run earlier in the orchestration.
directoryName java.lang.String   false the top directory to to set ownership of
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
newOwner java.lang.String wasadmin:dev false owner:group to set ownership to.
nodeProfile java.lang.String   true cellID, profileLocation, nodeProfile - These three values can be used to determine the profile location. However, the profile location will have been determined by the runIIP task which will typically have been run earlier in the orchestration.
profileLocation java.lang.String   true cellID, profileLocation, dmgrProfile - These three values can be used to determine the profile location. However, the profile location will have been determined by the run IIP task which will typically have been run earlier in the orchestration.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

RemoveNodeTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.RemoveNodeTask
Category IBM WebSphere 8

Remove Node Task.

Description

Uninstall the profiles under the target installPath.

Task Entries

This task is able to handle Environment Variables that you can specify as a task entries with type "VARIABLE"

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installPath java.lang.String   false The path to the binary installation.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
userID java.lang.String   true The user who is used to run this task.


Back to Top

RestoreTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.RestoreTask
Category IBM WebSphere 8

This task will restore a list of files/directories previously backed up by the ConditionalBackupTask if a previous backup was not run, or it was not required, then this task will do nothing.

Table of task Resources

Name Type Default Value Optional Description
backupLocation java.lang.String   true The temporary location to use for backing up the files to, defaults to platform dependent temporary directory. /tmp on Unix/Linux.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
restoreRequired java.lang.Boolean false true Set to true if restore is required
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

RunIIPTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.RunIIPTask
Category IBM WebSphere 8

Run the IBM InstallFactory Image installation program.

Description

Task to create IBM WebSphere network deployment installations and optionally create dmgr or nodeagent profiles from this image.

Restrictions

This task requires that the following resource is set on the initialisation task:
installType - Choose base install or update [installNew|update]

Parameters and properties

The full profile path will be profileLocation/dmgrProfile for a dmgr or profileLocation/NodeProfile for a nodeagent.
dmgrProfile and NodeProfile are set as resources (see below), and default to "DeploymentManager" and "AppServer" respectively.
profileLocation defaults to installPath/../cellID (see above).

Example (profile path)

                     			The installPath is /usr/websphere7/ndbase70 
The cellID is wascell01
The dmgrProfile is DeploymentManager
The NodeProfile is AppServer
The dmgr profile path will be: /usr/websphere7/wascell01/DeploymentManager
The node profile will be : /usr/websphere7/wascell01/AppServer
The ndbase binary install is : /usr/websphere7/ndbase70

Task Entries

This task is able to handle Environment Variables that you can specify as a task entries with type "VARIABLE"

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
adminPassword java.lang.String   true Admin user password.
adminUserName java.lang.String   true Admin user to be created for this cell (dmgr and node profile).
cellID java.lang.String   true Id of the cell (dmgr and node profile).
cellSuffix java.lang.String Network true Use the CellID and append this to the Cell Name [dmgr only]
dmgrHost java.lang.String   true The deployment manager hostname or ip address (Required for node profile only).
dmgrPort java.lang.String   true The deployment manager (SOAP) port (Required for node profile only).
dmgrProfile java.lang.String DeploymentManager true Store the profile in this subdirectory [dmgr only]
dmgrSuffix java.lang.String _dm true The Dmgr Suffix
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
features java.util.List NONE false The extras to install [NONE|EJB3|WEBSV|WEBSVEJB3] can be specified here or can be specified as a parameter, instead of a resource.
hostName java.lang.String   true hostname (dmgr and node profile).
iipOptionSetPrefix java.lang.String   true A WebSphere version number, for example 6.1.0, 7.0.0 etc.
installPath java.lang.String   false The path to the binary installation.
installType java.util.List installNew true Valid options are installNew and uninstall.
NodeProfile java.lang.String AppServer true Store the profile in this subdirectory [Node only]
nodeSuffix java.lang.String Manager true The Node name suffix
profileLocation java.lang.String   true Path to the created profile. If set to "default" or if cellID is unset, uses the WAS_HOME/profiles location.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
startingPort java.lang.String   true Starting port for this profiles port range (dmgr and node profile).
type java.lang.String dmgr false The type of profile [dmgr or node].
userID java.lang.String   true The user who is used to run this task.


Back to Top

SecureSoapPropsTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.SecureSoapProps
Category IBM WebSphere 8

Secure SOAP Properties Task.

Description

Update the soap.client.props file with required changes.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
adminPassword java.lang.String   true Admin user password.
adminUserName java.lang.String   true Admin user to be created for this cell (dmgr and node profile).
exposePassword java.lang.Boolean false true Expose the password. If this is set to false, the password will be xor encrypted in the soap.client.props. If true or unset, the password will be in clear text.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installPath java.lang.String   false The path to the binary installation.
profilePath java.lang.String   true Full path to the profile.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
soapTimeOut java.lang.String 600 false The Soap Connection Timeout in Seconds. This is generally set to 600 seconds as the default 180 seconds is often insufficient for larger deployments.
userID java.lang.String   true The user who is used to run this task.
Xmx java.lang.String 1024 false The Maximum Heap Size, in Mb.


Back to Top

Snapshot WAS Server

Class Name com.midvision.rapiddeploy.orchestration.tasks.was.SnapshotTask
Category IBM WebSphere 8

Create a snapshot of a WebSphere Application Server

Description

This task creates a snapshot file of a WebSphere Application Server instance using the WebSphere JMX admin client via a SOAP connection.

Usage

By default the snapshot file will be saved in the RapidDeploy server in the location specified in the field 'Snapshots Path' of the environment configuration panel. If you want to use a different location (not recommended) you can set it using the 'snapshotDirectory' resource.
If you select to save the snapshot file in the target server ('saveOnTarget') you need to specify the 'snapshotDirectory' resource with the location in the target server where you want to save the snapshot file.

IMPORTANT

There are 2 very important requirements to use this task:
  • An IBM 1.8 JRE must be used for the deployment (even if the target WebSphere is using a different version JRE). This means the remote agent must be running using this JRE or you need to set a proper JRE in the server panel under the "Java Settings" section of the transport plugin.
  • The following JAR files must be included in the classpath of the project:
  • com.ibm.ws.admin.client_X.Y.Z.jar"
    com.ibm.ws.orb_X.Y.Z.jar"
    com.ibm.ws.security.crypto.jar
    com.ibm.ws.emf.jar
    You can find these files in the WebSphere Application server installation folder, and "X.Y.Z" represents the version of the software.
    Add the files to the MV_HOME/lib folder and restart RapidDeploy.
    Then navigate to your 'Menu -> Resources -> Projects -> [PROJECT] -> General' tab and in the 'Plugin File Transfer' pick list select these jars from the 'Available Plugin Entries' and copy over to the right-hand side.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
defaultServerTemplates java.lang.String APPLICATION_SERVER, default, PHP_SERVER, phpserver, WASCE_SERVER, wasce, APACHE_SERVER, apache22, TOMCAT_SERVER, tomcat6x, WEBLOGIC_SERVER, weblogic10x, ONDEMAND_ROUTER, http_sip_odr_server, PROXY_SERVER, proxy_server, WEB_SERVER, webserver1, JBOSS_SERVER, jboss, WASAPP_SERVER, was6x, GENERIC_SERVER, default true Default Server Templates to process. This is a list of server templates that will be processed and included in any snapshots taken of this environment. These settings do not normally require changing.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
hostname java.lang.String localhost true The hostname to connect to for JMX operations against the WebSphere cell.
jmxExclusions java.lang.String   true List of WebSphere attribute types to ignore during the JMX snapshot. These values should not normally need changing from their default settings.
keyStorePassword java.lang.String WebAS true The key store password. WebAS by default. Required if WebSphere cell security is enabled.
keyStorePath java.lang.String ${WAS_PROFILE_HOME}/etc/DummyClientKeyFile.jks true The path to the IBM WebSphere client key store file on the RapidDeploy server. This file should contain the necessary key to connect to the target cell. Required if WebSphere cell security is enabled.
password java.lang.String   true The admin password to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
port java.lang.Integer 9080 true The SOAP connection port of the WebSphere process to connect to for JMX operations.
processOrder java.lang.String cells/[.[^/]]+\\|cell\\.xml, cells/[.[^/]]+\\|variables\\.xml, cells/[.[^/]]+\\|resources\\.xml, cells/[.[^/]]+\\|virtualhosts\\.xml, cells/[.[^/]]+\\|resources-.*\\.xml, cells/[.[^/]]+\\|(?!coregroupbridge).*\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+\\|node\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+\\|variables\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+\\|resources\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+\\|resources-.*\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+\\|(?!serverindex).*\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+/servers/dmgr\\|server\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+/servers/dmgr\\|server-.*\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+/servers/dmgr\\|.*\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+/servers/nodeagent\\|server\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+/servers/nodeagent\\|.*\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+/servers/[.[^/]]+\\|server\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+/servers/[.[^/]]+\\|server-.*\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+/servers/[.[^/]]+\\|variables\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+/servers/[.[^/]]+\\|resources\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+/servers/[.[^/]]+\\|resources-.*\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+/servers/[.[^/]]+\\|.*\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+/servers/[.[^/]]+/rules/[.[^/]]+\\|rules\\.xml, cells/[.[^/]]+/clusters/[.[^/]]+\\|cluster\\.xml, cells/[.[^/]]+/clusters/[.[^/]]+\\|resources\\.xml, cells/[.[^/]]+/clusters/[.[^/]]+\\|resources-.*\\.xml, cells/[.[^/]]+/clusters/[.[^/]]+\\|(?!serverindex).*\\.xml, cells/[.[^/]]+/dynamicclusters/[.[^/]]+\\|dynamiccluster\\.xml, cells/[.[^/]]+/dynamicclusters/[.[^/]]+\\|(?!serverindex).*\\.xml, cells/[.[^/]]+/dynamicclusters/[.[^/]]+/servers/[.[^/]]+\\|server\\.xml, cells/[.[^/]]+/dynamicclusters/[.[^/]]+/servers/[.[^/]]+\\|server-.*\\.xml, cells/[.[^/]]+/dynamicclusters/[.[^/]]+/servers/[.[^/]]+\\|variables\\.xml, cells/[.[^/]]+/dynamicclusters/[.[^/]]+/servers/[.[^/]]+\\|resources\\.xml, cells/[.[^/]]+/dynamicclusters/[.[^/]]+/servers/[.[^/]]+\\|resources-.*\\.xml, cells/[.[^/]]+/dynamicclusters/[.[^/]]+/servers/[.[^/]]+\\|.*\\.xml, cells/[.[^/]]+/serviceclasses/[.[^/]]+\\|serviceclass\\.xml, cells/[.[^/]]+/middlewaredescriptors/[.[^/]]+\\|middlewaredescriptor\\.xml, cells/[.[^/]]+/healthclasses/[.[^/]]+\\|healthclass\\.xml, cells/[.[^/]]+/nodegroups/[.[^/]]+\\|nodegroup\\.xml, cells/[.[^/]]+/coregroups/[.[^/]]+\\|coregroup\\.xml, cells/[.[^/]]+\\|coregroupbridge\\.xml, cells/[.[^/]]+/nodes/[.[^/]]+\\|serverindex\\.xml, cells/[.[^/]]+/clusters/[.[^/]]+\\|serverindex\\.xml, cells/[.[^/]]+/dynamicclusters/[.[^/]]+\\|serverindex\\.xml, cells/[.[^/]]+/applications/[.[^/]]+/deployments/[.[^/]]+\\|deployment\\.xml, cells/[.[^/]]+/applications/[.[^/]]+/deployments/[.[^/]]+/workclasses/[.[^/]]+\\|workclass\\.xml, cells/.*\\.xml true The order in which WebSphere JMX type attributes are processed. Each regular expression is delimited using a comma followed by a space (, ). These settings do not normally require changing.
rapiddeployUrl java.lang.String   true The URL of the RapidDeploy server that performs the call to the target server. This URL needs to be complete, including port and context path, e.g.: http://localhost:8080/MidVision. This resource is used to send back the snapshot file to the host server running the RapidDeploy web application. It does NOT need to be set in most cases.
saveOnTarget java.lang.Boolean false true If set to 'true' the snapshot file will be saved in the target server and not sent back to the RapidDeploy server. This option is not recommended as RapidDeploy can not keep track of the snapshots taken and the snapshot comparison feature can not be used.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
snapshotDirectory java.lang.String   true The directory location where the snapshots should be stored. This option should be used only when 'saveOnTarget' is set to 'true' or if you want to set a specific snapshot location on the RapidDeploy server (not recommended).
trustStorePassword java.lang.String WebAS true The trust store password. "WebAS" by default. Required if WebSphere cell security is enabled.
trustStorePath java.lang.String ${WAS_PROFILE_HOME}/etc/DummyClientTrustFile.jks true The path to the IBM WebSphere client trust store file on the RapidDeploy server. This file should contain the necessary trusts to connect to the target cell. Required if WebSphere cell security is enabled.
username java.lang.String   true The admin username to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.


Back to Top

StartWASserversTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.StartWASserversTask
Category IBM WebSphere 8

Start WebSphere Servers Task.

Description

This task is WebSphere specific. This task will locate all running servers (dmgr, nodeagent, AppServer) that are associated with the specified base install. The specified type will be started.

Task Entries

This task is able to handle Environment Variables that you can specify as a task entries with type "VARIABLE"

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
cellID java.lang.String   true Id of the cell (dmgr and node profile).
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installPath java.lang.String   false The path to the binary installation.
profileLocation java.lang.String   true Path to the created profile. If set to "default" or if cellID is unset, uses the WAS_HOME/profiles location. For example: installPath/../cellID
profilePath java.lang.String   true Full path to the profile. Typically, leave unset as it will be generated from the profileLocation and the profileName.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
type java.lang.String all false The 'type' of servers to stop a list (any separator) of dmgr, node, appserver (any combination) the default is all server types
userID java.lang.String   true The user Id to run the task under. This ID is valid if the user running the task is root on Linux/Unix.


Back to Top

StopWASserversTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.StopWASserversTask
Category IBM WebSphere 8

Stop WebSphere Servers Task.

Description

This task is WebSphere specific. This task will locate all running servers (dmgr, nodeagent, AppServer) that are associated with the specified base install. The specified type will be stopped.

Task Entries

This task is able to handle Environment Variables that you can specify as a task entries with type "VARIABLE"

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
cellID java.lang.String   true Id of the cell (dmgr and node profile).
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installPath java.lang.String   false The path to the binary installation.
profileLocation java.lang.String   true Path to the created profile. If set to "default" or if cellID is unset, uses the WAS_HOME/profiles location. For example: installPath/../cellID
profilePath java.lang.String   true Full path to the profile. Typically, leave unset as it will be generated from the profileLocation and the profileName.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
type java.lang.String all false The 'type' of servers to stop a list (any separator) of dmgr, node, appserver (any combination) the default is all server types
userID java.lang.String   true The user Id to run the task under. This ID is valid if the user running the task is root on Linux/Unix.


Back to Top

UninstallWASTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.UninstallWASTask
Category IBM WebSphere 8

Uninstall WebSphere Task.

Description

Uninstall the target WebSphere server.

Task Entries

This task is able to handle Environment Variables that you can specify as a task entries with type "VARIABLE"

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installID java.lang.String   true The install ID. Typically this will match the related WebSphere Cell.
installPath java.lang.String   false The path to the binary installation.
overrideUser java.lang.Boolean false true Override the default user id.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
tmpPath java.lang.String   true Directory to store temporary files. Leave this blank to use default /tmp path
userID java.lang.String   true The user who is used to run this task.


Back to Top

WebSphereClusterStateChangeTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.WebSphereClusterStateChangeTask
Category IBM WebSphere 8

WebSphere Cluster stop/start Task.

Description

This task changes the state (stops/starts) a WebSphere cluster. Profiles are overridden as follows:
1) profile_defaults.py (pyScriptsDefaultProfileRelativePath), the site wide default profile, overridden by
2) project.py (pyScriptsProjectProfileRelativePath), project wide profile, overridden by
3) server.environment.instance.application.py, cell wide application centric profile, overridden by
4) install resources boolean flags set in this task e.g. installJMS=true

Parameters and properties

The following optional properties will be taken from Environment Configuration panel (Resources -> Targets -> Environments) These will be sourced in order of the precedence above.
The Scope value specifies the possible source of the variable.
NameTypeScopeDefault ValueOptionalDescription
usernamejava.lang.StringParameter|Property|ResourcetrueUsername to connect to WebSphere via wsadmin (if not set in soap.client.props).
passwordjava.lang.StringParameter|Property|ResourcetruePassword to connect to WebSphere via wsadmin (if not set in soap.client.props).
conntypejava.lang.StringParameter|Property|ResourcetrueOne of [RMI|SOAP].
hostjava.lang.StringParameter|Property|ResourcetrueHost to connect to.
portjava.lang.StringParameter|Property|ResourcetrueScripting Port (SOAP or RMI).

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
cellName java.lang.String   false The name of the cell with the cluster to which this task will perform the "operation".
clusterName java.lang.String   false The name of the cluster to which this task will perform the "operation".
conntype java.lang.String @@conntype@@ true Specifies the type of connection to use when deploying to this target. Possible values are: LOCAL, SOAP, RMI, JSR160RMI or IPC. 'LOCAL' means the connection is made locall so no remote connection parameters will be used.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
hostname java.lang.String @@hostname@@ true The hostname to connect to for deployment operations against the WebSphere cell.
nodeName java.lang.String   false The name of the node with the cluster to which this task will perform the "operation".
operation java.util.List stop false Valid values: stop, start
password java.lang.String @@password@@ true The admin password to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
port java.lang.String @@port@@ true The connection port of the WebSphere process to connect to for deployment operations. This port will vary depending on the connection type.
pyScriptsDefaultProfileRelativePath java.lang.String   true Path relative to archive root to site wide properties file.
pyScriptsFunctionRelativePath java.lang.String   true Path relative to archive root to generic WAS functions file.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ true The admin username to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
wasDmHome java.lang.String @@wasDmHome@@ false The absolute path to the deployment manager profile home in the target server. This parameter must be set in order for this task to work.
wsadminPath java.lang.String @@wsadminPath@@ true The absolute path to the wsadmin scripting tool including the extension (.sh or .bat) in the target server. If this is not set @@wasDmHome@@/bin/wsadmin.sh or @@wasDmHome@@/bin/wsadmin.bat will be used.


Back to Top

WebSphereConfigPropertiesExportTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.was.WebSphereConfigPropertiesExportTask
Category IBM WebSphere 8

WebSphere Config Properties Export Task.

Description

WebSphere Export task that exports WebSphere configuration to a properties file.

Parameters and properties

The following optional properties will be taken from Environment Configuration panel (Resources -> Targets -> Environments) These will be sourced in order of the precedence above.
The Scope value specifies the possible source of the variable.
NameTypeScopeDefault ValueOptionalDescription
usernamejava.lang.StringParameter|Property|ResourcetrueUsername to connect to WebSphere via wsadmin (if not set in soap.client.props).
passwordjava.lang.StringParameter|Property|ResourcetruePassword to connect to WebSphere via wsadmin (if not set in soap.client.props).
conntypejava.lang.StringParameter|Property|ResourcetrueOne of [RMI|SOAP].
hostjava.lang.StringParameter|Property|ResourcetrueHost to connect to.
portjava.lang.StringParameter|Property|ResourcetrueScripting Port (SOAP or RMI).

Examples

The following are example values for some task resources:
Resource NameExampleScopeDescription
configDataServer=DEFAULTServerServerExport the server definition and all sub entries for DEFAULTServer.
configDataJDBCProvider=applicationXAdsJDBCProviderExport the JDBCProvider definition and all sub entries for applicationXAds.
configDataServerCluster=DEFAULTServerClusterExport the cluster definition and all sub entries for DEFAULTServer.
options[[GenerateTemplates true][PortablePropertiesFile true]]N/AExport the definition in a portable way as a template. Setting GenerateTemplates to true means extracted properties, when applied to a new environment, will create any resources that are not already present. Setting PortablePropertiesFile to true means that configuration properties extracted from one environment can be deployed to another one.

Please see: IBM Documentation for additional options.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
configData java.lang.String Server=DEFAULTServer false The configuration data scope to export.
conntype java.lang.String @@conntype@@ true Specifies the type of connection to use when deploying to this target. Possible values are: LOCAL, SOAP, RMI, JSR160RMI or IPC. 'LOCAL' means the connection is made locall so no remote connection parameters will be used.
debug java.lang.Boolean true true Debug logging is switched on when set to true.
exportFile java.lang.String c:/temp/configProps.out false The path to write out the properties file to.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
filterMechanism java.lang.String NO_SUBTYPES false Filter mechanism. Possible values: NO_SUBTYPES, SELECTED_SUBTYPES or NO_SUBTYPES_AND_EXTENSIONS.
hostname java.lang.String @@hostname@@ true The hostname to connect to for deployment operations against the WebSphere cell.
options java.lang.String [[GenerateTemplates true][PortablePropertiesFile true]] false Additional options to use. THESE VALUES SHOULD NOT NORMALLY BE CHANGED.
password java.lang.String @@password@@ true The admin password to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
port java.lang.String @@port@@ true The connection port of the WebSphere process to connect to for deployment operations. This port will vary depending on the connection type.
pyScriptsFunctionRelativePath java.lang.String   true Path relative to archive root to WAS functions file. THIS VALUE SHOULD NOT NORMALLY BE CHANGED.
selectedSubTypes java.lang.String   true Sub-types to set.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ true The admin username to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
wsadminPath java.lang.String @@wsadminPath@@ false The absolute path to the wsadmin scripting tool including the extension (.sh or .bat) in the target server, e.g. ${WAS_DM_HOME}/bin/wsadmin.sh


Back to Top

WebSphereConfigPropertiesImportTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.was.WebSphereConfigPropertiesImportTask
Category IBM WebSphere 8

WebSphere Config Properties Import Task.

Description

WebSphere Import task that imports WebSphere configuration to a cell from a properties file.

Parameters and properties

The following optional properties will be taken from Environment Configuration panel (Resources -> Targets -> Environments) These will be sourced in order of the precedence above.
The Scope value specifies the possible source of the variable.
NameTypeScopeDefault ValueOptionalDescription
usernamejava.lang.StringParameter|Property|ResourcetrueUsername to connect to WebSphere via wsadmin (if not set in soap.client.props).
passwordjava.lang.StringParameter|Property|ResourcetruePassword to connect to WebSphere via wsadmin (if not set in soap.client.props).
conntypejava.lang.StringParameter|Property|ResourcetrueOne of [RMI|SOAP].
hostjava.lang.StringParameter|Property|ResourcetrueHost to connect to.
portjava.lang.StringParameter|Property|ResourcetrueScripting Port (SOAP or RMI).

Properties file loading and templates

Absolute Path
You may specify an absolute path to the properties file to import on the target server using only the exportFile resource. Generally, this mechanism should not be used as it is not portable across environments.

Path relative to archiveRoot and data dictionary
You may specify a path relative to the archiveRoot for the exportFile resource by using the ${ARCHIVE_ROOT} built in variable in the path. In this scenario you should use the exportFile as a template, and the environment specific data dictionary to specify environment specific values.

If your target environments will need to use two or more templates (where for example production environments are significantly different from development/test), this can be achieved by using an exportFile resource that is itself a data dictionary item. this data dictionary item can then reference a different template file relative path for each target environment.


Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
conntype java.lang.String @@conntype@@ true Specifies the type of connection to use when deploying to this target. Possible values are: LOCAL, SOAP, RMI, JSR160RMI or IPC. 'LOCAL' means the connection is made locall so no remote connection parameters will be used.
debug java.lang.Boolean true true Debug logging is switched on when set to true.
exportFile java.lang.String c:/temp/configProps.out true The path to read the properties file from.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
hostname java.lang.String @@hostname@@ true The hostname to connect to for deployment operations against the WebSphere cell.
password java.lang.String @@password@@ true The admin password to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
port java.lang.String @@port@@ true The connection port of the WebSphere process to connect to for deployment operations. This port will vary depending on the connection type.
pyScriptsFunctionRelativePath java.lang.String   true Path relative to archive root to WAS functions file. THIS VALUE SHOULD NOT NORMALLY BE CHANGED.
reportFile java.lang.String   true The path to the report file. If left blank, the reportFile will default to a unique filename in the platform dependent temporary directory.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ true The admin username to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
wsadminPath java.lang.String @@wsadminPath@@ false The absolute path to the wsadmin scripting tool including the extension (.sh or .bat) in the target server, e.g. ${WAS_DM_HOME}/bin/wsadmin.sh


Back to Top

WebSphereDeploymentTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.WebSphereDeploymentTask
Category IBM WebSphere 8

WebSphere Deployment Task using Jython.

Description

WebSphere Deployment task that uses the RapidDeploy Jython framework to deploy ear/war files and associated configuration to WebSphere.

Jython configuration

This is the configuration definition to be deployed to the WebSphere cell. It may contain the entire WebSphere cell configuration definition or just a small part of it, such as a cluster, application server, JMS or JDBC definition, or anything in-between.

For in-depth information about this task, see the demo projects or the online documentation.

The Jython configuration is overridden as follows:

1) The Jython framework profile with default values (configurable by the 'pyScriptsDefaultProfileRelativePath' resource), overridden by
2) The project specific profile (configurable by the 'pyScriptsProjectProfileRelativePath' resource), overridden by
3) The content of the 'pyArea' resource.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
conntype java.lang.String @@conntype@@ true Specifies the type of connection to use when deploying to this target. Possible values are: LOCAL, SOAP, RMI, JSR160RMI or IPC. 'LOCAL' means the connection is made locally so no remote connection parameters will be used.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
hostname java.lang.String @@hostname@@ true The hostname to connect to for deployment operations against the WebSphere cell.
installApp java.lang.Boolean false false Install the Application.
installCluster java.lang.Boolean false false Install the Cluster resources.
installJDBC java.lang.Boolean false false Install the Database Resources.
installJMS java.lang.Boolean false false Install the JMS resources.
installNSBinding java.lang.Boolean false false Install the Name Space Binding resources.
installObjectCache java.lang.Boolean false false Install the Object Cache resources.
installReplicationDomain java.lang.Boolean false false Install the Replication Domain resources.
installREProvider java.lang.Boolean false false Install the Resource Environment Provider resources.
installResourceAdapters java.lang.Boolean false false Install the Resource Adapter resources.
installSchedulers java.lang.Boolean false false Install the Schedulers resources.
installServer java.lang.Boolean false false Install the App Server resources.
installSharedLibs java.lang.Boolean false false Install the Shared Libraries resources.
installVirtualHosts java.lang.Boolean false false Install the Virtual Host resources.
installWebServer java.lang.Boolean false false Install the Web Server resources.
installWorkManager java.lang.Boolean false false Install the Work Manager resources.
password java.lang.String @@password@@ true The admin password to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
port java.lang.String @@port@@ true The connection port of the WebSphere process to connect to for deployment operations. This port will vary depending on the connection type.
pyArea TextArea   true Area where all the Jython profile configuration must be additionally to the file specified in the 'pyScriptsProjectProfileRelativePath' resource. Either this resource or the 'pyScriptsProjectProfileRelativePath' must be set.
pyScriptsDefaultProfileRelativePath java.lang.String   true Path relative to archive root to site wide properties file. Leave this blank unless you want to specify your own defaults.
pyScriptsFunctionRelativePath java.lang.String   true Path relative to archive root to generic WAS functions file. Leave this blank unless you want to specify your own functions.
pyScriptsProjectProfileRelativePath java.lang.String   true Path relative to archive root to project wide properties file. Either this resource or the 'pyArea' resource must be set.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ true The admin username to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
wasDmHome java.lang.String @@wasDmHome@@ false The absolute path to the deployment manager profile home in the target server. This parameter must be set in order for this task to work.
wsadminPath java.lang.String @@wsadminPath@@ true The absolute path to the wsadmin scripting tool including the extension (.sh or .bat) in the target server. If this is not set @@wasDmHome@@/bin/wsadmin.sh or @@wasDmHome@@/bin/wsadmin.bat will be used.


Back to Top

Install application

Class Name com.midvision.rapiddeploy.orchestration.tasks.was.jython.InstallAppTask
Category IBM WebSphere 8 - Configuration

WebSphere install application task

Description

This task uses the RapidDeploy Jython framework to deploy a web application (EAR/WAR file) to an application server or cluster in WebSphere Application Server 8. If it exists it is modified.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
app_options TextArea ["-server", "@@serverName@@", "-cluster", "@@clusterName@@", "-cell", "@@cellName@@", "-node", "@@nodeName@@", "-appname", "@@appName@@"] false A Jython syntax list containing all the configuration options for the application. The minimum value should be the configuration shown by default with the dictionary items filled. More information about the different options can be found in the following link: https://www.ibm.com/support/knowledgecenter/SS7JFU_8.5.5/com.ibm.websphere.express.doc/ae/rxml_taskoptions.html#rxml_taskoptions__cmd3
appAutoStart java.lang.Boolean true true Should the enterprise application be auto-started.
appName java.lang.String @@appName@@ false This is the name that will be used for the installed application. It must be unique in the WebSphere cell.
cellName java.lang.String @@cellName@@ false The name of the cell where the application will be deployed.
classloaderForApplication java.util.List PARENT_FIRST true If set to PARENT_FIRST, load the WebSphere classes first. If PARENT_LAST, load the enterprise application classes in preference to the WebSphere classes.
classloaderForWebModules java.util.List PARENT_FIRST true Used as a default. If the web module defines its own classloading policy, this setting is overridden for that module. If set to PARENT_FIRST, load the parent classes first. If PARENT_LAST, load the Web Module classes in preference to the WebSphere classes.
classloaderPolicyForWar java.util.List SINGLE true The class loader policy for WAR modules.
conntype java.lang.String @@conntype@@ true Specifies the type of connection to use when deploying to this target. Possible values are: LOCAL, SOAP, RMI, JSR160RMI or IPC. 'LOCAL' means the connection is made locally so no remote connection parameters will be used.
earLocation java.lang.String   false The absolute path to the EAR or WAR file location. The built-in variable ${ARCHIVE_ROOT} can be used for files stored into the RapidDeploy deployment package.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
hostname java.lang.String @@hostname@@ true The hostname to connect to for deployment operations against the WebSphere cell.
password java.lang.String @@password@@ true The admin password to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
port java.lang.String @@port@@ true The connection port of the WebSphere process to connect to for deployment operations. This port will vary depending on the connection type.
pyArea TextArea   true Area to add all the Jython profile configuration you want to override all other configurations.
serverName java.lang.String   false The name of the application server or cluster where the application will be deployed.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
startingWeightForApplication java.lang.Integer 1 true The higher the number, the later the start. If multiple applications are deployed to the same JVM or cluster, this parameter determines the start order for the applications.
startingWeightForEjbModule java.lang.Integer 5000 true Used as a default. If the EJB module defines its own starting weight, this setting is overridden for that module. Defines the start order of the module in the application. The higher the number, the later the start. Generally web modules start after EJB Modules.
startingWeightForWebModule java.lang.Integer 30000 true Used as a default. If the web module defines its own starting weight, this setting is overridden for that module. Defines the start order of the module in the application. The higher the number, the later the start. Generally web modules start after EJB Modules.
username java.lang.String @@username@@ true The admin username to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
wasDmHome java.lang.String @@wasDmHome@@ false The absolute path to the deployment manager profile home in the target server. This parameter must be set in order for this task to work.
wsadminPath java.lang.String @@wsadminPath@@ true The absolute path to the wsadmin scripting tool including the extension (.sh or .bat) in the target server. If this is not set @@wasDmHome@@/bin/wsadmin.sh or @@wasDmHome@@/bin/wsadmin.bat will be used.


Back to Top

Install cluster

Class Name com.midvision.rapiddeploy.orchestration.tasks.was.jython.InstallClusterTask
Category IBM WebSphere 8 - Configuration

WebSphere install cluster task

Description

This task uses the RapidDeploy Jython framework to create a cluster and a number of cluster members in WebSphere Application Server 8. If it exists it is modified.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
asAcceptHeuristicHazard java.lang.Boolean false true Specifies whether all applications on this server accept the possibility of a heuristic hazard occurring in a two-phase transaction that contains a one-phase resource. This setting configures last participant support (LPS) for the server. Last participant support is an extension to the transaction service that enables a single one-phase resource to participate in a two-phase transaction with one or more two-phase resources.
asORBcommTraceEnabled java.lang.Boolean false true ORB trace enabled.
asORBconnectionCacheMaximum java.lang.Integer 240 true ORB connection cache maximum.
asORBconnectionCacheMinimum java.lang.Integer 100 true ORB connection cache minimum.
asORBforceTunnel java.util.List never true ORB force tunnel.
asORBlocateRequestTimeout java.lang.Integer 180 true ORB locate request timeout.
asORBnoLocalCopies java.lang.Boolean false true ORB no local copies.
asORBrequestRetriesCount java.lang.Integer -1 true ORB request retries count. A value of -1 indicates continually retry.
asORBrequestRetriesDelay java.lang.Integer 0 true ORB request retries delay. The delay between successive retries.
asORBrequestTimeout java.lang.Integer 180 true ORB request timeout.
asORBuseServerThreadPool java.lang.Boolean false true ORB use server thread pool.
asPropogatedOrBMTTranLifetimeTimeout java.lang.Integer 300 true Propagated or BMT transaction lifetime timeout.
asTransactionClientInactivityTimeout java.lang.Integer 60 true Transaction client inactivity timeout.
asTransactionLifetimeTimeout java.lang.Integer 120 true The total time, in seconds, that a transaction may remain active in the server, before it is terminated and/or rolled back.
asTransactionLogDirectory java.lang.String ;4M true Combination of directory and size, separated by a semicolon. The default setting is ;4M, indicating the default transaction log directory, with a transaction log maximum size of 4Mb.
asTSmemoryBufferSize java.lang.Integer 8 true Memory buffer size.
asTSstartupTraceSpecification java.lang.String *=info true Startup trace specification. The default is: *=info
asTStraceFormat java.util.List BASIC true Trace format.
asTStraceOutputType java.util.List SPECIFIED_FILE true Trace output type.
BOOTSTRAP_ADDRESS_port java.lang.Integer 12030 false The BOOTSTRAP_ADDRESS port.
cellName java.lang.String   false The name of the cell where the cluster is created/updated. The cell must exist.
classpath java.lang.String   true The JVM classpath. Separate each path with a system dependent delimiter: Unix(:), Windows(;).
clonesInSpecifiedOrder java.lang.Boolean false true Create cluster members in a specified order. If the 'useSpecifiedClusterNodes' resource is set to 'true', it creates the cluster members on the nodes in the order specified in the 'specifiedNodes' resource list.
clusterCount java.lang.Integer 1 true The number of cluster members to be deployed on each WebSphere node.
clusterHAenable java.lang.Boolean false true HA enable.
clusterName java.lang.String   false The name of the cluster to create or update.
clusterPreferLocal java.lang.Boolean true true Prefer local cluster member.
conntype java.lang.String @@conntype@@ true Specifies the type of connection to use when deploying to this target. Possible values are: LOCAL, SOAP, RMI, JSR160RMI or IPC. 'LOCAL' means the connection is made locally so no remote connection parameters will be used.
createClusterMember java.lang.Boolean true true Should any cluster member be created.
envEntries TextArea [[['name', 'IBM_HEAPDUMP'], ['value', 'true']], [['name', 'IBM_HEAPDUMP_OUTOFMEMORY'], ['value', 'true']], [['name', 'IBM_HEAP_DUMP'], ['value', 'true']], [['name', 'IBM_JAVADUMP_OUTOFMEMORY'], ['value', 'true']], [['name', 'IBM_JAVA_HEAPDUMP_TEXT'], ['value', 'true']], [['name', 'JAVA_DUMP_OPTS'], ['value', 'ONANYSIGNAL(JAVADUMP[5],HEAPDUMP[5])']]] true JVM process definition environment entries, syntax: [[["name", "ENV_ENTRY_NAME_1"], ["value", "ENV_ENTRY_VALUE_1"]],[["name", "ENV_ENTRY_NAME_2"], ["value", "ENV_ENTRY_VALUE_1"]],...] For example: [[['name', 'IBM_HEAPDUMP'], ['value', 'true']], [['name', 'IBM_HEAPDUMP_OUTOFMEMORY'], ['value', 'true']], [['name', 'IBM_HEAP_DUMP'], ['value', 'true']], [['name', 'IBM_JAVADUMP_OUTOFMEMORY'], ['value', 'true']], [['name', 'IBM_JAVA_HEAPDUMP_TEXT'], ['value', 'true']], [['name', 'JAVA_DUMP_OPTS'], ['value', 'ONANYSIGNAL(JAVADUMP[5],HEAPDUMP[5])']]]
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
genericJVMArguments java.lang.String   true Generic JVM arguments. Each argument is separated by a space, and prefixed with -D or -X, for example: -Xminf0.3 -Xmaxf0.6 -Dcom.ibm.ws.security.spnego.isEnabled=false
hostname java.lang.String @@hostname@@ true The hostname to connect to for deployment operations against the WebSphere cell.
installProcDefEnvEntries java.lang.Boolean false true Configure process definition environment entries.
installReplicationDomain java.lang.Boolean false true Should the replication domain be installed.
logRolloverHourErr java.lang.Integer 7 true The hour to first roll the System.err logs.
logRolloverHourOut java.lang.Integer 7 true The hour to first roll the System.out logs.
logRolloverPeriodErr java.lang.Integer 12 true The System.err log will be rolled at this interval following the roll over hour.
logRolloverPeriodOut java.lang.Integer 12 true The System.out log will be rolled at this interval following the roll over hour.
logRolloverSizeErr java.lang.Integer 0 true The System.err log roll over size, expressed in MB. Setting it to 0 means the logs are never rolled over on size.
logRolloverSizeOut java.lang.Integer 0 true The System.out log roll over size, expressed in MB. Setting it to 0 means the logs are never rolled over on size.
logRolloverTypeErr java.util.List TIME true The type of roll over for the System.err logs.
logRolloverTypeOut java.util.List TIME true The type of roll over for the System.out logs.
maxJVMHeapSize java.lang.Integer 512 true JVM maximum heap size, expressed in MB.
maxLogFileCountErr java.lang.Integer 30 true The maximum number of historical log files to keep for the System.err logs. Once this number is exceeded the logs will be overwritten.
maxLogFileCountOut java.lang.Integer 30 true The maximum number of historical log files to keep for the System.out logs. Once this number is exceeded the logs will be overwritten.
minJVMHeapSize java.lang.Integer 128 true JVM minimum heap size, expressed in MB.
nodeLevelReplicationDomain java.lang.Boolean false true If 'true', the replication domain is limited to cluster members on the node. If 'false', the replication domain is set to the cluster.
nodeName java.lang.String   false The name of the primary node. This is the node that a single application server will be created on, or the first member of the cluster will be created on.
nodeRestartState java.util.List running true The state of the cluster when the WebSphere nodeagent is started.
password java.lang.String @@password@@ true The admin password to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
port java.lang.String @@port@@ true The connection port of the WebSphere process to connect to for deployment operations. This port will vary depending on the connection type.
pyArea TextArea   true Area to add all the Jython profile configuration you want to override all other configurations.
replNumberOfReplicas java.lang.Integer 1 true Number of replicas.
replRequestTimeout java.lang.Integer 5 true Request timeout.
replUseSSL java.lang.Boolean false true Use SSL in replication.
SIB_ENDPOINT_ADDRESS_port java.lang.Integer 14030 false The SIB_ENDPOINT_ADDRESS port.
SIB_ENDPOINT_SECURE_ADDRESS_port java.lang.Integer 15030 false The SIB_ENDPOINT_SECURE_ADDRESS port.
SIB_MQ_ENDPOINT_ADDRESS_port java.lang.Integer 16030 false The SIB_MQ_ENDPOINT_ADDRESS port.
SIB_MQ_ENDPOINT_SECURE_ADDRESS_port java.lang.Integer 17030 false The SIB_MQ_ENDPOINT_SECURE_ADDRESS port.
SIP_DEFAULTHOST_port java.lang.Integer 18030 false The SIP_DEFAULTHOST port.
SIP_DEFAULTHOST_SECURE_port java.lang.Integer 19030 false The SIP_DEFAULTHOST_SECURE_port port.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
SOAP_CONNECTOR_ADDRESS_port java.lang.Integer 13030 false The SOAP_CONNECTOR_ADDRESS port.
specifiedNodes TextArea [] true The WebSphere nodes on which to deploy the cluster. This is a (comma separated) list of nodes, enclosed in square brackets. Required if the 'useSpecifiedClusterNodes' resource is set to 'true'. Example value: ["mvhost001", "mvhost002"]
startCluster java.lang.Boolean false true Should the cluster be restarted after a cluster update.
systemProperties TextArea   true JVM system properties, syntax: [[["name", "SYSTEM_PROPERTY_NAME_1"], ["value", "SYSTEM_PROPERTY_VALUE_1"]],[["name", "SYSTEM_PROPERTY_NAME_2"], ["value", "SYSTEM_PROPERTY_VALUE_2"]],...] For example: [[["name", "HotSpotOption"], ["value", "client"]],[["name", "user.timezone"], ["value", "Europe/London"]]]
threadPoolMaxSize java.lang.Integer 50 true The maximum number of available threads in the web container.
threadPoolMinSize java.lang.Integer 10 true The minimum number of available threads in the web container.
username java.lang.String @@username@@ true The admin username to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
useSpecifiedClusterNodes java.lang.Boolean false true Choose whether to deploy this cluster to specific nodes in the cell. If set to 'true', you must specify a list of nodes. If set to 'false', the cluster will be distributed (using the 'clusterCount' resource) to all nodes in the cell.
wasDmHome java.lang.String @@wasDmHome@@ false The absolute path to the deployment manager profile home in the target server. This parameter must be set in order for this task to work.
WC_defaulthost_port java.lang.Integer 10030 false The WC_defaulthost port.
WC_defaulthost_secure_port java.lang.Integer 11030 true The WC_defaulthost_secure port.
webContainerAccessSessionOnTimeout java.lang.Boolean true true Access session on timeout.
webContainerAllowSerializedSessionAccess java.lang.Boolean false true Allow serialized session access.
webContainerCookieHttpOnly java.lang.Boolean true true Enable cookie HTTP only.
webContainerDataReplicationMode java.util.List BOTH true Data replication mode.
webContainerEnable java.lang.Boolean true true Enable web container.
webContainerEnableCookies java.lang.Boolean true true Enable cookies.
webContainerEnableProtocolSwitchRewriting java.lang.Boolean false true Enable protocol switch rewriting.
webContainerEnableSecurityIntegration java.lang.Boolean false true Enable security integration
webContainerEnableSSLTracking java.lang.Boolean false true Enable SSL tracking.
webContainerEnableUrlRewriting java.lang.Boolean false true Enable URL rewriting.
webContainerMaxWaitTime java.lang.Integer 5 true The web container max wait time, in minutes.
webContainerProperties TextArea   true Web container custom properties, syntax: [[["name", "PROP_NAME_1"], ["value", "PROP_VALUE_1"]],[["name", "PROP_NAME_2"], ["value", "PROP_VALUE_1"]],...] For example: [[["name", "fileServingEnabled"], ["value", "false"]]]
webContainerSessionPersistenceMode java.util.List NONE true Session persistence mode. Set to DATA_REPLICATION to enable memory-to-memory replication.
webContainerSessionTimeout java.lang.Integer 30 true The web container session timeout, in minutes.
wsadminPath java.lang.String @@wsadminPath@@ true The absolute path to the wsadmin scripting tool including the extension (.sh or .bat) in the target server. If this is not set @@wasDmHome@@/bin/wsadmin.sh or @@wasDmHome@@/bin/wsadmin.bat will be used.


Back to Top

Install data source

Class Name com.midvision.rapiddeploy.orchestration.tasks.was.jython.InstallDatasourceTask
Category IBM WebSphere 8 - Configuration

WebSphere install data source task

Description

This task uses the RapidDeploy Jython framework to create a JDBC provider and a data source that supports it in WebSphere Application Server 8. If they exist they are modified.

Oracle RAC clustering

The scope 'server' is used only for this particular configuration, and some extra configuration needs to be set in the 'pyArea' resource. The following is an example of a configuration to be set in the resource text area:
                     specifiedJdbcUrlMapping_1 = [[["racNode", "p13404prd019-urv"], ["racURL", "jdbc:oracle:thin:@(DESCRIPTION = (ADDRESS = (PROTOCOL
                     = TCP)(HOST = dtp033usr-vip)(PORT = 1521)) (ADDRESS = (PROTOCOL = TCP)(HOST = dtp034usr-vip)(PORT = 1521)) (LOAD_BALANCE =
                     yes) (CONNECT_DATA = (SERVER = DEDICATED) (SERVICE_NAME = WAS_CSTEST_01.test.lloydstsb.co.uk)))"]]]
                     specifiedJdbcUrlMapping_1.append([["racNode", "p13504prd020-urv"], ["racURL", "jdbc:oracle:thin:@(DESCRIPTION = (ADDRESS =
                     (PROTOCOL = TCP)(HOST = dtp034usr-vip)(PORT = 1521)) (ADDRESS = (PROTOCOL = TCP)(HOST = dtp033usr-vip)(PORT = 1521)) (LOAD_BALANCE
                     = yes) (CONNECT_DATA = (SERVER = DEDICATED) (SERVICE_NAME = WAS_CSTEST_02.test.lloydstsb.co.uk)))"]])
                     			

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
agedTimeout java.lang.Integer 0 false Specifies the interval in seconds before a physical connection is discarded.
cellName java.lang.String   false The name of the cell to configure. This resource should always be set.
cfname java.lang.String   false Specifies the display name for the new 'CMPConnectorFactory' resource.
clusterName java.lang.String   true The name of the cluster used for the specific scope.
connectionTimeout java.lang.Integer 180 false Specifies the interval, in seconds, after which a connection request times out and a ConnectionWaitTimeoutException is thrown.
conntype java.lang.String @@conntype@@ true Specifies the type of connection to use when deploying to this target. Possible values are: LOCAL, SOAP, RMI, JSR160RMI or IPC. 'LOCAL' means the connection is made locally so no remote connection parameters will be used.
databaseDescription java.lang.String   false Specifies an optional description of the authentication data entry.
databasePassword java.lang.String   false Specifies the password that is associated with the user identity.
databasePasswordAlias java.lang.String   false Specifies the name of the authentication data entry.
databaseURL java.lang.String   false Specifies the data source connection URL.
databaseUserId java.lang.String   false Specifies the user identity.
driverPath java.lang.String   false Specifies a list of paths or JAR file names which together form the location for the resource provider classes.
dsHelper java.lang.String   false Specifies the name of the DataStoreHelper implementation class that extends the capabilities of your selected JDBC driver implementation class to perform database-specific functions.
dsjndiname java.lang.String   false Specifies the Java Naming and Directory Interface (JNDI) name.
dsMappingAuthDataAlias java.lang.String   true Specifies authentication data, which is a JAAS - J2C authentication data entry, for container-managed signon to the resource. Depending on the value that is selected for the 'dsMappingConfigAlias' resource, you can disable this setting. The value set for 'databasePasswordAlias' is used by default.
dsMappingConfigAlias java.lang.String   true Specifies the authentication alias for the Java Authentication and Authorization Service (JAAS) mapping configuration that is used by this connection factory.
dsname java.lang.String   false Specifies the display name for the data source.
dsPreTestConnection java.lang.Boolean false true Specifies whether the connection manager tests the validity of pooled connections before returning them to applications.
dsRetryInterval java.lang.Integer 0 true If you set 'dsPreTestConnection' to true, this option specifies the length of time, in seconds, to allot to the JDBC driver for validating a connection.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
hostname java.lang.String @@hostname@@ true The hostname to connect to for deployment operations against the WebSphere cell.
jdbcdesc java.lang.String   false Specifies a text description for the resource provider.
jdbcimplclass java.lang.String   false Specifies the Java class name of the JDBC driver implementation.
jdbcname java.lang.String   false Specifies the name of the resource provider.
jdbcscope java.util.List cluster false Specifies the scope of the JDBC provider; the data source created with this JDBC provider inherits this scope. The scope 'server' is only used for Oracle RAC clustering and requires the certain extra configuration in the 'pyArea' as described in the task documentation.
maxConnections java.lang.Integer 10 false Specifies the maximum number of physical connections that you can create in this pool.
minConnections java.lang.Integer 1 false Specifies the minimum number of physical connections to maintain.
nodeName java.lang.String   true The name of the node used for the specific scope.
password java.lang.String @@password@@ true The admin password to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
port java.lang.String @@port@@ true The connection port of the WebSphere process to connect to for deployment operations. This port will vary depending on the connection type.
purgePolicy java.util.List EntirePool false Specifies how to purge connections when a stale connection or fatal connection error is detected.
pyArea TextArea   true Area to add all the Jython profile configuration you want to override all other configurations.
reapTime java.lang.Integer 180 false Specifies the interval, in seconds, between runs of the pool maintenance thread.
serverName java.lang.String   true The name of the server used for the specific scope.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
stmentCacheSize java.lang.Integer 10 false Specifies the number of statements that can be cached per connection. The application server caches a statement after you close that statement.
stuckThreshold java.lang.Integer 0 true The stuck threshold is the number of connections that must be considered stuck for the pool to be in stuck mode.
stuckTime java.lang.Integer 0 true The stuck time property is the interval, in seconds, allowed for a single active connection to be in use to the backend resource before it is considered to be stuck.
stuckTimerTime java.lang.Integer 0 true The stuck timer interval property is the interval for the timer, for example, how often the connection pool checks for stuck connections.
templateName java.lang.String   false Specifies a configuration ID of an existing object. This object can be a template object returned by using the 'listTemplates' command, or any other existing object of the correct type.
unusedTimeout java.lang.Integer 1800 false Specifies the interval in seconds after which an unused or idle connection is discarded.
username java.lang.String @@username@@ true The admin username to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
wasDmHome java.lang.String @@wasDmHome@@ false The absolute path to the deployment manager profile home in the target server. This parameter must be set in order for this task to work.
wsadminPath java.lang.String @@wsadminPath@@ true The absolute path to the wsadmin scripting tool including the extension (.sh or .bat) in the target server. If this is not set @@wasDmHome@@/bin/wsadmin.sh or @@wasDmHome@@/bin/wsadmin.bat will be used.


Back to Top

Install server

Class Name com.midvision.rapiddeploy.orchestration.tasks.was.jython.InstallServerTask
Category IBM WebSphere 8 - Configuration

WebSphere install server task

Description

This task uses the RapidDeploy Jython framework to create a server (JVM) in WebSphere Application Server 8. If it exists it is modified.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
asAcceptHeuristicHazard java.lang.Boolean false true Specifies whether all applications on this server accept the possibility of a heuristic hazard occurring in a two-phase transaction that contains a one-phase resource. This setting configures last participant support (LPS) for the server. Last participant support is an extension to the transaction service that enables a single one-phase resource to participate in a two-phase transaction with one or more two-phase resources.
asORBcommTraceEnabled java.lang.Boolean false true ORB trace enabled.
asORBconnectionCacheMaximum java.lang.Integer 240 true ORB connection cache maximum.
asORBconnectionCacheMinimum java.lang.Integer 100 true ORB connection cache minimum.
asORBforceTunnel java.util.List never true ORB force tunnel.
asORBlocateRequestTimeout java.lang.Integer 180 true ORB locate request timeout.
asORBnoLocalCopies java.lang.Boolean false true ORB no local copies.
asORBrequestRetriesCount java.lang.Integer -1 true ORB request retries count. A value of -1 indicates continually retry.
asORBrequestRetriesDelay java.lang.Integer 0 true ORB request retries delay. The delay between successive retries.
asORBrequestTimeout java.lang.Integer 180 true ORB request timeout.
asORBuseServerThreadPool java.lang.Boolean false true ORB use server thread pool.
asPropogatedOrBMTTranLifetimeTimeout java.lang.Integer 300 true Propagated or BMT transaction lifetime timeout.
asTransactionClientInactivityTimeout java.lang.Integer 60 true Transaction client inactivity timeout.
asTransactionLifetimeTimeout java.lang.Integer 120 true The total time, in seconds, that a transaction may remain active in the server, before it is terminated and/or rolled back.
asTransactionLogDirectory java.lang.String ;4M true Combination of directory and size, separated by a semicolon. The default setting is ;4M, indicating the default transaction log directory, with a transaction log maximum size of 4Mb.
asTSmemoryBufferSize java.lang.Integer 8 true Memory buffer size.
asTSstartupTraceSpecification java.lang.String *=info true Startup trace specification. The default is: *=info
asTStraceFormat java.util.List BASIC true Trace format.
asTStraceOutputType java.util.List SPECIFIED_FILE true Trace output type.
BOOTSTRAP_ADDRESS_port java.lang.Integer 12030 false The BOOTSTRAP_ADDRESS port.
cellName java.lang.String   false The name of the cell where the cluster is created/updated. The cell must exist.
classpath java.lang.String   true The JVM classpath. Separate each path with a system dependent delimiter: Unix(:), Windows(;).
conntype java.lang.String @@conntype@@ true Specifies the type of connection to use when deploying to this target. Possible values are: LOCAL, SOAP, RMI, JSR160RMI or IPC. 'LOCAL' means the connection is made locally so no remote connection parameters will be used.
envEntries TextArea [[['name', 'IBM_HEAPDUMP'], ['value', 'true']], [['name', 'IBM_HEAPDUMP_OUTOFMEMORY'], ['value', 'true']], [['name', 'IBM_HEAP_DUMP'], ['value', 'true']], [['name', 'IBM_JAVADUMP_OUTOFMEMORY'], ['value', 'true']], [['name', 'IBM_JAVA_HEAPDUMP_TEXT'], ['value', 'true']], [['name', 'JAVA_DUMP_OPTS'], ['value', 'ONANYSIGNAL(JAVADUMP[5],HEAPDUMP[5])']]] true JVM process definition environment entries, syntax: [[["name", "ENV_ENTRY_NAME_1"], ["value", "ENV_ENTRY_VALUE_1"]],[["name", "ENV_ENTRY_NAME_2"], ["value", "ENV_ENTRY_VALUE_1"]],...] For example: [[['name', 'IBM_HEAPDUMP'], ['value', 'true']], [['name', 'IBM_HEAPDUMP_OUTOFMEMORY'], ['value', 'true']], [['name', 'IBM_HEAP_DUMP'], ['value', 'true']], [['name', 'IBM_JAVADUMP_OUTOFMEMORY'], ['value', 'true']], [['name', 'IBM_JAVA_HEAPDUMP_TEXT'], ['value', 'true']], [['name', 'JAVA_DUMP_OPTS'], ['value', 'ONANYSIGNAL(JAVADUMP[5],HEAPDUMP[5])']]]
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
genericJVMArguments java.lang.String   true Generic JVM arguments. Each argument is separated by a space, and prefixed with -D or -X, for example: -Xminf0.3 -Xmaxf0.6 -Dcom.ibm.ws.security.spnego.isEnabled=false
hostname java.lang.String @@hostname@@ true The hostname to connect to for deployment operations against the WebSphere cell.
installProcDefEnvEntries java.lang.Boolean false true Configure process definition environment entries.
installReplicationDomain java.lang.Boolean false true Should the replication domain be installed.
logRolloverHourErr java.lang.Integer 7 true The hour to first roll the System.err logs.
logRolloverHourOut java.lang.Integer 7 true The hour to first roll the System.out logs.
logRolloverPeriodErr java.lang.Integer 12 true The System.err log will be rolled at this interval following the roll over hour.
logRolloverPeriodOut java.lang.Integer 12 true The System.out log will be rolled at this interval following the roll over hour.
logRolloverSizeErr java.lang.Integer 0 true The System.err log roll over size, expressed in MB. Setting it to 0 means the logs are never rolled over on size.
logRolloverSizeOut java.lang.Integer 0 true The System.out log roll over size, expressed in MB. Setting it to 0 means the logs are never rolled over on size.
logRolloverTypeErr java.util.List TIME true The type of roll over for the System.err logs.
logRolloverTypeOut java.util.List TIME true The type of roll over for the System.out logs.
maxJVMHeapSize java.lang.Integer 512 true JVM maximum heap size, expressed in MB.
maxLogFileCountErr java.lang.Integer 30 true The maximum number of historical log files to keep for the System.err logs. Once this number is exceeded the logs will be overwritten.
maxLogFileCountOut java.lang.Integer 30 true The maximum number of historical log files to keep for the System.out logs. Once this number is exceeded the logs will be overwritten.
minJVMHeapSize java.lang.Integer 128 true JVM minimum heap size, expressed in MB.
nodeLevelReplicationDomain java.lang.Boolean false true If 'true', the replication domain is limited to cluster members on the node. If 'false', the replication domain is set to the cluster.
nodeName java.lang.String   false The name of the primary node. This is the node that a single application server will be created on, or the first member of the cluster will be created on.
nodeRestartState java.util.List running true The state of the cluster when the WebSphere nodeagent is started.
password java.lang.String @@password@@ true The admin password to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
port java.lang.String @@port@@ true The connection port of the WebSphere process to connect to for deployment operations. This port will vary depending on the connection type.
pyArea TextArea   true Area to add all the Jython profile configuration you want to override all other configurations.
replNumberOfReplicas java.lang.Integer 1 true Number of replicas.
replRequestTimeout java.lang.Integer 5 true Request timeout.
replUseSSL java.lang.Boolean false true Use SSL in replication.
serverName java.lang.String   false The name of the server (JVM) to create or update.
SIB_ENDPOINT_ADDRESS_port java.lang.Integer 14030 false The SIB_ENDPOINT_ADDRESS port.
SIB_ENDPOINT_SECURE_ADDRESS_port java.lang.Integer 15030 false The SIB_ENDPOINT_SECURE_ADDRESS port.
SIB_MQ_ENDPOINT_ADDRESS_port java.lang.Integer 16030 false The SIB_MQ_ENDPOINT_ADDRESS port.
SIB_MQ_ENDPOINT_SECURE_ADDRESS_port java.lang.Integer 17030 false The SIB_MQ_ENDPOINT_SECURE_ADDRESS port.
SIP_DEFAULTHOST_port java.lang.Integer 18030 false The SIP_DEFAULTHOST port.
SIP_DEFAULTHOST_SECURE_port java.lang.Integer 19030 false The SIP_DEFAULTHOST_SECURE_port port.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
SOAP_CONNECTOR_ADDRESS_port java.lang.Integer 13030 false The SOAP_CONNECTOR_ADDRESS port.
startServers java.lang.Boolean false true Start all servers in the specified cell.
systemProperties TextArea   true JVM system properties, syntax: [[["name", "SYSTEM_PROPERTY_NAME_1"], ["value", "SYSTEM_PROPERTY_VALUE_1"]],[["name", "SYSTEM_PROPERTY_NAME_2"], ["value", "SYSTEM_PROPERTY_VALUE_2"]],...] For example: [[["name", "HotSpotOption"], ["value", "client"]],[["name", "user.timezone"], ["value", "Europe/London"]]]
threadPoolMaxSize java.lang.Integer 50 true The maximum number of available threads in the web container.
threadPoolMinSize java.lang.Integer 10 true The minimum number of available threads in the web container.
username java.lang.String @@username@@ true The admin username to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
wasDmHome java.lang.String @@wasDmHome@@ false The absolute path to the deployment manager profile home in the target server. This parameter must be set in order for this task to work.
WC_defaulthost_port java.lang.Integer 10030 false The WC_defaulthost port.
WC_defaulthost_secure_port java.lang.Integer 11030 true The WC_defaulthost_secure port.
webContainerAccessSessionOnTimeout java.lang.Boolean true true Access session on timeout.
webContainerAllowSerializedSessionAccess java.lang.Boolean false true Allow serialized session access.
webContainerCookieHttpOnly java.lang.Boolean true true Enable cookie HTTP only.
webContainerDataReplicationMode java.util.List BOTH true Data replication mode.
webContainerEnable java.lang.Boolean true true Enable web container.
webContainerEnableCookies java.lang.Boolean true true Enable cookies.
webContainerEnableProtocolSwitchRewriting java.lang.Boolean false true Enable protocol switch rewriting.
webContainerEnableSecurityIntegration java.lang.Boolean false true Enable security integration
webContainerEnableSSLTracking java.lang.Boolean false true Enable SSL tracking.
webContainerEnableUrlRewriting java.lang.Boolean false true Enable URL rewriting.
webContainerMaxWaitTime java.lang.Integer 5 true The web container max wait time, in minutes.
webContainerProperties TextArea   true Web container custom properties, syntax: [[["name", "PROP_NAME_1"], ["value", "PROP_VALUE_1"]],[["name", "PROP_NAME_2"], ["value", "PROP_VALUE_1"]],...] For example: [[["name", "fileServingEnabled"], ["value", "false"]]]
webContainerSessionPersistenceMode java.util.List NONE true Session persistence mode. Set to DATA_REPLICATION to enable memory-to-memory replication.
webContainerSessionTimeout java.lang.Integer 30 true The web container session timeout, in minutes.
wsadminPath java.lang.String @@wsadminPath@@ true The absolute path to the wsadmin scripting tool including the extension (.sh or .bat) in the target server. If this is not set @@wasDmHome@@/bin/wsadmin.sh or @@wasDmHome@@/bin/wsadmin.bat will be used.


Back to Top

Install shared library

Class Name com.midvision.rapiddeploy.orchestration.tasks.was.jython.InstallSharedLibrariesTask
Category IBM WebSphere 8 - Configuration

WebSphere install shared library task

Description

This task uses the RapidDeploy Jython framework to create a shared library in WebSphere Application Server 8. If it exists it is modified.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
bindLibraryToJvm java.lang.Boolean true true Determines if you want to associate this shared library with an application server class loader. This resource is only used when the scope is set to 'SERVER'.
cellName java.lang.String   false The name of the cell to configure. This resource should always be set.
classloaderForSharedLibrary java.util.List PARENT_FIRST true Specifies whether the class loader searches in the parent class loader or in the application class loader first to load a class. This resource is only used when the scope is set to 'SERVER' and 'bindLibraryToJvm' is set to 'true'.
clusterName java.lang.String   true The name of the cluster used when the scope is set to 'CLUSTER'.
conntype java.lang.String @@conntype@@ true Specifies the type of connection to use when deploying to this target. Possible values are: LOCAL, SOAP, RMI, JSR160RMI or IPC. 'LOCAL' means the connection is made locally so no remote connection parameters will be used.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
hostname java.lang.String @@hostname@@ true The hostname to connect to for deployment operations against the WebSphere cell.
nodeName java.lang.String   true The name of the node used when the scope is set to 'NODE' or 'SERVER'.
password java.lang.String @@password@@ true The admin password to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
port java.lang.String @@port@@ true The connection port of the WebSphere process to connect to for deployment operations. This port will vary depending on the connection type.
pyArea TextArea   true Area to add all the Jython profile configuration you want to override all other configurations.
serverName java.lang.String   true The name of the server used when the scope is set to 'SERVER'.
sharedLibClassPath java.lang.String   false Specifies a list of paths that the product searches for classes and resources of the shared library.
sharedLibIsolatedClassLoader java.lang.Boolean false false Specifies whether the shared library has a single isolated shared library shared across its associated applications or web modules.
sharedLibName java.lang.String   false Specifies a name for the shared library.
sharedLibNativePath java.lang.String   false Specifies the class path for locating platform-specific library files for shared library support; for example, .dll, .so, or *SRVPGM objects.
sharedLibsScope java.util.List CELL false Specifies the level of the location of the shared library configuration file.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ true The admin username to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
wasDmHome java.lang.String @@wasDmHome@@ false The absolute path to the deployment manager profile home in the target server. This parameter must be set in order for this task to work.
wsadminPath java.lang.String @@wsadminPath@@ true The absolute path to the wsadmin scripting tool including the extension (.sh or .bat) in the target server. If this is not set @@wasDmHome@@/bin/wsadmin.sh or @@wasDmHome@@/bin/wsadmin.bat will be used.


Back to Top

WebSphere generic deployment

Class Name com.midvision.rapiddeploy.orchestration.tasks.was.jython.WebSphereGenericDeploymentTask
Category IBM WebSphere 8 - Configuration

WebSphere Generic Deployment Task using Jython

Description

WebSphere Deployment task that uses the RapidDeploy Jython framework to deploy ear/war files and associated configuration to WebSphere.

Jython configuration

This is the configuration definition to be deployed to the WebSphere cell. It may contain the entire WebSphere cell configuration definition or just a small part of it, such as a cluster, application server, JMS or JDBC definition, or anything in-between.

For in-depth information about this task, see the demo projects or the online documentation.

The Jython configuration is overridden as follows:

1) The Jython framework profile with default values (configurable by the 'pyScriptsDefaultProfileRelativePath' resource), overridden by
2) The task specific profile file (configurable by the 'jythonTaskProfileFilePath' resource), overridden by
3) A temporary generated profile with all the resources provided in the task, overriden by
4) The content of the 'pyArea' resource.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
conntype java.lang.String @@conntype@@ true Specifies the type of connection to use when deploying to this target. Possible values are: LOCAL, SOAP, RMI, JSR160RMI or IPC. 'LOCAL' means the connection is made locally so no remote connection parameters will be used.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
hostname java.lang.String @@hostname@@ true The hostname to connect to for deployment operations against the WebSphere cell.
jythonDefaultProfileFilePath java.lang.String   true Path to the site wide properties file. Leave this blank unless you want to specify your own defaults.
jythonFunctionsFilePath java.lang.String   true Path to the generic WAS functions file. Leave this blank unless you want to specify your own functions.
jythonTaskProfileFilePath java.lang.String   true Path to the task specific profile file.
password java.lang.String @@password@@ true The admin password to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
port java.lang.String @@port@@ true The connection port of the WebSphere process to connect to for deployment operations. This port will vary depending on the connection type.
pyArea TextArea   true Area to add all the Jython profile configuration you want to override all other configurations provided as resources or in the file specified in the 'jythonTaskProfileFilePath' resource.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ true The admin username to use for authenticating against the WebSphere cell. Required if WebSphere cell security is enabled.
wasDmHome java.lang.String @@wasDmHome@@ false The absolute path to the deployment manager profile home in the target server. This parameter must be set in order for this task to work.
wsadminPath java.lang.String @@wsadminPath@@ true The absolute path to the wsadmin scripting tool including the extension (.sh or .bat) in the target server. If this is not set @@wasDmHome@@/bin/wsadmin.sh or @@wasDmHome@@/bin/wsadmin.bat will be used.


Back to Top

ConfigureIHSPluginTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.ConfigureIHSPluginTask
Category IHS

Configures the WebSphere plugin of an IBM HTTP Server instance

Description

This task performs an IBM HTTP Server isntance plugin configuration by invoking the ConfigureIHSPlugin script provided by this WebSphere plugin.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
ihsAdminUsergroup java.lang.String   false The user group of IHS Admin server.
ihsConfFile java.lang.String   false The full path name of the httpd.conf file.
operatingSystem java.util.List   false The name of the operating system. Possible values are: Linux|AIX|HP-UX|SunOS|ZOS
operatingSystemArch java.util.List   true The architecture of the operating system. Possible values are: 32|64. Default value is 32.
pluginConfigXml java.lang.String   false The full path of plugin-config.xml file.
pluginHome java.lang.String   false The plugin install root.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
userID java.lang.String   true The user who is used to run this task.
wasHostName java.lang.String   true The host name of the WebSphere.
wasWebserverName java.lang.String   true The name of the webserver as defined in WebSphere admin console. Default is webserver1.


Back to Top

ControlIHSAdminServerTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.ControlIHSAdminServerTask
Category IHS

This task is IBM Http Server Specific. It is used to Change State of IBM IHS Admin Server.

Table of task Resources

Name Type Default Value Optional Description
action java.lang.String start false Action [stop|start].
controlIHS java.lang.Boolean true true IHS control will be performed if true
directoryName java.lang.String start false Directory path.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
userID java.lang.String   true The user who is used to run this task.


Back to Top

ControlIHSServerTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.ControlIHSServerTask
Category IHS

This task is IBM Http Server Specific. It is used to Change State of IBM IHS Server.

Table of task Resources

Name Type Default Value Optional Description
action java.lang.String start false Action [stop|start].
controlIHS java.lang.Boolean true true IHS control will be performed if true
directoryName java.lang.String start false Directory path.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
userID java.lang.String   true The user who is used to run this task.


Back to Top

FixpackBinaryInstallTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.FixpackBinaryInstallTask
Category IHS

This task is IBM Http Server Specific. It is used to Install fixpacks for the plugin and IHS.

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
IHSsubDirectory java.lang.String   true Will add this sub-directory to the installPath
installFP java.lang.Boolean true true Flag to toggle the fixpack intall/update on/off.
installIHS java.lang.Boolean true true Flag to toggle the IHS intall/update on/off.
installPLG java.lang.Boolean true true Flag to toggle the plugin intall/update on/off.
overridePath java.lang.Boolean true false  
overrideUser java.lang.Boolean false true Override the default user id.
PLGsubDirectory java.lang.String   true Will add this sub-directory to the installPath
Product java.lang.String plg false Product to install. One of [plg|ihs]
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
tmpPath java.lang.String   true Directory to store temporary files. Leave this blank to use default /tmp path
userID java.lang.String   true The user who is used to run this task.
WINdevice java.lang.String   true Set this parameter if the install is on a different device. Windows Only. Leave this blank to use default "C:".


Back to Top

IHSBinaryInstallTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.IHSBinaryInstallTask
Category IHS

IHS Binary Install Task.

Description

This task is IBM Http Server Specific. It is used to deploy IBM IHS binaries.

Task Entries

This task is able to handle Environment Variables that you can specify as a task entries with type "VARIABLE"

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
ihsResponseFile java.lang.String responsefile.ihs false IHS Response file to use.
installID java.lang.String   true The install ID. Typically this will match the related WebSphere Cell.
installIHS java.lang.Boolean true true Flag to toggle the IHS intall/update on/off.
installPath java.lang.String   false The path to the binary installation.
installType java.util.List installNew true Valid options are installNew and uninstall.
overrideUser java.lang.Boolean false true Override the default user id.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
tmpPath java.lang.String   true Directory to store temporary files. Leave this blank to use default /tmp path
uninstallIHS java.lang.Boolean false true Flag to toggle the uninstall IHS on/off. Note that then you can set installIHS to reinstall the IHS.
userID java.lang.String   true The user who is used to run this task.
WINdevice java.lang.String   true Set this parameter if the install is on a different device. Windows Only. Leave this blank to use default "C:".


Back to Top

IHSChangeOwnerTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.IHSChangeOwnerTask
Category IHS

This task is IBM Http Server Specific. It is used to Change Ownership of IBM IHS binaries. You can change ownership of whole ihs directory and also specify the path to plugin installation.

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
ihsDirectory java.lang.String   false The path to the IHS directory.
newOwner java.lang.String webadmin:webadms false The new owner:group to use.
plgInstallPath java.lang.String   true The path to the plugin installation.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
subDirectory java.lang.String   true If there is no plgInstallPath you can specify subDirectory which will be added to standard plugin location.


Back to Top

PluginBinaryInstallTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.PluginBinaryInstallTask
Category IHS

This task is IBM Http Server Specific. It is used to deploy IBM IHS plugin.

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installID java.lang.String   true The install ID. Typically this will match the related WebSphere Cell.
installPath java.lang.String   false The path to the binary installation.
installPLG java.lang.Boolean false true Flag to toggle the Plugin intall/update on/off.
installType java.util.List installNew true Valid options are installNew and uninstall.
overridePath java.lang.Boolean true false Override the installPath. Replce ihs with plg to create the path. This resource allows the plugin and ihs to be installed in the same orchestration and to a standard pair of paths. For example if the IHS install is at /usr/httpserver/ihs6.1, the plugin will be at /usr/httpserver/plg6.1
overrideUser java.lang.Boolean false true Override the default user id.
plgResponseFile java.lang.String responsefile.plg false IHS Response file to use.
PLGsubDirectory java.lang.String   true The sub-directory (under the installPath) in which to create the plugin. This may also be passed as a parameter to orchestration.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
tmpPath java.lang.String   true Directory to store temporary files. Leave this blank to use default /tmp path
uninstallPLG java.lang.Boolean false true Flag to toggle the Plugin uninstall on/off. Note that then you can set installPLG to reinstall the plugin.
userID java.lang.String   true The user who is used to run this task.
WINdevice java.lang.String   true Set this parameter if the install is on a different device. Windows Only. Leave this blank to use default "C:".


Back to Top

UIBinaryInstallTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.UIBinaryInstallTask
Category IHS

UI Binary Install Task

Description

This task is IBM Http Server Specific. It is used to install the Update Installer. This task expects that you have UpdateInstaller binaries in the main level of your package. There are a number of additional optional parameters than can be set for this task described below.

Restrictions

This task requires that the following resource is set in the task resources:
installType - Choose base install or update [installNew|update]
userID - The userID that should be performing this install.

Task Entries

This task is able to handle Environment Variables that you can specify as a task entries with type "VARIABLE"

Example

In order to install UpdateInstaller you can set following resources:
                     			The installPath  /opt/IBM/WebSphere 
The installUI true
The Product [leave it empty]
The uiResponseFile is UpdateInstaller/responsefile.updiinstaller.txt (relative path to your package)
The overridePath is false
Inside response file you may have many option but the absolute minimum are: -OPT silentInstallLicenseAcceptance="true" -OPT installLocation="/opt/IBM/WebSphere/UpdateInstaller"
Assuming that you added UpdateInstaller binaries (unzipped) to your package, after the deployment you will find UpdateInstaller installation on your target server under the path /opt/IBM/WebSphere/UpdateInstaller

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
IHSsubDirectory java.lang.String   true Will add this sub-directory to the installPath
installIHS java.lang.Boolean true true Flag to toggle the IHS intall on/off.
installPath java.lang.String   false The path to the binary installation.
installPLG java.lang.Boolean false true Flag to toggle the Plugin intall on/off.
installType java.util.List installNew false Valid options are installNew and uninstall.
installUI java.lang.Boolean false true Flag to toggle the Update intaller on/off.
overridePath java.lang.Boolean true false Used to update the installPath when you are installing IHS and the plugin in the same orchestration file.
overrideUser java.lang.Boolean false true Override the default user id.
PLGsubDirectory java.lang.String   true Will add this sub-directory to the installPath
Product java.lang.String   false Product to install. One of [plg|ihs]
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
tmpPath java.lang.String   true Directory to store temporary files. Leave this blank to use default /tmp path
uiResponseFile java.lang.String responsefile.ui false UI Response file to use.Note that this is a path relative to your package directory.
userID java.lang.String   false The user who is used to run this task.
WINdevice java.lang.String   true Set this parameter if the install is on a different device. Windows Only. Leave this blank to use default "C:".


Back to Top

UninstallIHSTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.UninstallIHSTask
Category IHS

This task is IBM Http Server Specific. It is used to uninstall IBM IHS binaries.

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installID java.lang.String   true The install ID. Typically this will match the related WebSphere Cell.
installPath java.lang.String   false The path to the binary installation.
overrideUser java.lang.Boolean false true Override the default user id.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
tmpPath java.lang.String   true Directory to store temporary files. Leave this blank to use default /tmp path
userID java.lang.String   true The user who is used to run this task.


Back to Top

UninstallPluginTask

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.UninstallPluginTask
Category IHS

This task is IBM Http Server Specific. It is used to uninstall IBM IHS plugin.

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installID java.lang.String   true The install ID. Typically this will match the related WebSphere Cell.
installPath java.lang.String   false The path to the binary installation.
overridePath java.lang.Boolean true false  
overrideUser java.lang.Boolean false true Override the default user id.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
tmpPath java.lang.String   true Directory to store temporary files. Leave this blank to use default /tmp path
userID java.lang.String   true The user who is used to run this task.