Back to Top

Backup DataPower Device

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.wamt.DataPowerDeviceBackupTask
Category IBM DataPower

Run a Datapower device backup.

Description

Task to back up a DataPower device. The device is backed up to a filesystem location on the RapidDeploy Server object.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
backupDestination java.lang.String   true backupDestination is the URI of a directory where the backup files will be written. Supported protocols are "local:", "temporary:", "ftp:" and "file:". The location must be a directory, not a file name. All backup will be copied to the destination. If the specified destination is a "file:", any existing backup files will be overwritten.
cryptoCertificateName java.lang.String   true certificate object name on the Device. This is the Crypto Certificate used for the encryption. The corresponding Crypto Identification Credential will be required for the secure restore.
cryptoImage java.lang.String   true the location of the certificate used to encrypt the backup. Must be file, http or https. The cryptoCertificate or the certObjectName must be specified. Both cannot be specified; one of them must be null.
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
deviceName java.lang.String @@deviceName@@ false The logical name of the DataPower Device.
domainName java.lang.String @@domainName@@ false Name of the domain to manage.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
includeISCSI java.lang.Boolean true true A value of "true" will include the iSCSI device data in the secure-backup files. A value of "false" will omit the iSCSI device data in the secure-backup files.
includeRaid java.lang.Boolean true true A value of "true" will include the RAID device data in the secure-backup files. A value of "false" will omit the RAID device data in the secure-backup files
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  

Back to Top

Create DataPower Domain

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.soap.DataPowerCreateDomainTask
Category IBM DataPower

Run a Datapower domain creation operation.

Description

Task to create a DataPower domain on a target device. The domain is created if it does not already exist.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
domainName java.lang.String @@domainName@@ false Name of the domain to manage.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  

Back to Top

Create DataPower Ethernet Adapters

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.soap.DataPowerCreateEthernetAdaptersTask
Category IBM DataPower

Create an ethernet adapter in the DataPower device.

Description

Task to create an ethernet adapter in the DataPower device.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
defaultGateway java.lang.String   false The default gateway for the ethernet adapter.
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
ethernetIpAddress java.lang.String   false The ip address of the ethernet adapter.
ethernetName java.lang.String   false The name of the ethernet adapter.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  

Back to Top

Create DataPower Groups

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.soap.DataPowerCreateGroupsTask
Category IBM DataPower

Create a users group on the DataPower device.

Description

