Back to Top

Snapshot WMQ Server

Class Name com.midvision.rapiddeploy.orchestration.tasks.wmq.SnapshotTask
Category IBM WebSphere MQ

Snapshot an instance of IBM WebSphere MQ.

Description

This task performs a snapshot of an IBM WebSphere MQ server.

Task Entries

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

IMPORTANT

In orther for this task to work properly it is very important to include the external WMQ librariy for RapidDeploy in the classpath of the project. These JAR is typically:
  • rapiddeploy-ext-wmq-jar.jar

Resources

The following resources can be set on this task:

Table of task Resources

Name Type Default Value Optional Description
channel java.lang.String   false The channel to use to connect to the IBM WebSphere MQ Queue Manager.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
hostname java.lang.String   false The hostname to connect to for operations against the IBM WebSphere MQ Queue Manager.
port java.lang.Integer   false The connection port of the IBM WebSphere MQ Queue Manager.
queueManagerName java.lang.String   false The name of the IBM WebSphere MQ Queue Manager.
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.
regularExpression java.lang.String   true The regular expression to use.
regularExpressionToken java.lang.String   true The regular expression token to use.
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.
saveQmgrPath java.lang.String   false The path to the 'dmpmqcfg' or 'saveqmgr' executable.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
snapshotDefaultParameters java.lang.Boolean false true Determines if default parameters should be included in the snapshot (only applicable for use with 'saveqmgr').
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).
snapshotSubscriptions java.lang.Boolean false true Determines if subscriptions should be included in the snapshot (only applicable for use with 'saveqmgr').


Back to Top

Wmq Bespoke Command Runner

Class Name com.midvision.rapiddeploy.orchestration.tasks.wmq.WmqBespokeWmqCommandTask
Category IBM WebSphere MQ

WebSphere MQ Bespoke Command Task.

Description

This task allows you to run any command in the bin directory in a wmq install environment.

This task will run the command specified within the resource wmqmaintainBespokeWmqCommand.

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 need 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.
wmqmaintainBespokeWmqCommand java.lang.String dspmq @@QMGR_NAME@@ false This is the bespoke command that will be run on the target.
wmqmaintainWmqBinaryInstallLocation java.lang.String /opt/mqm false This is the wmq binary install root directory.


Back to Top

Wmq Binary Install

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.wmq.MqBinaryInstallTask
Category IBM WebSphere MQ

Websphere MQ Binary Install Task

Description

This task enables the installation of Websphere MQ on supported platforms. It also can be used to install patches

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
AMQINSTALLGSKIT java.lang.String 0 true Will not install GSKit if set to 0
changeDirOwnership java.lang.Boolean false true If true this will ensure the installerPath directory is owned by owner and group (set as Resources)
createDirs java.lang.Boolean false true Create the installation directories specified in installerPath
createGroup java.lang.Boolean false true Create the group
createUser java.lang.Boolean false true Create the owner specified in the orchestration task if it does not exist
dltmqlnk java.lang.Boolean false true Delete links to 32 bit MQ libraries
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
failOnUninstallError java.lang.Boolean true true This task will not fail the deployment on error if set to false.
failOnUninstallError java.lang.Boolean false true Should the uninstall fail this flag determines if the entire deployment should also fail or not.
groupChecks java.lang.Boolean false true Checks that the group exists prior to installation. Install fails if set to true and user does not exist
installerPath java.lang.String /bin false The absolute path to the directory containing the platform default installer (such as rpm, installp)
mode java.lang.String install true Can either be install (default) or uninstall
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
uninstallExistingVersion java.lang.Boolean false true Uninstall any existing versions prior to installing this version.
userChecks java.lang.Boolean false true Checks that the owner exists prior to installation. Install fails if set to true and user does not exist


Back to Top

Wmq Default Manage Queue Manager

Class Name com.midvision.rapiddeploy.orchestration.tasks.wmq.WmqDefaultManageQueueManagerTask
Category IBM WebSphere MQ

Websphere MQ Default Manage Queue Manager Task.

Description

This task provides the capability to perform actions on a Websphere MQ installation such as creating queue managers and objects, as well as other administrative tasks

Manage Operations


Several operations can be performed by this task and these are detailed within the table below:
OperationDescription
createQmgrCreates a queue manager using information from the deployment package
createAndStartQmgrCreates and starts a queue manager using information from deployment package
createAndStartQmgrAndListenerCreates and starts a queue manager and additionally creates and starts a queue manager listener
startQmgrStarts a Queue Manager
stopQmgrStops a Queue Manager
snapshotQmgrPerforms a configuration snapshot of a queue manager detailing all of the objects configured within that queue 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 need be set on this task:

Table of task Resources

Name Type Default Value Optional Description
configurationPropertyFilePath java.lang.String   false The file suffix of the config file to be parsed (which are used to determine the Queue Managers to manage).
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.
wmqmaintainOperation java.lang.String createAndStartQmgrAndListener false The Queue Manager Management Operation (createQmgr / createAndStartQmgr / createAndStartQmgrAndListener / startQmgr / stopQmgr, snapshotQmgr, snapshotQmgrPackage).


Back to Top

Wmq Deployment

Class Name com.midvision.rapiddeploy.orchestration.tasks.wmq.WmqDeploymentTask
Category IBM WebSphere MQ

Websphere MQ Deployment Task.

Description

This task provides the capability to deploy MQ configuration to target queue managers

Manage Operations


Currently a single operation is available, this may increase with future releases:
OperationDescription
updatePerforms the necessary MQ deployment to the target Queue Manager as defined in the deploy package

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 need be set on this task:

Table of task Resources

Name Type Default Value Optional Description
configurationPropertyFilePath java.lang.String   false WMQ Configuration file suffix.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
searchReplacePropertyFilePath java.lang.String   false Search/replace properties file suffix.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
wmqmaintainConfigRootRelativePath java.lang.String wmq/config false The relative path to the top of the configuration tree in the archive.
wmqmaintainDataRootRelativePath java.lang.String wmq/mqsc false The relative path to the top of the data tree in the archive.
wmqmaintainHomeRelativePath java.lang.String . false The relative path to the top of the wmq directory in the archive.
wmqMaintainJavaLibraryRelativePath java.lang.String   true The relative path to the WMQ library jar.
wmqmaintainOperation java.lang.String updateQmgr false The task to perform.