IBM WebSphere DataPower plugin


This IBM product plugin enables integration with and provisioning of IBM WebSphere DataPower device services. The IBM WebSphere DataPower plugin is designed for managing groups of DataPower devices.

Usage and key features

  • This plugin can be used primarily to export or import DataPower domains or sub-domain components from/to DataPower devices in an environment neutral way, allowing promotion of development domains through successive environment on a route-to-live.
  • The plugin can be used to snapshot and compare domains, so that a domain can be compared with other domains, or to identify configuration drift in a domain over time.
  • Update DataPower firmware version
  • Back up and restore devices and domains.
  • User and system configuration updates.
  • Create, update and delete DataPower objects such as domains or sub-domain components.

Getting Started

To get started, follow the steps below. See the Project, Server and Environment help for additional information on these tasks.

The following steps will guide you through setting up a RapidDeploy DataPower project with one associated environment (device). The project specify a single job step (task) to test connectivity to a device. A 'deployment package' will be created, which in this simple case will be empty save for the target device connection details, derived from the environment specification. The job is run, and the output examined to determine if the connection was successful.

  • Install the DataPower plugin from the 'System icon' -> 'Plugin Manager' Panel, and restart RapidDeploy.
  • Create a new project called DATAPOWER_DEPLOY.
    1. Click on the 'Projects' icon in the task bar and then use the '+ Add Project Wizard' button in the top right hand corner
    2. Name the project DATAPOWER_DEPLOY. FIll in the other values on this panel.
    3. Click 'Skip to finish' checkbox and click 'Next'
    4. Save the project definition for DATAPOWER_DEPLOY.
  • Create a target server
    1. In the RapidDeploy Infrastructure panel, create a new server called DATAPOWER_SERVER.
    2. It should have a hostname or IP that will be resolvable, but which could point to localhost for using the RapidDeploy server itself. This is the the server (Unix/Linux/Windows) from which you perform DataPower operations.
    3. Select the appropriate remoting plugin for your site. If using localhost select the remoting agent plugin and complete the details.
    4. Save the definition.
  • Go back to the DATAPOWER_DEPLOY project you created previously,
    1. On the Orchestration tab, select a new task. Add the 'DataPower' -> 'Test DataPower Connection' task.
    2. Fill in the values for this task. Specifically the 'Device Name', 'Device Address', 'Port', 'Username' and 'Password'. If you set these to Data Dictionary values you can use them again without reentering them for any later tasks you add.
    3. Go to the Targets tab. Create a new target selecting the server (DATAPOWER_SERVER). The configuration name can be set to something meaningful like 'connectionTest'. The settings sub-tab allows you to create an environment from a template, but this is not required for this example.
    4. On the Packages tab, create a new deployment package using the 'Create Package' button. This will zip up the project directory, which now contains the new domain xml file. The package should be called DATAPOWER_DEPLOY-0.0.1.
  • Execute a job on the created target with the selected package
    1. On the 'Targets' tab, click the 'Play' button in the 'Action' column to the right of the target you created.
    2. The Package you created should be selected by default.
    3. Execute the job.

    You should see the following output in the logs:

            Task: DataPowerTestConnectionTask
            Test Connection: [SUCCESS]
            Work Unit ... Complete ...

Attributes and parameters

List and description of all tasks and parameters.


This is separately licensed plugin that is not shipped with the framework. Please contact MidVision sales to obtain a copy of this plugin. This plugin interacts with IBM software, which may require a separate license.

Further reading