Task to create a users group on the DataPower device

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
accessPolicy java.lang.String   false The access policy for the group. Example for accessing a domain: */myDomain/*?Access=r+w+x, example for access to all domains: */*/*?Access=r+w+a+d+x
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
groupName java.lang.String   false The required group name.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
summary java.lang.String   false The summary for this group. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE})
username java.lang.String @@username@@ false  

Back to Top

Create DataPower Host Alias

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.soap.DataPowerCreateHostAliasTask
Category IBM DataPower

Create a host alias on the DataPower device.

Description

Task to create a host alias on the DataPower device, given an alias, IP address and user summary information

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
address java.lang.String   false The required host alias IP address. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE})
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
name java.lang.String   false The required host alias name. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE})
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
summary java.lang.String   false The user summary for this host alias. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE})
username java.lang.String @@username@@ false  

Back to Top

Create DataPower NTP Service

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.soap.DataPowerCreateNTPServiceTask
Category IBM DataPower

Create an NTP Service the DataPower device.

Description

Task to create an NTP Service the DataPower device

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
enabled java.lang.String enabled false The admin state of the service.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
mode java.lang.String on false The mode.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
refreshInterval java.lang.Integer 50 false The refresh interval this service. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE})
remoteAddresses java.lang.String address1,address2 false The remote IP addresses. This is a comma separated list of remote IP addresses. The list of addresses may be stored in dictionary value (@@DICTIONARY_VARIABLE@@)
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
summary java.lang.String   false The user summary for this Service. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE})
username java.lang.String @@username@@ false  

Back to Top

Create DataPower Users

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.soap.DataPowerCreateUsersTask
Category IBM DataPower

Create a user on the DataPower device.

Description

Task to create a user on the DataPower device

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
groupName java.lang.String   false The required group name.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
passwordToCreate java.lang.String   false The required user password.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
summary java.lang.String   false The summary for this user. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE})
username java.lang.String @@username@@ false  
usernameToCreate java.lang.String   false The required user name.

Back to Top

DataPower Device Restart

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.wamt.DataPowerDeviceRestartTask
Category IBM DataPower

Restart a DataPower device.

Description

Task to restart (stop then start) a DataPower device.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
deviceName java.lang.String @@deviceName@@ false The logical name of the DataPower Device.
domainName java.lang.String @@domainName@@ false Name of the domain to manage.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  

Back to Top

DataPower Snapshot

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.SnapshotTask
Category IBM DataPower

Create a snapshot of an IBM DataPower instance

Description

This task creates a snapshot ZIP file of an IBM DataPower instance consisting on the specified included and excluded configuration files of the installation location.

Usage

Using ANT fileset patterns set the included and excluded configuration files you want to be into the snapshot ZIP file.
By default the snapshot file will be saved in the RapidDeploy server in the location specified in the field 'Snapshots Path' of the environment configuration panel. If you want to use a different location (not recommended) you can set it using the 'snapshotDirectory' parameter.
If you select to save the snapshot file in the target server ('saveOnTarget') you need to specify the 'snapshotDirectory' parameter with the location in the target server where you want to save the snapshot file.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
binaryFilesetExcludes java.lang.String **/tmp*,**/temp* true ANT based comma separated fileset patterns to exclude in a snapshot.
binaryFilesetIncludes java.lang.String **/*.jar,**/*.war,**/*.zip true ANT based comma separated fileset patterns to include in a snapshot.
configFilesetExcludes java.lang.String **/tmpworklog*.log, **/*.jar, **/*.war, **/*.rar true ANT based comma separated fileset patterns to exclude in a snapshot.
configFilesetIncludes java.lang.String conf/*.xml,conf/**/*.xml,conf/*.properties,conf/**/*.properties true ANT based comma separated fileset patterns to include in a snapshot.
downloadBinaries java.lang.Boolean false true When set to true, the binaries filtered by the 'binaryFilesetIncludes' and 'binaryFilesetExcludes' parameters will be downloaded as part of the snapshot.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installationPath java.lang.String @@installationPath@@ false The top level directory of the IBM DataPower installation. The ANT fileset patterns will be used to select files recursively below this directory to include in a snapshot.
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.
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).

Back to Top

Delete DataPower Domain

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.wamt.DataPowerDeleteDomainTask
Category IBM DataPower

Run a Datapower domain delete operation.

Description

Task to delete a DataPower domain on a target device. The domain is deleted if it exists.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
deviceName java.lang.String @@deviceName@@ false The logical name of the DataPower Device.
domainName java.lang.String @@domainName@@ false Name of the domain to manage.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  

Back to Top

Download File from DataPower

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.soap.DataPowerDownloadFileTask
Category IBM DataPower

Download a file from a DataPower device.

Description

Download a file from a DataPower device.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
fileName java.lang.String export://export.zip false The file location (path) of the downloaded file. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE})
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  

Back to Top

Export DataPower Domain

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.wamt.DataPowerDomainExportTask
Category IBM DataPower

Run a Datapower domain export operation.

Description

Task to export a DataPower domain from a target device to a local SCM repository. The domain configuration is exported from the target device (as specified in the domain xml for this environment) to the RapidDeploy project. The storage location will be determined by the type and configuration of the SCM plugin selected for the project. In case of the whole domain configuration is not needed, a manual export should be done with the corresponding Datapower configuration objects. The output zip file of the manual export can be used with then with DataPowerObjectImportTask to spread the configuration among other domains.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
deviceName java.lang.String @@deviceName@@ false The logical name of the DataPower Device.
domainName java.lang.String @@domainName@@ false Name of the domain to manage.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
targetFilePath java.lang.String   false The file location of the exported. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE})
username java.lang.String @@username@@ false  

Back to Top

Import DataPower Domain

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.wamt.DataPowerDomainImportTask
Category IBM DataPower

Import configuration to a Datapower domain.

Description

