Plug-in Documentation

IBM DataPower Configuration Manager

Overview

The IBM DataPower configuration manager plug-in includes steps to work with WebSphere DataPower appliances.

To add the IBM DataPower configuration manager plug-in steps to processes, click Infrastructure > WebSphere DataPower in the step palette of the process editor.

Compatibility

This plug-in works with all WebSphere DataPower appliances that are currently supported by IBM, with the exception of the XC10, and all supported versions of DataPower firmware.

This plug-in requires version 6.0 or later of IBM UrbanCode Deploy.

This plug-in supports agents running on the versions of Linux and Microsoft Windows that are supported by IBM UrbanCode Deploy.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode products.

A Java SDK that contains tools.jar is required to run all DataPower plug-in steps.

How-To

View the GitHub projects wiki page for full directions and complete tutorials on using the Datapower plugin.

History

Version 20

  • RFE 115259 Added the Flush Document Cache and Flush Stylesheet Cache steps and their associated flush-document-cache and flush-stylesheet-cache targets.

Version 19

  • PR #87 New key-create target to generate a private key, a public key, and a self-signed certificate.
  • PR #87 Updated the default spelling of the ref.files property in password-alias-create and password-alias-update targets.
  • Fixes APAR PI92154 Missing default format property value in export-object and export-objects targets.

Version 18

  • Fixes APAR PI92154 Missing default format property value in export-object and export-objects targets.

Version 17

  • Improve Invoke any deploy.ant.xml target steps Additional Properties decription. Property names and values are now trimmed.

Version 16

  • Issue #81 Added format argument to the export-object and export-objects DCM targets to define export type. Possible values: XML or ZIP. Default is ZIP.
  • Issue #82 Added missing port property in the importConfig and importConfigDPO macrodefs used by import-from-def and import-dpo DCM tasks.
  • PR #85 Set SSLClientProfile for Load Balancer Groups and update health check comments to include TCPConnectionType check.

Version 15

  • Fixes APAR PI85141 Failure in Export Object step due to missing all.files default argument.
  • The Export Object step contains a new Include All Files? property and all required properties are now properly marked.
  • Fixes APAR PI84786 Escape all special characters (except double quotes) in Password field for Windows OS.

Version 14

  • Updated packaged Ant to v1.9.9.

Version 13

Fixes APAR PI79894 New functionality added to the Import (Basic), Import (Definition), and Import (Deployment Policy Object) steps:

  • The hidden Import Error Regex variable can be utilized to ignore SOMA error responses.

Version 12

New functionality added to all steps:

  • The hidden Java Max Memory Size variable has new -Xmx4096m, ${p?:environment/memorySize}, and ${p?:resource/memorySize} options.

Version 11

New functionality added to all steps:

  • The ANT_OPTS variable is applied to all commands.
  • Specify the hidden Java Max Memory Size variable to increase the Ant commands JVM size.

Version 10

Download Files step added.

Version 9

