IBM DataPower Plugin Reference
The IBM DataPower Gateway appliance plugin allows you to manage deployments to an IBM DataPower Gateway appliance server.
This document provides information that is specific to this version of the IBM DataPower Gateway appliance plugin. For general information about the plugin, refer to Introduction to the XL Deploy DataPower plugin.
Requirements
- XL Deploy 5.0.x
- IBM DataPower Gateway appliance version 7.2
- XML Management Interface enabled and accessible by the XL Deploy server
- Valid user credentials for accessing the server
Using the deployables and deployeds
Deployable vs. container table
The following table describes which deployable/container combinations are possible.
| Deployable | Containers | Deployed |
|---|---|---|
| datapower.ConfigurationZipSpec | datapower.Server | datapower.ImportedConfigurationZip |
| datapower.ConfigurationXmlSpec | datapower.Server | datapower.ImportedConfigurationXml |
| datapower.File | datapower.Server | datapower.FileSpec |
Deployed actions table
| Deployed | Create | Destroy | Modify |
|---|---|---|---|
| datapower.ImportedConfigurationZip |
|
||
| datapower.ImportedConfigurationXml |
|
||
| datapower.File |
|
|
|
CI Reference
Configuration Item Overview
Deployables
| CI | Description |
|---|---|
| datapower.ConfigurationXmlSpec | DataPower configuration in XML format |
| datapower.ConfigurationZipSpec | DataPower configuration in ZIP format |
| datapower.FileSpec | DataPower file copy |
Deployeds
| CI | Description |
|---|---|
| datapower.File | DataPower file uploader |
| datapower.ImportedConfigurationBase | Shared properties and impementation for DataPower configuration import deployables |
| datapower.ImportedConfigurationXml | Imports DataPower configuration file in XML format |
| datapower.ImportedConfigurationZip | Imports DataPower configuration file in ZIP format |
Containers
| CI | Description |
|---|---|
| datapower.Server | IBM DataPower server |
Configuration Item Details
datapower.ConfigurationXmlSpec
| Type Hierarchy | udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
DataPower configuration in XML format
| Public properties | ||
|---|---|---|
|
|
|
checksum: STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
credentials:
CI<credentials.Credentials>
|
|
Credentials of the URI.
|
||
|
|
|
deploymentPolicy: STRING
|
|
Deployment policy to apply during import (string) default()
|
||
|
|
|
excludeFileNamesRegex: STRING
|
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
|
excludeFileNamesRegexToTranscode: STRING
|
|
A regex of file type that needs to be ignored for transcode
|
||
|
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
|
Specifies file encodings in this artifact. Key: regular expression matching file names; value: character set. Character set encoding is used for placeholder replacement and transcoding files to z/OS.
|
||
|
|
|
fileUri: STRING
|
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
|
isRescanned: BOOLEAN
|
|
Indicates if the artifact has been rescanned
|
||
|
|
|
overwriteFiles: STRING
|
|
If files defined on the DataPower device do not match the files in the import and this property is true, then the files on the device will be overwritten (boolean) default(true)
|
||
|
|
|
overwriteObjects: STRING
|
|
If objects defined on the DataPower device do not match the objects in the configuration file and this property is true, then the objects on the device will be overwritten (boolean) default(true)
|
||
|
|
|
placeholders: SET_OF_STRING
|
|
Placeholders detected in this artifact
|
||
|
|
|
preScannedPlaceholders: BOOLEAN
|
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
|
proxySettings:
CI<credentials.ProxySettings>
|
|
Proxy Settings for artifact location
|
||
|
|
|
scanPlaceholders: BOOLEAN = true
|
|
Whether to scan this artifact to replace placeholders when it is imported
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
textFileNamesRegexToTranscode: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
|
Regular expression that matches file names of text files to transcode to EBCDIC
|
| Hidden properties | ||
|---|---|---|
|
|
|
textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
|
Regular expression that matches file names of text files
|
||
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
The set of CI templates.
|
||
|
|
|
delimiters: STRING = {{ }}
|
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
datapower.ConfigurationZipSpec
| Type Hierarchy | udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
DataPower configuration in ZIP format
| Public properties | ||
|---|---|---|
|
|
|
checksum: STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
credentials:
CI<credentials.Credentials>
|
|
Credentials of the URI.
|
||
|
|
|
deploymentPolicy: STRING
|
|
Deployment policy to apply during import (string) default()
|
||
|
|
|
excludeFileNamesRegex: STRING
|
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
|
excludeFileNamesRegexToTranscode: STRING
|
|
A regex of file type that needs to be ignored for transcode
|
||
|
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
|
Specifies file encodings in this artifact. Key: regular expression matching file names; value: character set. Character set encoding is used for placeholder replacement and transcoding files to z/OS.
|
||
|
|
|
fileUri: STRING
|
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
|
isRescanned: BOOLEAN
|
|
Indicates if the artifact has been rescanned
|
||
|
|
|
overwriteFiles: STRING
|
|
If files defined on the DataPower device do not match the files in the import and this property is true, then the files on the device will be overwritten (boolean) default(true)
|
||
|
|
|
overwriteObjects: STRING
|
|
If objects defined on the DataPower device do not match the objects in the configuration file and this property is true, then the objects on the device will be overwritten (boolean) default(true)
|
||
|
|
|
placeholders: SET_OF_STRING
|
|
Placeholders detected in this artifact
|
||
|
|
|
preScannedPlaceholders: BOOLEAN
|
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
|
proxySettings:
CI<credentials.ProxySettings>
|
|
Proxy Settings for artifact location
|
||
|
|
|
scanPlaceholders: BOOLEAN
|
|
Whether to scan this artifact to replace placeholders when it is imported
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
textFileNamesRegexToTranscode: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
|
Regular expression that matches file names of text files to transcode to EBCDIC
|
| Hidden properties | ||
|---|---|---|
|
|
|
textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
|
Regular expression that matches file names of text files
|
||
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
The set of CI templates.
|
||
|
|
|
delimiters: STRING = {{ }}
|
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
datapower.File
| Type Hierarchy | udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
DataPower file uploader
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
fileName: STRING
|
|
Specifies the location of where to upload the file on the DataPower filesystem and how to name it. Ex. image:///logo.png
|
||
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
placeholders: MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
datapower.FileSpec
| Type Hierarchy | udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
DataPower file copy
| Public properties | ||
|---|---|---|
|
|
|
checksum: STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
credentials:
CI<credentials.Credentials>
|
|
Credentials of the URI.
|
||
|
|
|
excludeFileNamesRegex: STRING
|
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
|
excludeFileNamesRegexToTranscode: STRING
|
|
A regex of file type that needs to be ignored for transcode
|
||
|
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
|
Specifies file encodings in this artifact. Key: regular expression matching file names; value: character set. Character set encoding is used for placeholder replacement and transcoding files to z/OS.
|
||
|
|
|
fileName: STRING
|
|
Specifies the location of where to upload the file on the DataPower filesystem and how to name it. Ex. image:///logo.png (string)
|
||
|
|
|
fileUri: STRING
|
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
|
isRescanned: BOOLEAN
|
|
Indicates if the artifact has been rescanned
|
||
|
|
|
placeholders: SET_OF_STRING
|
|
Placeholders detected in this artifact
|
||
|
|
|
preScannedPlaceholders: BOOLEAN
|
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
|
proxySettings:
CI<credentials.ProxySettings>
|
|
Proxy Settings for artifact location
|
||
|
|
|
scanPlaceholders: BOOLEAN = true
|
|
Whether to scan this artifact to replace placeholders when it is imported
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
textFileNamesRegexToTranscode: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
|
Regular expression that matches file names of text files to transcode to EBCDIC
|
| Hidden properties | ||
|---|---|---|
|
|
|
textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
|
Regular expression that matches file names of text files
|
||
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
The set of CI templates.
|
||
|
|
|
delimiters: STRING = {{ }}
|
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
datapower.ImportedConfigurationBase
| Virtual Type | |
|---|---|
| Type Hierarchy | udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Shared properties and impementation for DataPower configuration import deployables
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
deploymentPolicy: STRING
|
|
Deployment policy to apply during import
|
||
|
|
|
overwriteFiles: BOOLEAN = true
|
|
If files defined on the DataPower device do not match the files in the import and this property is true, then the files on the device will be overwritten
|
||
|
|
|
overwriteObjects: BOOLEAN = true
|
|
If objects defined on the DataPower device do not match the objects in the configuration file and this property is true, then the objects on the device will be overwritten
|
||
|
|
|
placeholders: MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
datapower.ImportedConfigurationXml
| Type Hierarchy | datapower.ImportedConfigurationBase >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Imports DataPower configuration file in XML format
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
deploymentPolicy: STRING
|
|
Deployment policy to apply during import
|
||
|
|
|
overwriteFiles: BOOLEAN = true
|
|
If files defined on the DataPower device do not match the files in the import and this property is true, then the files on the device will be overwritten
|
||
|
|
|
overwriteObjects: BOOLEAN = true
|
|
If objects defined on the DataPower device do not match the objects in the configuration file and this property is true, then the objects on the device will be overwritten
|
||
|
|
|
placeholders: MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
| Hidden properties | ||
|---|---|---|
|
|
|
importType: STRING = XML
|
|
Import Type
|
||
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
datapower.ImportedConfigurationZip
| Type Hierarchy | datapower.ImportedConfigurationBase >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Imports DataPower configuration file in ZIP format
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
deploymentPolicy: STRING
|
|
Deployment policy to apply during import
|
||
|
|
|
overwriteFiles: BOOLEAN = true
|
|
If files defined on the DataPower device do not match the files in the import and this property is true, then the files on the device will be overwritten
|
||
|
|
|
overwriteObjects: BOOLEAN = true
|
|
If objects defined on the DataPower device do not match the objects in the configuration file and this property is true, then the objects on the device will be overwritten
|
||
|
|
|
placeholders: MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
| Hidden properties | ||
|---|---|---|
|
|
|
importType: STRING = ZIP
|
|
Import Type
|
||
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
datapower.Server
| Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Container, udm.Taggable |
IBM DataPower server
| Public properties | ||
|---|---|---|
|
|
|
domainName: STRING
|
|
DataPower domain name
|
||
|
|
|
hostname: STRING
|
|
DataPower server address
|
||
|
|
|
password: STRING
|
|
Password to use when logging into DataPower
|
||
|
|
|
port: STRING = 5550
|
|
DataPower server port number
|
||
|
|
|
username: STRING
|
|
User name to use when logging into DataPower
|
||
|
|
|
disableSslVerification: BOOLEAN
|
|
Disable SSL verification
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|