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
    • Import the configuration on server
    • Persist the imported configuration
    datapower.ImportedConfigurationXml
    • Import the configuration on server
    • Persist the imported configuration
    datapower.File
    • Upload file to server
    • Remove file from server
    • Upload file to server

    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

    Other Configuration Items

    CI Description
    datapower.ConfigurationXmlSpec DataPower configuration in XML format
    datapower.ConfigurationZipSpec DataPower configuration in ZIP format
    datapower.File DataPower file uploader
    datapower.FileSpec DataPower file copy
    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
    datapower.Server IBM DataPower server

    Configuration Item Details

    datapower.ConfigurationXmlSpec

    Type Hierarchy udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact

    DataPower configuration in XML format

    Children
     
     
    provisioners : LIST_OF_CI<udm.Provisioner>
    A list of provisioners associated with the instance.
    Public Properties
     
     
    boundTemplates : SET_OF_CI<udm.Template>
    The set of CI templates.
     
     
    cardinality : STRING  = 1
    Number of instances to launch.
     
     
    checksum : STRING
    The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
     
     
    deploymentPolicy : STRING
    Deployment policy to apply during import (string) default(none)
     
     
    excludeFileNamesRegex : STRING
    Regular expression that matches file names that must be excluded from scanning
     
     
    fileUri : STRING
    The URI pointing to the (remote) location of the file this artifact represents
     
     
    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
     
     
    scanPlaceholders : BOOLEAN  = true
    Whether to scan this artifact for placeholders when it is imported
     
     
    tags : SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
    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
     
     
    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
     
     
    fileEncodings : MAP_STRING_STRING  = {.+\.properties=ISO-8859-1}
    A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

    datapower.ConfigurationZipSpec

    Type Hierarchy udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.ArchiveArtifact, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact

    DataPower configuration in ZIP format

    Children
     
     
    provisioners : LIST_OF_CI<udm.Provisioner>
    A list of provisioners associated with the instance.
    Public Properties
     
     
    boundTemplates : SET_OF_CI<udm.Template>
    The set of CI templates.
     
     
    cardinality : STRING  = 1
    Number of instances to launch.
     
     
    checksum : STRING
    The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
     
     
    deploymentPolicy : STRING
    Deployment policy to apply during import (string) default(none)
     
     
    excludeFileNamesRegex : STRING
    Regular expression that matches file names that must be excluded from scanning
     
     
    fileUri : STRING
    The URI pointing to the (remote) location of the file this artifact represents
     
     
    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
     
     
    scanPlaceholders : BOOLEAN  = false
    Whether to scan this artifact for placeholders when it is imported
     
     
    tags : SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
    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
     
     
    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
     
     
    fileEncodings : MAP_STRING_STRING  = {.+\.properties=ISO-8859-1}
    A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

    datapower.File

    Type Hierarchy udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

    DataPower file uploader

    Parent
     
     
    container : CI<udm.Container>
    The container on which this deployed runs.
    Children
     
     
    provisioners : LIST_OF_CI<udm.AppliedProvisioner>
    A list of provisioners associated with the instance.
    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
     
     
    ordinal : INTEGER
    The index of the cardinality amount created provisioneds.
     
     
    boundConfigurationItems : SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    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>

    datapower.FileSpec

    Type Hierarchy udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact

    DataPower file copy

    Children
     
     
    provisioners : LIST_OF_CI<udm.Provisioner>
    A list of provisioners associated with the instance.
    Public Properties
     
     
    boundTemplates : SET_OF_CI<udm.Template>
    The set of CI templates.
     
     
    cardinality : STRING  = 1
    Number of instances to launch.
     
     
    checksum : STRING
    The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
     
     
    excludeFileNamesRegex : STRING
    Regular expression that matches file names that must be excluded from scanning
     
     
    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
     
     
    placeholders : SET_OF_STRING
    Placeholders detected in this artifact
     
     
    scanPlaceholders : BOOLEAN  = true
    Whether to scan this artifact for placeholders when it is imported
     
     
    tags : SET_OF_STRING
    If set, this deployable will only be mapped automatically to containers with the same tag.
    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
     
     
    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
     
     
    fileEncodings : MAP_STRING_STRING  = {.+\.properties=ISO-8859-1}
    A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

    datapower.ImportedConfigurationBase

    Virtual Type
    Type Hierarchy udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

    Shared properties and impementation for DataPower configuration import deployables

    Parent
     
     
    container : CI<udm.Container>
    The container on which this deployed runs.
    Children
     
     
    provisioners : LIST_OF_CI<udm.AppliedProvisioner>
    A list of provisioners associated with the instance.
    Public Properties
     
     
    ordinal : INTEGER
    The index of the cardinality amount created provisioneds.
     
     
    boundConfigurationItems : SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    deployable : CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    deploymentPolicy : STRING  = none
    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>

    datapower.ImportedConfigurationXml

    Type Hierarchy datapower.ImportedConfigurationBase >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

    Imports DataPower configuration file in XML format

    Parent
     
     
    container : CI<udm.Container>
    The container on which this deployed runs.
    Children
     
     
    provisioners : LIST_OF_CI<udm.AppliedProvisioner>
    A list of provisioners associated with the instance.
    Public Properties
     
     
    ordinal : INTEGER
    The index of the cardinality amount created provisioneds.
     
     
    boundConfigurationItems : SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    deployable : CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    deploymentPolicy : STRING  = none
    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

    datapower.ImportedConfigurationZip

    Type Hierarchy datapower.ImportedConfigurationBase >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
    Interfaces udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

    Imports DataPower configuration file in ZIP format

    Parent
     
     
    container : CI<udm.Container>
    The container on which this deployed runs.
    Children
     
     
    provisioners : LIST_OF_CI<udm.AppliedProvisioner>
    A list of provisioners associated with the instance.
    Public Properties
     
     
    ordinal : INTEGER
    The index of the cardinality amount created provisioneds.
     
     
    boundConfigurationItems : SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.
     
     
    deployable : CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    deploymentPolicy : STRING  = none
    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

    datapower.Server

    Type Hierarchy udm.BaseContainer >> udm.BaseConfigurationItem
    Interfaces udm.Container, udm.ConfigurationItem, 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  = false
    Disable SSL verification
     
     
    tags : SET_OF_STRING
    If set, only deployables with the same tag will be automatically mapped to this container.