Export Object step added.
Added support for the back tick (`) character.

Version 8

Initial release of the standard version of the plug-in.

Usage

Steps

Process steps in the IBM DataPower configuration manager plug-in

Backup Device

Backup all domains on a device (minus key/certificate files)

Input properties for the Backup Device step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
Backup file String DataPower export file to create/overwrite No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Backup Domains

Backup one or more domains on a device (minus key/certificate files)

Input properties for the Backup Domains step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
Additional comma separated domain names (no blanks) String Names of additional domains to backup No
Backup file String DataPower export file to create/overwrite No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Domain name String Name of the first domain to backup No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Checkpoint Delete

Delete a checkpoint in a domain

Input properties for the Checkpoint Delete step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
Checkpoint name String Name of checkpoint No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Domain name String Name of a domain containing the checkpoint No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Checkpoint Restore

Restore a domain from a checkpoint

Input properties for the Checkpoint Restore step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
Checkpoint name String Name of checkpoint No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Domain name String Name of a domain to restore from a checkpoint No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Checkpoint Save

Checkpoint the current state of a domain

Input properties for the Checkpoint Save step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
Checkpoint name String Name of checkpoint No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Domain name String Name of a domain to checkpoint No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Create Domain

Create a new domain

Input properties for the Create Domain step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
New domain name String Name of the domain to create (letters, numbers, hyphen, underscore, no blanks) No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Crypto Identity Credential from Definition

Create/overwrite a crypto identity credential based on a definition file

Input properties for the Crypto Identity Credential from Definition step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Definition file String Definition file for crypto identity credential No
Domain name String Name of the target domain No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Crypto Validation Credential from Definition

Create/overwrite a crypto validation credential based on a definition file

Input properties for the Crypto Validation Credential from Definition step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Definition file String Definition file for crypto validation credential No
Domain name String Name of the target domain No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Delete Domain

Delete a domain

Input properties for the Delete Domain step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Domain name String Name of the domain to delete No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Host Alias Remove

Remove a host alias

Input properties for the Host Alias Remove step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Host alias name String Host alias (e.g. www.ibm.com) No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Host Alias Set

Set a host alias

Input properties for the Host Alias Set step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
Comment String e.g. the equivalent DNS name for this IP address No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Host alias IP String IP address assigned to an ethernet adapter on the appliance as a primary or secondary
IP address
No
Host alias name String Host alias (e.g. www.ibm.com) No
State Enumeration:

  • enabled
  • disabled
Whether enabled or disabled No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Import (Basic)

Import a DataPower export file (e.g. .zip) into a domain

Input properties for the Import (Basic) step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Domain name String Name of the target domain No
Import File String DataPower export file to import No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Import (Definition)

Import a DataPower export file (e.g. .zip) into a domain

Input properties for the Import (Definition) step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Definition File String DCM definitions file No
Domain name String Name of the target domain No
Import File String DataPower export file to import No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Import (Deployment Policy Object)

Import a DataPower export file (e.g. .zip) into a domain using a deployment policy
object

Input properties for the Import (Deployment Policy Object) step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Deployment policy object name String Deployment policy object (already present in the domain) to be applied during import No
Domain name String Name of the target domain No
Import File String DataPower export file to import No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Invoke any deploy.ant.xml target

Invoke any deploy.ant.xml target prefer predefined steps to this one

Input properties for the Invoke any deploy.ant.xml target step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
Additional Properties File String File Containing Additional Properties No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Domain name String Name of the target domain No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No
Target name String Name of the target (e.g. domain-restart) No

Load Balancer Group from Definition

Create/overwrite a load balancer group based on a definition file

Input properties for the Load Balancer Group from Definition step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Definition file String Definition file for load balancer group No
Domain name String Name of the target domain No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Export Object

Quiesce a domain

Export an object from a domain on a device
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Domain name String Name of the domain to quiesce No
Export file String DataPower export file to create/overwrite No
Include all files? Check Box Include all other files when exporting? No
Include reference files? Check Box Include referenced files when exporting? No
Include reference objects? Check Box Include referenced objects when exporting? No
Object Class String Object class e.g. MultiProtocolGateway or WSGateway No
Object Name String Object name e.g. name of service No

Quiesce Domain

Quiesce a domain

Input properties for the Quiesce Domain step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Domain name String Name of the domain to quiesce No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Restart Domain

Restart a domain

Input properties for the Restart Domain step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Domain name String Name of the domain to restart No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Restore Backup

Restore one or more domains from backup file (see Backup Device or Backup Domains)

Input properties for the Restore Backup step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
Additional blank separated domain names String Names of additional domains to restore No
Backup file String DataPower export file No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Domain name String Name of the first domain to restore No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Save Configuration

Save the in-memory configuration in a domain to permanent storage

Input properties for the Save Configuration step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Domain name String Name of the domain No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Set Log Level

Set the log level for the default log in a domain

Input properties for the Set Log Level step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Domain name String Name of the domain No
Log level Enumeration:

  • debug
  • info
  • notice
  • warn
  • error
  • critic
  • alert
  • emerg
Default log level in domain No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Unquiesce Domain

Unquiesce a domain

Input properties for the Unquiesce Domain step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Domain name String Name of the domain to unquiesce No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No

Upload Directory

Upload a directory

Input properties for the Upload Directory step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Domain name String Name of the target domain No
From directory String Source directory No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No
To directory String Target directory No

Upload from Definition

Create/overwrite files/directories based on a definition file

Input properties for the Upload from Definition step
Name Type Description Required
Additional Properties String Additional property mappings antpropname=[ ~ more definitions ] No
DataPower XMI port String XML Management Interface port on DataPower appliance (usually 5550) No
DataPower hostname/IP String Hostname or IP address of DataPower appliance No
DataPower password Password Password for userid on DataPower appliance No
DataPower userid String Userid on DataPower appliance No
Definition file String Definition file for files and directories to upload No
Domain name String Name of the target domain No
Target Environment String Target environment (e.g. dev, sit, uat, prod) No