Back to Top

Snapshot WMB Server

Class Name com.midvision.rapiddeploy.orchestration.tasks.wmb.SnapshotTask
Category IBM WebSphere Message Broker

Snapshot an instance of WebSphere Message Broker.

Description

This task performs a snapshot of a WebSphere Message Broker server. It will produce a ZIP file containing three files:
  • repository.xml - an XML representation of the configureation provided.
  • snapshot.xml - the actual snapshot.
  • template.xml - a template representation of the snapshot.

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 WMB librariy for RapidDeploy in the classpath of the project. These JAR is typically:
  • rapiddeploy-ext-wmb-jar.jar

Resources

The following resources can be set on this task:

Table of task Resources

Name Type Default Value Optional Description
brokerName java.lang.String   false The name of the message broker to snapshot.
brokerQueueManager java.lang.String   false The queue manager associated with this broker.
brokerQueueManagerChannel java.lang.String   true The queue manager channel associated with this broker. Default value: SYSTEM.BKR.CONFIG
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 WMB domain.
majorVersion java.lang.Integer 8 false The major version of the WMB environment.
minorVersion java.lang.Integer 0 false The minor version of the WMB environment.
port java.lang.Integer   false The connection port of the WMB domain.
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).
snapshotExclusions java.lang.String   true Comma separated list of IBM Integration Bus attribute types to ignore during the snapshot. These values should not normally need changing from their default settings. Default settings: flowNodes - this can retrieve a lot of information and is set to exclude as a default. Possible values: deployableObjectFullName, deployableObjectName, deployableObjectFileExt, deployableObjectBarName, deployableObjectVersion, deployableObjectDeployTime, deployableObjectModifiedTime
sslCipherSuite java.lang.String   true SSL cipher suite to use. Default value: SSL_RSA_WITH_NULL_MD5
sslEnabled java.lang.Boolean false true Use SSL connections.
sslKeyStore java.lang.String   true SSL key sore location on the local filesystem.
sslKeyStorePassword java.lang.String   true SSL key store Password.
sslPeerName java.lang.String   true SSL peer name to use. Default value: CN=MV.Client,O=MidVision Ltd,OU=MidVision,L=London,ST=EC4N 7DZ,C=GB
sslTrustStore java.lang.String   true SSL trust store location on the local filesystem.
sslTrustStorePassword java.lang.String   true SSL trust store password.


Back to Top

Wmb Bespoke Command Runner

Class Name com.midvision.rapiddeploy.orchestration.tasks.wmb.WmbBespokeWmbCommandTask
Category IBM WebSphere Message Broker

WebSphere Message Broker Bespoke Command Task.

Description

This task allows you to run any bespoke command in a message broker environment.

This task will run the mqsiprofile within the specified wmb install location i.e. <wmbmaintainWmbBinaryInstallLocation>/bin/mqsiprofile. After running the profile the bespoke command specified within the resource wmbmaintainBespokeWmbCommand will be executed.

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.
successCode java.lang.String 0 true This is the success code expected for the execution.
wmbmaintainBespokeWmbCommand java.lang.String mqsilist @@BROKER_NAME@@ false This is the bespoke command that will be run on the target.
wmbmaintainWmbBinaryInstallLocation java.lang.String /opt/ibm/mqsi/7.0 false This is the wmb binary install root directory.


Back to Top

Wmb Binary Install

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.wmb.WmbBinaryInstallTask
Category IBM WebSphere Message Broker

Websphere Message Broker Binary Install Task

Description

This task enables the installation of Websphere Message Broker on supported platforms. It also can be used to install patches. A prepared midvision package is required for installation which generally consists of the binaries in a directory structure managed by a listfile at the top level. Please see MidVision documentation for constructing a binary install package.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
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
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
group java.lang.String mqbrkrs false The WMB Group
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
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   false Directory to store temporary files.
mode java.lang.String install true Can either be install (default) or uninstall
owner java.lang.String mbadmin false The WMB Owner
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 true 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

Wmb Default Manage Broker

