Back to Top
This task will run the command specified within the parameter "wmqmaintainBespokeWmqCommand".
IBM MQ Bespoke Command Runner
| Class Name | com.midvision.rapiddeploy.orchestration.tasks.wmq.WmqBespokeWmqCommandTask |
| Category | IBM MQ |
Description
This task allows you to run any command in the bin directory in an IBM MQ installation environment.This task will run the command specified within the parameter "wmqmaintainBespokeWmqCommand".
Parameters
The following parameters need be set on this task:Table of task Parameters
| 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 it 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 IBM MQ binary install root directory. |
Back to Top
IBM MQ Binary Install
| Class Name | com.midvision.rapiddeploy.orchestration.tasks.binary.wmq.MqBinaryInstallTask |
| Category | IBM MQ |
Description
This task enables the installation of IBM MQ on supported platforms. It also can be used to install patches.Parameters
The following parameters may be set on this task:Table of task Parameters
| 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 | 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 the group does not exist. |
| installerPath | java.lang.String | /bin | false | The absolute path to the directory containing the platform default installer (such as rpm or installp). |
| mode | java.util.List | 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 it 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 the user does not exist. |
Back to Top
IBM MQ Default Manage Queue Manager
| Class Name | com.midvision.rapiddeploy.orchestration.tasks.wmq.WmqDefaultManageQueueManagerTask |
| Category | IBM MQ |
Description
This task provides the capability to perform actions on an IBM 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:| Operation | Description |
|---|---|
| createQmgr | Creates a queue manager using information from the deployment package. |
| createAndStartQmgr | Creates and starts a queue manager using information from the deployment package. |
| createAndStartQmgrAndListener | Creates and starts a queue manager and additionally creates and starts a queue manager listener. |
| startQmgr | Starts a queue manager. |
| stopQmgr | Stops a queue manager. |
| snapshotQmgr | Performs a configuration snapshot of a queue manager detailing all of the objects configured within that queue manager. |
Parameters
The following parameters need be set on this task:Table of task Parameters
| 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 it has failed or not. |
| wmqmaintainOperation | java.util.List | createAndStartQmgrAndListener | false | The queue manager management operation (createQmgr, createAndStartQmgr, createAndStartQmgrAndListener, startQmgr, stopQmgr, snapshotQmgr or snapshotQmgrPackage). |
Back to Top
IBM MQ Deployment
| Class Name | com.midvision.rapiddeploy.orchestration.tasks.wmq.WmqDeploymentTask |
| Category | IBM MQ |
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:| Operation | Description |
|---|---|
| updateQmgr | Performs the necessary MQ deployment to the target queue manager as defined in the deployment package. |
Parameters
The following parameters need be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| configurationPropertyFilePath | java.lang.String | false | IBM MQ configuration file absolute path. | |
| failOnError | java.lang.Boolean | true | false | This task will not fail the deployment on error if set to false. |
| searchReplacePropertyFilePath | java.lang.String | true | Search/replace properties file absolute path. | |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether it has failed or not. |
| wmqmaintainDataRootRelativePath | java.lang.String | wmq/mqsc | false | The relative path to the top of the data tree in the archive. |
| wmqmaintainOperation | java.util.List | updateQmgr | false | The manage operation to perform. |
Back to Top
Snapshot IBM MQ Server
| Class Name | com.midvision.rapiddeploy.orchestration.tasks.wmq.SnapshotTask |
| Category | IBM MQ |
Description
This task performs a snapshot of an IBM MQ server.Parameters
The following parameters can be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| channel | java.lang.String | false | The channel to use to connect to the IBM 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 MQ Queue Manager. | |
| port | java.lang.Integer | false | The connection port of the IBM MQ Queue Manager. | |
| queueManagerName | java.lang.String | false | The name of the IBM 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 parameter 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 it 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'). |