UDM CI Reference 7.0.x
CI Reference
Configuration Item Overview
Deployables
CI | Description |
---|---|
udm.BaseDeployable | The supertype of all Deployables |
udm.BaseDeployableArchiveArtifact | An archive artifact that can be deployed |
udm.BaseDeployableArtifact | The supertype of all DeployableArtifacts |
udm.BaseDeployableFileArtifact | A file artifact that can be deployed |
udm.BaseDeployableFolderArtifact | A folder artifact that can be deployed |
udm.BaseProvisionable | Base type for all provisionables |
Deployeds
CI | Description |
---|---|
udm.BaseDeployed | The supertype of all Deployeds |
udm.BaseDeployedArtifact | The supertype of all DeployedArtifacts |
udm.BaseProvisioned | Base type for all provisioneds |
udm.BaseProvisionedContainer | Base type for all provisioneds that are containers |
Containers
CI | Description |
---|---|
udm.BaseContainer | The supertype of all Containers |
udm.BaseProvisionedContainer | Base type for all provisioneds that are containers |
Other Configuration Items
CI | Description |
---|---|
core.Directory | A Group of configuration items |
udm.Application | An application |
udm.BaseAppliedProvisioner | Description unavailable |
udm.BaseAppliedProvisionerArtifact | Description unavailable |
udm.BaseConfigurationItem | Default implementation of a CI that provides ID, name and type information |
udm.BaseEmbeddedDeployable | The supertype of all EmbeddedDeployables |
udm.BaseEmbeddedDeployed | The supertype of all EmbeddedDeployeds |
udm.BaseProvisioner | Base type for all provisioners |
udm.BaseProvisionerArtifact | Base type for all provisioners artifacts |
udm.CompositePackage | (Deprecated) A container of DeploymentPackages that is a DeploymentPackage itself |
udm.Configuration | Contains deployment configuration information |
udm.DeployedApplication | A deployment of an application package or a deployable artifact to a middleware CI or an environment |
udm.DeploymentPackage | A package of a certain version of an application |
udm.Dictionary | A Dictionary contains key-value pairs that can be replaced |
udm.EmbeddedDeployableArtifact | Description unavailable |
udm.EmbeddedDeployedArtifact | Description unavailable |
udm.EncryptedDictionary | An EncryptedDictionary contains keys and encrypted values that can be replaced |
udm.Environment | Groups infrastructure CIs and dictionaries and serves as a target for deployment |
udm.Parameters | Default implementation of a CI that provides ID, name and type information |
udm.ProvisioningPackage | A package of a certain version of an application |
udm.Template | Base type for all generated template CIs |
udm.Version | A version of an application |
Configuration Item Details
core.Directory
Interfaces | core.Securable, udm.ConfigurationItem |
---|
A Group of configuration items
udm.Application
Interfaces | udm.ConfigurationItem |
---|
An application. Each version of the application is a separate package.
Public Properties | ||
---|---|---|
|
|
lastVersion
:
STRING
=
|
The latest application version number as the highest udm.Version name sorted in lexicographical ordering.
|
udm.BaseAppliedProvisioner
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem |
Interfaces | udm.EmbeddedDeployedContainer, udm.EmbeddedDeployed, udm.ConfigurationItem, udm.AppliedProvisioner |
Description unavailable
Parent | ||
---|---|---|
|
|
container
:
CI<udm.EmbeddedDeployedContainer>
|
The (embedded) deployed which contains this embedded deployed.
|
Public Properties | ||
---|---|---|
|
|
deployable
:
CI<udm.EmbeddedDeployable>
|
The embedded deployable that this embedded deployed is derived from.
|
udm.BaseAppliedProvisionerArtifact
Virtual Type | |
---|---|
Type Hierarchy | udm.EmbeddedDeployedArtifact >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem |
Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.EmbeddedDeployed, udm.Artifact, udm.ConfigurationItem, udm.AppliedProvisioner |
Description unavailable
Parent | ||
---|---|---|
|
|
container
:
CI<udm.EmbeddedDeployedContainer>
|
The (embedded) deployed which contains this embedded deployed.
|
Public Properties | ||
---|---|---|
|
|
deployable
:
CI<udm.EmbeddedDeployable>
|
The embedded deployable that this embedded deployed is derived from.
|
||
|
|
placeholders
:
MAP_STRING_STRING
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
udm.BaseConfigurationItem
Default implementation of a CI that provides ID, name and type information.
udm.BaseContainer
Virtual Type | |
---|---|
Interfaces | udm.Container, udm.ConfigurationItem, udm.Taggable |
The supertype of all Containers.
Public Properties | ||
---|---|---|
|
|
tags
:
SET_OF_STRING
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
udm.BaseDeployable
Virtual Type | |
---|---|
Interfaces | udm.ConfigurationItem, udm.Taggable, udm.Deployable |
The supertype of all Deployables.
Public Properties | ||
---|---|---|
|
|
tags
:
SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
udm.BaseDeployableArchiveArtifact
Virtual Type | |
---|---|
Type Hierarchy | 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 |
An archive artifact that can be deployed
Public Properties | ||
---|---|---|
|
|
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
|
||
|
|
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
= 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
|
udm.BaseDeployableArtifact
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem |
Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable |
The supertype of all DeployableArtifacts.
Public Properties | ||
---|---|---|
|
|
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
|
||
|
|
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
|
udm.BaseDeployableFileArtifact
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
Interfaces | udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact |
A file artifact that can be deployed
Public Properties | ||
---|---|---|
|
|
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
|
||
|
|
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
|
udm.BaseDeployableFolderArtifact
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
Interfaces | udm.FolderArtifact, udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.DeployableArtifact, udm.Deployable |
A folder artifact that can be deployed
Public Properties | ||
---|---|---|
|
|
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
|
||
|
|
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
|
udm.BaseDeployed
Virtual Type | |
---|---|
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem |
The supertype of all Deployeds.
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.
|
udm.BaseDeployedArtifact
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployed >> udm.BaseConfigurationItem |
Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem |
The supertype of all DeployedArtifacts.
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.
|
||
|
|
placeholders
:
MAP_STRING_STRING
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
udm.BaseEmbeddedDeployable
Virtual Type | |
---|---|
Interfaces | udm.EmbeddedDeployable, udm.ConfigurationItem |
The supertype of all EmbeddedDeployables.
udm.BaseEmbeddedDeployed
Virtual Type | |
---|---|
Interfaces | udm.EmbeddedDeployedContainer, udm.EmbeddedDeployed, udm.ConfigurationItem |
The supertype of all EmbeddedDeployeds.
Parent | ||
---|---|---|
|
|
container
:
CI<udm.EmbeddedDeployedContainer>
|
The (embedded) deployed which contains this embedded deployed.
|
Public Properties | ||
---|---|---|
|
|
deployable
:
CI<udm.EmbeddedDeployable>
|
The embedded deployable that this embedded deployed is derived from.
|
udm.BaseProvisionable
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem |
Interfaces | udm.Provisionable, udm.ConfigurationItem, udm.Taggable, udm.Deployable |
Base type for all provisionables.
Children | ||
---|---|---|
|
|
provisioners
:
LIST_OF_CI<udm.Provisioner>
|
A list of provisioners associated with the instance.
|
Public Properties | ||
---|---|---|
|
|
|
The set of CI templates.
|
||
|
|
cardinality
:
STRING
= 1
|
Number of instances to launch.
|
||
|
|
tags
:
SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
udm.BaseProvisioned
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployed >> udm.BaseConfigurationItem |
Interfaces | udm.EmbeddedDeployedContainer, udm.Provisioned, udm.Deployed, udm.ConfigurationItem |
Base type for all provisioneds.
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
= 0
|
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.
|
udm.BaseProvisionedContainer
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseProvisioned >> udm.BaseDeployed >> udm.BaseConfigurationItem |
Interfaces | udm.EmbeddedDeployedContainer, udm.Provisioned, udm.Deployed, udm.Container, udm.ConfigurationItem, udm.Taggable |
Base type for all provisioneds that are containers.
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
= 0
|
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.
|
udm.BaseProvisioner
Virtual Type | |
---|---|
Interfaces | udm.Provisioner, udm.EmbeddedDeployable, udm.ConfigurationItem |
Base type for all provisioners.
Public Properties | ||
---|---|---|
|
|
|
Host template on which provisioning actions will be executed.
|
udm.BaseProvisionerArtifact
Virtual Type | |
---|---|
Type Hierarchy | udm.EmbeddedDeployableArtifact >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem |
Interfaces | udm.Provisioner, udm.EmbeddedDeployable, udm.SourceArtifact, udm.Artifact, udm.ConfigurationItem |
Base type for all provisioners artifacts.
Public Properties | ||
---|---|---|
|
|
|
Host template on which provisioning actions will be executed.
|
||
|
|
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
|
||
|
|
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
|
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
|
udm.CompositePackage
Type Hierarchy | udm.Version >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.ConfigurationItem |
(Deprecated) A container of DeploymentPackages that is a DeploymentPackage itself.
Parent | ||
---|---|---|
|
|
|
The application this version belongs to.
|
Public Properties | ||
---|---|---|
|
|
orchestrator
:
LIST_OF_STRING
|
The orchestrators that are used to create the deployment plan. Orchestrators will be applied in order.
|
||
|
|
|
The DeploymentPackages that make up this CompositePackage.
|
Hidden Properties | ||
---|---|---|
|
|
exportAllPasswords
:
BOOLEAN
= false
|
If this is true, all password properties are exported as plaintext while exporting the package. If false, exportOnlyPasswordPlaceholders is considered.
|
||
|
|
exportOnlyPasswordPlaceholders
:
BOOLEAN
= true
|
If this is true, all password properties whose value starts and ends with double curly braces are exported as plaintext. Else, the password values are discarded while exporting the package.
|
||
|
|
ignoreUndefinedPropertiesInManifest
:
BOOLEAN
= true
|
Whether to ignore all the undefined properties used in the manifest or to raise an error, while importing a package.
|
udm.Configuration
Virtual Type | |
---|---|
Interfaces | udm.ConfigurationItem |
Contains deployment configuration information
udm.DeployedApplication
Interfaces | udm.ConfigurationItem |
---|
A deployment of an application package or a deployable artifact to a middleware CI or an environment.
Parent | ||
---|---|---|
|
|
|
Environment
|
Public Properties | ||
---|---|---|
|
|
deployeds
:
SET_OF_CI<udm.Deployed>
|
The items that were deployed to the environment.
|
||
|
|
|
The package that was deployed to the environment
|
||
|
|
boundConfigurationItems
:
SET_OF_CI<udm.ConfigurationItem>
|
Configuration items resolved from templates on the provisioning package.
|
||
|
|
optimizePlan
:
BOOLEAN
= true
|
Optimize the generated plan after orchestration.
|
||
|
|
orchestrator
:
LIST_OF_STRING
|
The orchestrators that are used to create the deployment plan. Orchestrators will be applied in order.
|
||
|
|
provisioningId
:
STRING
|
The unique, generated ID that identifies this provisioning.
|
||
|
|
undeployDependencies
:
BOOLEAN
= false
|
Undeploy direct or transient dependencies of this application. A dependent application is undeployed if no other applications depend on it.
|
||
|
|
unresolvedPlaceholders
:
MAP_STRING_STRING
|
Placeholders provided by the user at provisioning.
|
udm.DeploymentPackage
Type Hierarchy | udm.Version >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.ConfigurationItem |
A package of a certain version of an application. Groups all deployable artifact CIs for an application for a certain version. Is contained by the Application CI.
Parent | ||
---|---|---|
|
|
|
The application this version belongs to.
|
Children | ||
---|---|---|
|
|
deployables
:
SET_OF_CI<udm.Deployable>
|
The set of deployables that are part of this package
|
Public Properties | ||
---|---|---|
|
|
dependencyResolution
:
STRING
= LATEST
|
The resolution to use for application dependencies when deploying this application. Should be 'LATEST' or 'EXISTING'. A placeholder can be used.
|
||
|
|
applicationDependencies
:
MAP_STRING_STRING
|
The versions of other applications that this package depends on, as a mapping from application name to version range
|
||
|
|
orchestrator
:
LIST_OF_STRING
|
The orchestrators that are used to create the deployment plan. Orchestrators will be applied in order.
|
||
|
|
undeployDependencies
:
STRING
= false
|
Whether to undeploy direct or transient dependencies of this application. Dependency is undeployed if there are not other application that depend on it. Should be 'true' or 'false'. A placeholder can be used.
|
Hidden Properties | ||
---|---|---|
|
|
exportAllPasswords
:
BOOLEAN
= false
|
If this is true, all password properties are exported as plaintext while exporting the package. If false, exportOnlyPasswordPlaceholders is considered.
|
||
|
|
exportOnlyPasswordPlaceholders
:
BOOLEAN
= true
|
If this is true, all password properties whose value starts and ends with double curly braces are exported as plaintext. Else, the password values are discarded while exporting the package.
|
||
|
|
ignoreUndefinedPropertiesInManifest
:
BOOLEAN
= true
|
Whether to ignore all the undefined properties used in the manifest or to raise an error, while importing a package.
|
udm.Dictionary
Interfaces | udm.ConfigurationItem |
---|
A Dictionary contains key-value pairs that can be replaced
Public Properties | ||
---|---|---|
|
|
encryptedEntries
:
MAP_STRING_STRING
|
The encrypted dictionary entries
|
||
|
|
entries
:
MAP_STRING_STRING
|
The dictionary entries
|
||
|
|
|
Only apply this dictionary to the applications mentioned
|
||
|
|
restrictToContainers
:
SET_OF_CI<udm.Container>
|
Only apply this dictionary to the containers mentioned
|
udm.EmbeddedDeployableArtifact
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem |
Interfaces | udm.SourceArtifact, udm.EmbeddedDeployable, udm.Artifact, udm.ConfigurationItem |
Description unavailable
Public Properties | ||
---|---|---|
|
|
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
|
||
|
|
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
|
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
|
udm.EmbeddedDeployedArtifact
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem |
Interfaces | udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.EmbeddedDeployed, udm.Artifact, udm.ConfigurationItem |
Description unavailable
Parent | ||
---|---|---|
|
|
container
:
CI<udm.EmbeddedDeployedContainer>
|
The (embedded) deployed which contains this embedded deployed.
|
Public Properties | ||
---|---|---|
|
|
deployable
:
CI<udm.EmbeddedDeployable>
|
The embedded deployable that this embedded deployed is derived from.
|
||
|
|
placeholders
:
MAP_STRING_STRING
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
udm.EncryptedDictionary
Type Hierarchy | udm.Dictionary >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.ConfigurationItem |
An EncryptedDictionary contains keys and encrypted values that can be replaced. Values are encrypted when they are stored and decrypted before being used.
Public Properties | ||
---|---|---|
|
|
entries
:
MAP_STRING_STRING
|
The dictionary entries
|
||
|
|
|
Only apply this dictionary to the applications mentioned
|
||
|
|
restrictToContainers
:
SET_OF_CI<udm.Container>
|
Only apply this dictionary to the containers mentioned
|
Hidden Properties | ||
---|---|---|
|
|
encryptedEntries
:
MAP_STRING_STRING
|
The encrypted dictionary entries
|
udm.Environment
Interfaces | udm.ConfigurationItem |
---|
Groups infrastructure CIs and dictionaries and serves as a target for deployment.
Public Properties | ||
---|---|---|
|
|
|
The dictionaries providing placeholder values. If the same entry exists in multiple dictionaries, the first one in the list is taken.
|
||
|
|
directoryPath
:
STRING
|
The directory path where the provisioned environment and provisioned configuration items will be stored.
|
||
|
|
members
:
SET_OF_CI<udm.Container>
|
The infrastructure components of this Environment
|
||
|
|
smtpServer
:
CI<mail.SmtpServer>
|
The SMTP server used to send mails with when deploying to this Environment.
|
udm.Parameters
Interfaces | udm.ConfigurationItem |
---|
Default implementation of a CI that provides ID, name and type information.
udm.ProvisioningPackage
Type Hierarchy | udm.DeploymentPackage >> udm.Version >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.ConfigurationItem |
A package of a certain version of an application. Groups all provisionable artifact CIs for an application for a certain version. Is contained by the Application CI.
Parent | ||
---|---|---|
|
|
|
The application this version belongs to.
|
Children | ||
---|---|---|
|
|
deployables
:
SET_OF_CI<udm.Deployable>
|
The set of provisionables and deployables that are part of this package
|
||
|
|
|
The set of CI templates.
|
Public Properties | ||
---|---|---|
|
|
dependencyResolution
:
STRING
= LATEST
|
The resolution to use for application dependencies when deploying this application. Should be 'LATEST' or 'EXISTING'. A placeholder can be used.
|
||
|
|
applicationDependencies
:
MAP_STRING_STRING
|
The versions of other applications that this package depends on, as a mapping from application name to version range
|
||
|
|
|
The set of CI bound templates.
|
||
|
|
orchestrator
:
LIST_OF_STRING
|
The orchestrators that are used to create the deployment plan. Orchestrators will be applied in order.
|
||
|
|
undeployDependencies
:
STRING
= false
|
Whether to undeploy direct or transient dependencies of this application. Dependency is undeployed if there are not other application that depend on it. Should be 'true' or 'false'. A placeholder can be used.
|
Hidden Properties | ||
---|---|---|
|
|
exportAllPasswords
:
BOOLEAN
= false
|
If this is true, all password properties are exported as plaintext while exporting the package. If false, exportOnlyPasswordPlaceholders is considered.
|
||
|
|
exportOnlyPasswordPlaceholders
:
BOOLEAN
= true
|
If this is true, all password properties whose value starts and ends with double curly braces are exported as plaintext. Else, the password values are discarded while exporting the package.
|
||
|
|
ignoreUndefinedPropertiesInManifest
:
BOOLEAN
= true
|
Whether to ignore all the undefined properties used in the manifest or to raise an error, while importing a package.
|
udm.Template
Virtual Type | |
---|---|
Interfaces | udm.ConfigurationItem |
Base type for all generated template CIs.
Children | ||
---|---|---|
|
|
|
Child templates associated with this template.
|
Public Properties | ||
---|---|---|
|
|
instanceName
:
STRING
|
Name that the created instance of this template will have. If not specified, the instance name will be generated based on the template name and provisioning ID.
|
udm.Version
Virtual Type | |
---|---|
Interfaces | udm.ConfigurationItem |
A version of an application .
Parent | ||
---|---|---|
|
|
|
The application this version belongs to.
|
Public Properties | ||
---|---|---|
|
|
orchestrator
:
LIST_OF_STRING
|
The orchestrators that are used to create the deployment plan. Orchestrators will be applied in order.
|
Hidden Properties | ||
---|---|---|
|
|
exportAllPasswords
:
BOOLEAN
= false
|
If this is true, all password properties are exported as plaintext while exporting the package. If false, exportOnlyPasswordPlaceholders is considered.
|
||
|
|
exportOnlyPasswordPlaceholders
:
BOOLEAN
= true
|
If this is true, all password properties whose value starts and ends with double curly braces are exported as plaintext. Else, the password values are discarded while exporting the package.
|
||
|
|
ignoreUndefinedPropertiesInManifest
:
BOOLEAN
= true
|
Whether to ignore all the undefined properties used in the manifest or to raise an error, while importing a package.
|