Class Name com.midvision.rapiddeploy.orchestration.tasks.wmb.WmbDefaultManageBrokerTask
Category IBM WebSphere Message Broker

Websphere Message Broker Default Manage Broker

Description

This task is used to manage Websphere Message Broker Configurations. It can be used to perform local administration of the message broker during a deployment. For example a broker can be created, deleted, started or stopped by specifying the appropriate options. This task is typically used in conjunction with other message broker tasks (such as the Websphere Message Broker Deployment Task) to perform preparatory actions.

Additional information about wmbmaintainOperation settings in Orchestration Resources

This single orchestration task can be used in a number of ways by specifying different operations. These are described below. This task depends upon a certain structure within the deployment package
OperationDescription
createBrokerCreates a message broker using information from the deployment package
createAndStartBrokerCreates and starts a message broker using information from deployment package
createAndStartBrokerAndListenerCreates and starts a message broker and additionally starts a queue manager listener
startBrokerStarts a message broker
stopBrokerStops a message broker
deleteBrokerDeletes a message broker
getBrokerAdminLogsPrints to the log the current Message Broker administration logs retrieved from the Configuration Manager Proxy
getBrokerAdminLogsAndFlowStatsAs above but also includes the current flow statistics settings

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
configurationPropertyFilePath java.lang.String   false The absolute path to the property file containing the configuration information for this environment.
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.
successCode java.lang.String 0 true This is the success code expected for the execution.
targetClassPath java.lang.String wmb/lib true If this property is set then use this classpath to load the wmb extensions jar, else use the same classpath as the current orchestration.
wmbmaintainDataRootRelativePath java.lang.String wmb/bars true The relative path to the top of the data tree in the archive. If this is not specified wmb/bars will be used by default.
wmbmaintainHomeRelativePath java.lang.String wmb/lib true Path of additional wmb libraries if required.
wmbmaintainOperation java.lang.String createAndStartBrokerAndListener false The Broker Operation requested i.e.createBroker, createAndStartBroker, createAndStartBrokerAndListener, startBroker, stopBroker, deleteBroker, snapshotBroker, getBrokerAdminLogs, getBrokerAdminLogsAndFlowStats


Back to Top

Wmb Deployment

Class Name com.midvision.rapiddeploy.orchestration.tasks.wmb.WmbDeploymentTask
Category IBM WebSphere Message Broker

Websphere Message Broker Deployment Task

Description

This task is used to deploy message broker configuration and code. It can optionally be used to create message brokers and their internal topology (such as execution groups). This task is used in conjunction with a prepared midvision package is required for deployment which is usually a source controlled folder structure that has been compressed into a single package. Please see MidVision documentation for constructing a code deployment package at our support pages

Additional information about wmbmaintainOperation settings in Orchestration Resources

This single orchestration task can be used in a number of ways by specifying different operations. These are described below. This task depends upon a certain structure within the barfile
OperationDescription
updateBrokerPerforms a code (barfile) and configuration deployment to the message broker creating the broker topology if it does not exist
updateBrokerConfigPerforms a configuration deployment to the message broker
updateBrokerCodePerforms a code (barfile) deployment to the message broker and creates the topology if it does not exist

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
configurationPropertyFilePath java.lang.String   false The absolute path to the property file containing the configuration information for this environment.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
searchReplacePropertyFilePath java.lang.String   false The absolute path to the property file containing search/replace parameters for this environment.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
successCode java.lang.String 0 true This is the success code expected for the execution.
wmbmaintainConfigRootRelativePath java.lang.String wmb/config false The relative path to the top of the configuration tree in the archive.
wmbmaintainDataRootRelativePath java.lang.String wmb/bars false The relative path to the top of the data tree in the archive.
wmbmaintainHomeRelativePath java.lang.String . false The relative path to the top of the WMB config directory in the archive
wmbMaintainJavaLibraryRelativePath java.lang.String lib/rapiddeploy-ext-wmb-jar.jar false The relative (to archive root) or absolute path to the MidVision extension WMB Jar.
wmbmaintainOperation java.lang.String updateBroker false Operation to perform. One of: updateBroker or manageBroker.