Task to create or update an entire DataPower domain on a target device. You can use a previously exported package to deploy.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
deviceName java.lang.String @@deviceName@@ false The logical name of the DataPower Device.
domainFilePath java.lang.String ${ARCHIVE_ROOT}/dp/${APPLICATION} true Path to the Domain Zip file. If the file is in the deployment package, use ${ARCHIVE_ROOT}/path/to/file. If this is not specified it will be determined from the configuration name passed in to orchestration. The first matching file will be used.
domainName java.lang.String @@domainName@@ false Name of the domain to manage.
domainURLPath java.lang.String http://myDomain.com true URL for the domain policy file. Must be a valid URL. DomainFilePath parameter will be ignored if this parameter is present.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  

Back to Top

Import DataPower Object

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.wamt.DataPowerObjectImportTask
Category IBM DataPower

Import object configuration to a Datapower domain.

Description

Task to create or update DataPower objects on a target device. You can use a previously exported package to deploy.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
deviceName java.lang.String @@deviceName@@ false The logical name of the DataPower Device.
domainFilePath java.lang.String ${ARCHIVE_ROOT}/dp/${APPLICATION} true Path to the Domain Zip file in the archive. If the file is in the deployment package, use ${ARCHIVE_ROOT}/path/to/file. If this is not specified it will be determined from the configuration name passed in to orchestration. The first matching file will be used.
domainName java.lang.String @@domainName@@ false Name of the domain to manage.
domainURLPath java.lang.String http://myDomain.com true URL for the domain policy file. Must be a valid URL. DomainFilePath parameter will be ignored if this parameter is present.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  

Back to Top

List DataPower Ports

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.soap.DataPowerListPortsTask
Category IBM DataPower

List the ports defined for a DataPower device.

Description

Task to list the ports defined for a DataPower device.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
domainName java.lang.String @@domainName@@ false Name of the domain to manage.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  

Back to Top

Quiesce DataPower Domain

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.wamt.DataPowerQuiesceDomainTask
Category IBM DataPower

Quiesce a DataPower domain.

Description

Task to quiesce a DataPower domain.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
deviceName java.lang.String @@deviceName@@ false The logical name of the DataPower Device.
domainName java.lang.String @@domainName@@ false Name of the domain to manage.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  

Back to Top

Restore DataPower Device (from backup)

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.wamt.DataPowerDeviceRestoreTask
Category IBM DataPower

Run a Datapower device restore.

Description

Task to restore a DataPower device from backup. The device is restored from a filesystem location on the RapidDeploy Server object. The version to restore from is selected in the version drop-down in the job selection wizard. The filesystem location of the version of firmware to restore can be overridden from the optional task parameter below.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
backupSource java.lang.String   true the location of the backup files which will be used to restore the device configuration. It is the URI of a directory where the backup files are available. Supported protocols are "local:", "temporary:", "ftp:" and "file:". The location must be a directory, not a file name.
cryptoCredentialName java.lang.String   true is the object name of the Crypto Identification Credentials which includes the private Crypyto Key and the Certificate. It used to decrypt the backup files.
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
deviceName java.lang.String @@deviceName@@ false The logical name of the DataPower Device.
domainName java.lang.String @@domainName@@ false Name of the domain to manage.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  
validate java.lang.Boolean true true if true will check for items such as firmware compatibility, the manifest file's digital signature, and auxillary storage matches. The Validate option only performs the validation between the backup files and the appliance to be restored. The restore itself not initiated.

Back to Top

Run Generic DataPower Soap Request

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.soap.DataPowerGenericSoapTask
Category IBM DataPower

Run a SOAP request on the DataPower device.

Description

Task to run SOAP request on the DataPower device

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
allCertificatesTrusting java.lang.Boolean true true Connect to endpoints with untrusted certificates.
contentFilePath java.lang.String   false The file which contains the SOAP message xml content. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${ARCHIVE_ROOT}), for example ${ARCHIVE_ROOT}/xml/mySOAPMessage.xml will source the file from the deployment packages archive root directory.
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
servicePath java.lang.String   true The service endpoint where the SOAP request will run. By default it is the root of the device address, which offers a wide range of SOAP messages.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  

Back to Top

Run Script on DataPower

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.soap.DataPowerRunScriptTask
Category IBM DataPower

Run a script.

Description

