Back to Top

IIB Bespoke MQSI Command Runner

Class Name com.midvision.rapiddeploy.orchestration.tasks.iib.IIBBespokeMQSICommandTask
Category IBM Integration Bus

IBM Integration Bus Bespoke Command Task.

Description

This task allows you to run any bespoke command in an Integration Node environment.

This task will run the mqsiprofile within the specified IIB install location i.e. <iibMaintainIIBBinaryInstallLocation>/bin/mqsiprofile. After running the profile the bespoke command specified within the resource iibMaintainBespokeMQSICommand 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.
iibMaintainBespokeMQSICommand java.lang.String mqsilist false This is the bespoke command that will be run on the target (http://www-01.ibm.com/support/knowledgecenter/api/content/nl/en-us/SSMKHH_10.0.0/com.ibm.etools.mft.doc/an07060_.htm).
iibMaintainIIBBinaryInstallLocation java.lang.String /opt/IBM/IIB/10.0.0 false This is the IIB installation root 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.
successCode java.lang.String 0 true This is the success code expected for the execution.
targetClassPath java.lang.String lib true If this property is set then use this classpath to load the IIB extension JARs, else use the same classpath as the current orchestration.


Back to Top

IIB Binary Install

Class Name com.midvision.rapiddeploy.orchestration.tasks.binary.iib.IIBBinaryInstallTask
Category IBM Integration Bus

IBM Integration Bus Binary Install Task

Description

This task enables the installation of IBM Integration Bus 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.
failOnUninstallError java.lang.Boolean true true This task will not fail the deployment on error if set to false.
group java.lang.String iibbrkrs false The IIB 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
mode java.lang.String install true Can either be install (default) or uninstall
owner java.lang.String iibadmin false The IIB 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

IIB Default Manage Broker

Class Name com.midvision.rapiddeploy.orchestration.tasks.iib.IIBDefaultManageBrokerTask
Category IBM Integration Bus

IBM Integration Bus Default Manage Broker

Description

This task is used to manage IBM Integration Bus configurations. It can be used to perform local administration of the Integration Node 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 Integration Node tasks (such as the IBM Integration Bus Deployment Task) to perform preparatory actions.

Additional information about the iibMaintainOperation setting in the Orchestration

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 properties 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.
iibMaintainDataRootRelativePath java.lang.String iib/topology true The relative path to the top of the data tree in the archive. If this is not specified 'iib/topology' will be used by default.
iibMaintainOperation java.lang.String createAndStartBrokerAndListener false The Broker Operation requested i.e.: createBroker, createAndStartBroker, createAndStartBrokerAndListener, startBroker, stopBroker, deleteBroker, snapshotBroker, getBrokerAdminLogs or getBrokerAdminLogsAndFlowStats.
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 lib true If this property is set then use this classpath to load the IIB extension JARs, else use the same classpath as the current orchestration.


Back to Top

IIB Deployment

Class Name com.midvision.rapiddeploy.orchestration.tasks.iib.IIBDeploymentTask
Category IBM Integration Bus

IBM Integration Bus Deployment Task

Description

This task is used to deploy IBM Integration Bus configuration and code. It can optionally be used to create Integration Nodes and their internal topology (such as Integration Servers). This task is used in conjunction with a prepared MidVision package which is required for deployments and is usually a source controlled folder structure that has been compressed into a single package.

Additional information about the iibMaintainOperation setting in the Orchestration

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
updateBrokerPerforms a code (barfile) and configuration deployment to the Integration Node creating the broker topology if it does not exist.
updateBrokerConfigPerforms a configuration deployment to the Integration Node.
updateBrokerCodePerforms a code (barfile) deployment to the Integration Node 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 properties 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.
iibMaintainDataRootRelativePath java.lang.String iib/topology false The relative path to the top of the data tree in the archive.
iibMaintainHomeRelativePath java.lang.String . false The relative path to the top of the IIB config directory in the archive.
iibMaintainJavaLibraryRelativePath java.lang.String lib/rapiddeploy-ext-iib-jar.jar true The relative (to archive root) path to the MidVision IIB extension JARs. If not set they are assumed to be in the RapidDeploy lib folder.
iibMaintainOperation java.lang.String updateBroker false Operation to perform as shown in the table above.
searchReplacePropertyFilePath java.lang.String   true The absolute path to the properties 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.


Back to Top

Snapshot IIB Server

Class Name com.midvision.rapiddeploy.orchestration.tasks.iib.SnapshotTask
Category IBM Integration Bus

Snapshot an instance of IBM Integration Bus.

Description

This task performs a snapshot of an IBM Integration Bus 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 IIB librariy for RapidDeploy in the classpath of the project. These JAR is typically:
  • rapiddeploy-ext-iib-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 IIB domain.
majorVersion java.lang.Integer 10 false The major version of the IIB environment.
minorVersion java.lang.Integer 0 false The minor version of the IIB environment.
port java.lang.Integer 0 false The connection port of the IIB 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.