UDM CI Reference 24.3.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.BaseDeployableContainer | The base supertype for a deployable container. |
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.BaseDeployedContainer | Base type for all deployeds that are containers. |
udm.BaseDeployedInfrastructureAsCode | The supertype for infrastructure as code deployeds with output variables. |
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.BaseDeployableContainer | The base supertype for a deployable container. |
udm.BaseDeployedContainer | Base type for all deployeds that are containers. |
udm.BaseProvisionedContainer | Base type for all provisioneds that are containers. |
Other Configuration Items
CI | Description |
---|---|
core.Directory | A Group of configuration items |
udm.AbstractDictionary | Default implementation of a CI that provides ID, name and type information. |
udm.Application | An application. Each version of the application is a separate package. |
udm.BaseAppliedProvisioner | Description unavailable |
udm.BaseAppliedProvisionerArtifact | Description unavailable |
udm.BaseConfigurationItem | Default implementation of a CI that provides ID, name and type information. |
udm.BaseConfigurationItemWithPolicies | Implementation of a Base CI that provides on success policy. |
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. Groups all deployable artifact CIs for an application for a certain version. Is contained by the Application CI. |
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. Values are encrypted when they are stored and decrypted before being used. |
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. Groups all provisionable artifact CIs for an application for a certain version. Is contained by the Application CI. |
udm.Template | Base type for all generated template CIs. |
udm.Version | A version of an application . |
Configuration Item Details
core.Directory
Interfaces | core.Securable |
---|
A Group of configuration items
udm.AbstractDictionary
Virtual Type | |
---|---|
Interfaces | udm.IDictionary |
Default implementation of a CI that provides ID, name and type information.
Public properties | ||
---|---|---|
|
| |
Only apply this dictionary to the applications mentioned
|
||
|
|
restrictToContainers:
SET_OF_CI<udm.Container>
|
Only apply this dictionary to the containers mentioned
|
udm.Application
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.
|
||
|
|
pipeline:
CI<release.DeploymentPipeline>
|
The deployment pipeline for this application
|
Hidden properties | ||
---|---|---|
|
|
verifyChecklistPermissionsOnCreate: BOOLEAN
|
If true, permissions for changing checklist requirements will be checked on import
|
udm.BaseAppliedProvisioner
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem |
Interfaces | udm.AppliedProvisioner, udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer |
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.AppliedProvisioner, udm.Artifact, udm.DerivedArtifact, udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer |
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
udm.BaseConfigurationItemWithPolicies
Virtual Type |
---|
Implementation of a Base CI that provides on success policy.
Public properties | ||
---|---|---|
|
|
onFailurePolicy: ENUM [NOOP, CANCEL_AND_ARCHIVE]
|
Process failed tasks on CI according to the defined policy.
|
||
|
|
onSuccessPolicy: ENUM [NOOP, ARCHIVE]
|
Process successful tasks on CI according to the defined policy.
|
udm.BaseContainer
Virtual Type | |
---|---|
Interfaces | udm.Container, udm.Taggable |
The supertype of all Containers.
Public properties | ||
---|---|---|
|
|
allowConcurrentDeployments: BOOLEAN = true
|
If set, multiple deployments at the same time can be executed, and a 'collision avoidance' check will not be executed
|
||
|
|
deploymentGroup: INTEGER
|
If the group-orchestrator is enabled, all containers with the same deployment group number will be deployed to at the same time. The groups are ordered by this number.
|
||
|
|
deploymentSubGroup: INTEGER
|
If the sub-group-orchestrator is enabled, all containers with the same deployment SubGroup number will be deployed to at the same time. The groups are ordered by this number.
|
||
|
|
deploymentSubSubGroup: INTEGER
|
If the sub-sub-group-orchestrator is enabled, all containers with the same deployment SubSubGroup number will be deployed to at the same time. The groups are ordered by this number.
|
||
|
|
limitNumberOfConcurrentDeployments: INTEGER = 1
|
Limit number of concurrent deployments
|
||
|
|
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.Deployable, udm.Taggable |
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.
|
Hidden properties | ||
---|---|---|
|
| |
The set of CI templates.
|
udm.BaseDeployableArchiveArtifact
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
Interfaces | udm.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
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.
|
||
|
|
credentials:
CI<credentials.Credentials>
|
Credentials of the URI.
|
||
|
|
excludeFileNamesRegex: STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
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
|
||
|
|
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
|
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.
|
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
|
||
|
| |
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
|
Control task | Parameter CI | Attributes | Description |
---|---|---|---|
rescanArtifacts |
delegate = rescanArtifact |
No description. |
udm.BaseDeployableArtifact
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem |
Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.SourceArtifact, udm.Taggable |
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.
|
||
|
|
credentials:
CI<credentials.Credentials>
|
Credentials of the URI.
|
||
|
|
excludeFileNamesRegex: STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
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
|
||
|
|
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.
|
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
|
||
|
| |
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
|
Control task | Parameter CI | Attributes | Description |
---|---|---|---|
rescanArtifacts |
delegate = rescanArtifact |
No description. |
udm.BaseDeployableContainer
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem |
Interfaces | udm.Container, udm.Deployable, udm.DeployableContainer, udm.Taggable |
The base supertype for a deployable container.
Public properties | ||
---|---|---|
|
|
containerTags: SET_OF_STRING
|
The tags to copy to the Deployed Container
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
Hidden properties | ||
---|---|---|
|
| |
The set of CI templates.
|
udm.BaseDeployableFileArtifact
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
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.
|
||
|
|
credentials:
CI<credentials.Credentials>
|
Credentials of the URI.
|
||
|
|
excludeFileNamesRegex: STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
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
|
||
|
|
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.
|
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
|
||
|
| |
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
|
Control task | Parameter CI | Attributes | Description |
---|---|---|---|
rescanArtifacts |
delegate = rescanArtifact |
No description. |
udm.BaseDeployableFolderArtifact
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FolderArtifact, udm.SourceArtifact, udm.Taggable |
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.
|
||
|
|
credentials:
CI<credentials.Credentials>
|
Credentials of the URI.
|
||
|
|
excludeFileNamesRegex: STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
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
|
||
|
|
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.
|
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
|
||
|
| |
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
|
Control task | Parameter CI | Attributes | Description |
---|---|---|---|
rescanArtifacts |
delegate = rescanArtifact |
No description. |
udm.BaseDeployed
Virtual Type | |
---|---|
Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer |
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.
|
Hidden properties | ||
---|---|---|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
udm.BaseDeployedArtifact
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployed >> udm.BaseConfigurationItem |
Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
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>
|
Hidden properties | ||
---|---|---|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
udm.BaseDeployedContainer
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployed >> udm.BaseConfigurationItem |
Interfaces | udm.Container, udm.Deployed, udm.EmbeddedDeployedContainer, udm.Taggable |
Base type for all deployeds that are containers.
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.
|
||
|
|
deploymentGroup: INTEGER
|
If the group-orchestrator is enabled, all containers with the same deployment group number will be deployed to at the same time. The groups are ordered by this number.
|
||
|
|
deploymentSubGroup: INTEGER
|
If the sub-group-orchestrator is enabled, all containers with the same deployment SubGroup number will be deployed to at the same time. The groups are ordered by this number.
|
||
|
|
deploymentSubSubGroup: INTEGER
|
If the sub-sub-group-orchestrator is enabled, all containers with the same deployment SubSubGroup number will be deployed to at the same time. The groups are ordered by this number.
|
||
|
|
tags: SET_OF_STRING
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
Hidden properties | ||
---|---|---|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
udm.BaseDeployedInfrastructureAsCode
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
The supertype for infrastructure as code deployeds with output variables.
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
|
automaticDictionary: BOOLEAN = true
|
If true, XL Deploy will automatically create a dictionary containing the output variables and add it to the environment.
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
dictionaryPath: STRING
|
Path to the dictionary containing the output variables. If empty, the dictionary name will be the name of the template concatenated with -dictionary. If you specify a dictionary name, it will be created in the same folder as the target environment or in the folder specified for the new environment. You can also specify a full path starting with 'Environments/'.
|
||
|
|
environmentPath: STRING
|
Path to the new environment. If empty, the generated CIs will be added to the target environment. If you specify an environment name, the new environment will be created in the same folder as the target environment. If you specify a folder and an environment name, they will be created in the same folder as the target environment. You can also specify a full path starting with 'Environments/'.
|
||
|
|
generateCIsFromResources: BOOLEAN = true
|
If true, XL Deploy will automatically create CIs based on resources that are deployed.
|
||
|
|
generatedConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
Set of infrastructure resources mapped to configuration items.
|
||
|
|
outputVariables: MAP_STRING_STRING
|
Output variables captured in deployed.
|
||
|
|
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.
|
udm.BaseEmbeddedDeployable
Virtual Type | |
---|---|
Interfaces | udm.EmbeddedDeployable |
The supertype of all EmbeddedDeployables.
udm.BaseEmbeddedDeployed
Virtual Type | |
---|---|
Interfaces | udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer |
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.Deployable, udm.Provisionable, udm.Taggable |
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.
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
Hidden properties | ||
---|---|---|
|
|
cardinality: STRING = 1
|
Number of instances to launch.
|
udm.BaseProvisioned
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployed >> udm.BaseConfigurationItem |
Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer, udm.Provisioned |
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 | ||
---|---|---|
|
| |
The set of created CIs.
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
Hidden properties | ||
---|---|---|
|
|
ordinal: INTEGER = 1
|
The index of the cardinality amount created provisioneds.
|
udm.BaseProvisionedContainer
Virtual Type | |
---|---|
Type Hierarchy | udm.BaseDeployedContainer >> udm.BaseDeployed >> udm.BaseConfigurationItem |
Interfaces | udm.Container, udm.Deployed, udm.EmbeddedDeployedContainer, udm.Provisioned, udm.Taggable |
Base type for all provisioneds that are containers.
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Public properties | ||
---|---|---|
|
| |
The set of created CIs.
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
deploymentGroup: INTEGER
|
If the group-orchestrator is enabled, all containers with the same deployment group number will be deployed to at the same time. The groups are ordered by this number.
|
||
|
|
deploymentSubGroup: INTEGER
|
If the sub-group-orchestrator is enabled, all containers with the same deployment SubGroup number will be deployed to at the same time. The groups are ordered by this number.
|
||
|
|
deploymentSubSubGroup: INTEGER
|
If the sub-sub-group-orchestrator is enabled, all containers with the same deployment SubSubGroup number will be deployed to at the same time. The groups are ordered by this number.
|
||
|
|
tags: SET_OF_STRING
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
Hidden properties | ||
---|---|---|
|
|
ordinal: INTEGER = 1
|
The index of the cardinality amount created provisioneds.
|
udm.BaseProvisioner
Virtual Type | |
---|---|
Interfaces | udm.EmbeddedDeployable, udm.Provisioner |
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.Artifact, udm.EmbeddedDeployable, udm.Provisioner, udm.SourceArtifact |
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.
|
||
|
|
credentials:
CI<credentials.Credentials>
|
Credentials
|
||
|
|
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
|
||
|
|
proxySettings:
CI<credentials.ProxySettings>
|
Credentials
|
||
|
|
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 |
---|
(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
|
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 |
---|
Contains deployment configuration information
udm.DeployedApplication
Type Hierarchy | udm.BaseConfigurationItemWithPolicies >> udm.BaseConfigurationItem |
---|
A deployment of an application package or a deployable artifact to a middleware CI or an environment.
Parent | ||
---|---|---|
|
| |
Environment
|
Public properties | ||
---|---|---|
|
| |
The package that was deployed to the environment
|
||
|
|
allowConcurrentDeployments: BOOLEAN = true
|
If set, multiple deployments at the same time can be executed, and a 'collision avoidance' check will not be executed
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
Configuration items resolved from templates on the provisioning package.
|
||
|
|
deployeds:
SET_OF_CI<udm.Deployed>
|
The items that were deployed to the environment.
|
||
|
|
forceRedeploy: BOOLEAN
|
Deployment overrides existing application completely.
|
||
|
|
onFailurePolicy: ENUM [NOOP, CANCEL_AND_ARCHIVE]
|
Process failed tasks on CI according to the defined policy.
|
||
|
|
onSuccessPolicy: ENUM [NOOP, ARCHIVE]
|
Process successful tasks on CI according to the defined policy.
|
||
|
|
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.
|
||
|
|
undeployDependencies: BOOLEAN
|
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 |
---|
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
|
||
|
| |
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
|
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
Type Hierarchy | udm.AbstractDictionary >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.IDictionary, udm.IEncryptedDictionary |
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.Artifact, udm.EmbeddedDeployable, udm.SourceArtifact |
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.
|
||
|
|
credentials:
CI<credentials.Credentials>
|
Credentials
|
||
|
|
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
|
||
|
|
proxySettings:
CI<credentials.ProxySettings>
|
Credentials
|
||
|
|
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.Artifact, udm.DerivedArtifact, udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer |
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.AbstractDictionary >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.IDictionary, udm.IEncryptedDictionary |
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
Groups infrastructure CIs and dictionaries and serves as a target for deployment.
Public properties | ||
---|---|---|
|
|
lockRetryAttempts: INTEGER = 60
|
Number of retry attempts.
|
||
|
|
lockRetryInterval: INTEGER = 30
|
Seconds to wait before retrying to obtain lock
|
||
|
|
allowConcurrentDeployments: BOOLEAN = true
|
If set, multiple deployments at the same time can be executed, and a 'collision avoidance' check will not be executed
|
||
|
|
dictionaries:
LIST_OF_CI<udm.IDictionary>
|
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.
|
||
|
|
enableLockRetry: BOOLEAN
|
If set, will continually try to obtain lock
|
||
|
|
failWhenCiPropertyMissingPlaceholderValue: BOOLEAN
|
Fail When Ci Property Missing Placeholder Value
|
||
|
|
lockAllContainersInEnvironment: BOOLEAN
|
If set, will lock all container in environment
|
||
|
|
lockRetryAsync: BOOLEAN = true
|
If set to false, retry lock will block the currently executing thread. Note: Using thread blocking is not recommended
|
||
|
|
members:
SET_OF_CI<udm.Container>
|
The infrastructure components of this Environment
|
||
|
|
patchDictionaries:
LIST_OF_CI<udm.PatchDictionary>
|
List of patch dictionaries that apply changes on the deployables.
|
||
|
|
smtpServer:
CI<mail.SmtpServer>
|
The SMTP server used to send mails with when deploying to this Environment.
|
||
|
|
triggers:
LIST_OF_CI<trigger.Trigger>
|
Triggers to fire for deployments carried out to environment
|
Hidden properties | ||
---|---|---|
|
|
recheckConditionsAtDeploymentTimeOrder: INTEGER = 9
|
Recheck Conditions At Deployment Time Order
|
||
|
|
failOnMissingCiRefs: BOOLEAN
|
Skip not existing CIs during deployment.
|
||
|
|
recheckConditionsAtDeploymentTime: BOOLEAN = true
|
If set, release conditions are not just verified before planning begins, an equivalent step is also added to the task
|
udm.Parameters
Default implementation of a CI that provides ID, name and type information.
udm.ProvisioningPackage
Type Hierarchy | udm.DeploymentPackage >> udm.Version >> udm.BaseConfigurationItem |
---|
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
|
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 |
---|
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 |
---|
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
|
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.
|