Task to run a script.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
location java.lang.String   false The file location (path) of the script to run. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE}), for example config:///myDatapowerScript.cfg
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  

Back to Top

Set DataPower Time

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.soap.DataPowerSetTimeTask
Category IBM DataPower

Set the device date and time.

Description

Task to set the device date and time.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
date java.lang.String 2014-01-01 false The required date. Format: yyyy-MM-dd It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE})
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
time java.lang.String 12:00:00 false The required time. Format HH:mm:ss. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE})
timezone java.lang.String GMT0BST true The required time-zone. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE})
username java.lang.String @@username@@ false  
useSystemTime java.lang.Boolean true false Set the time to the current system time derived from the specified (unix/linux/windows) server object. If set to true, other time settings are ignored.

Back to Top

Test DataPower Connection

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.wamt.DataPowerTestConnectionTask
Category IBM DataPower

Run a Datapower test connection.

Description

Task to test connection to a DataPower device.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
deviceName java.lang.String @@deviceName@@ false The logical name of the DataPower Device.
domainName java.lang.String @@domainName@@ false Name of the domain to manage.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  

Back to Top

UnQuiesce DataPower Domain

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.wamt.DataPowerUnQuiesceDomainTask
Category IBM DataPower

Unquiesce a DataPower domain.

Description

Task to unquiesce a DataPower domain.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
deviceName java.lang.String @@deviceName@@ false The logical name of the DataPower Device.
domainName java.lang.String @@domainName@@ false Name of the domain to manage.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  

Back to Top

Upgrade DataPower Firmware

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.soap.DataPowerFirmwareUpgradeTask
Category IBM DataPower

Run a Datapower firmware upgrade.

Description

Task to upgrade the firmware on a DataPower device. The firmware level is specified in the version dropdown in the RapidDeploy new job wizard. This may be overridden by specifying an alternative version in the optional parameter. Note that you should place license.accepted (empty file) in temporary:///license.accepted location

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
fileName java.lang.String   true The upgrade file name on the device. It needs to exist on the device storage, can be uploaded be uploadFileTask.
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String @@username@@ false  

Back to Top

Upload Big File to DataPower

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.soap.DataPowerUploadBigFileTask
Category IBM DataPower

Upload a file to a DataPower device.

Description

Upload a file to a DataPower device.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
fileName java.lang.String   false the name of the file in the format used by the device, i.e., store:///myfile. The folder must exist in the device, otherwise, the exception is thrown. The file location (path) of the file to upload to the device. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE})
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
source java.lang.String   false the path of the source file. The folder must exist in the deployment package or on the source machine. The file location (path) of the file to upload to the device. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE})
username java.lang.String @@username@@ false  

Back to Top

Upload File to DataPower

Class Name com.midvision.rapiddeploy.plugins.products.ibm.datapower.tasks.wamt.DataPowerUploadFileTask
Category IBM DataPower

Upload a file to a DataPower device.

Description

Upload a file to a DataPower device with a maximum filesize of 100 Mb.

Parameters

The following parameters may be set on this task:

Table of task Parameters

Name Type Default Value Optional Description
deviceAddress java.lang.String @@deviceAddress@@ false The address of the DataPower device.
deviceName java.lang.String @@deviceName@@ false The logical name of the DataPower Device.
domainName java.lang.String @@domainName@@ false Name of the domain to manage.
failOnError java.lang.Boolean true false This task will not fail the job on error if set to false.
fileName java.lang.String   false the name of the file in the format used by the device, i.e., store:///myfile. The folder must exist in the device, otherwise, the exception is thrown. The file location (path) of the file to upload to the device. It may be set to any string, dictionary value (@@DICTIONARY_VARIABLE@@) or built-in variable (e.g. ${BUILD_STORE})
password java.lang.String @@password@@ false The admin password to use for authenticating against the DataPower Device.
port java.lang.String @@port@@ false The XML Management Interface connection port of the DataPower Device.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
urlSource java.lang.String   false an URLSource that points to the file that is copied to the Device, the schemes of url only support "file:///", "http://", "https://". URISyntaxException exception is thrown if the urlSource is not valid. Maximum filesize is 100 Mb.
username java.lang.String @@username@@ false