XL Deploy Provisioning Reference

    CI Reference

    Configuration Item Overview

    Deployables

    CI Description
    upm.Provisionable Base type for all provisionables

    Deployeds

    CI Description
    upm.Provisioned Base type for all provisioneds

    Containers

    CI Description
    upm.Provider Base type for all provisioning providers

    Other Configuration Items

    CI Description
    upm.AppliedProvisioner Applied provisioner
    upm.BaseEmbeddedProvisionable Base type for an embedded provisionable
    upm.BaseEmbeddedProvisioned Base type for an embedded provisioned
    upm.Blueprint A plan consisting of provisioning packages
    upm.Dictionary Contains key-value pairs that are used to populate placeholders in provisioneds
    upm.Provider Base type for all provisioning providers
    upm.Provisionable Base type for all provisionables
    upm.Provisioned Base type for all provisioneds
    upm.ProvisionedBlueprint A provisioned blueprint of a provisioning package to a provisioning environment
    upm.Provisioner Base type for all provisioners
    upm.ProvisioningEnvironment Groups provisioning providers and dictionaries and serves as a target for provisioning
    upm.ProvisioningPackage A provisioning package contains provisionables and templates that, when mapped to a provisioning environment, will create CIs in the infrastructure
    upm.Template Base type for all generated template CIs

    Configuration Item Details

    upm.AppliedProvisioner

    Virtual Type
    Type Hierarchy udm.EmbeddedDeployedArtifact >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
    Interfaces udm.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.EmbeddedDeployed, udm.Artifact, udm.ConfigurationItem

    Applied provisioner

    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>

    upm.BaseEmbeddedProvisionable

    Virtual Type
    Interfaces udm.EmbeddedDeployable, udm.ConfigurationItem

    Base type for an embedded provisionable.


    upm.BaseEmbeddedProvisioned

    Virtual Type
    Interfaces udm.EmbeddedDeployedContainer, udm.EmbeddedDeployed, udm.ConfigurationItem

    Base type for an embedded provisioned.

    Parent
     
     
    provisioned : CI<udm.EmbeddedDeployedContainer>
    The provider on which this provisioned runs.
    Public Properties
     
     
    provisionable : CI<udm.EmbeddedDeployable>
    The provisionable from which this provisioned is derived.

    upm.Blueprint

    Type Hierarchy xld.Distribution >> udm.BaseConfigurationItem
    Interfaces udm.ConfigurationItem

    A plan consisting of provisioning packages. Each version of blueprint is a separate package.

    Public Properties
     
     
    lastVersion : STRING  = 
    The latest application version number as the highest udm.Version name sorted in lexicographical ordering.

    upm.Dictionary

    Type Hierarchy xld.BaseDictionary >> udm.BaseConfigurationItem
    Interfaces udm.ConfigurationItem

    Contains key-value pairs that are used to populate placeholders in provisioneds.

    Public Properties
     
     
    encryptedEntries : MAP_STRING_STRING
    The encrypted dictionary entries
     
     
    entries : MAP_STRING_STRING
    The dictionary entries
     
     
    restrictToBlueprints : SET_OF_CI<upm.Blueprint >
    Only apply this dictionary to the blueprints mentioned
     
     
    restrictToProviders : SET_OF_CI<upm.Provider >
    Only apply this dictionary to the providers mentioned

    upm.Provider

    Virtual Type
    Type Hierarchy udm.BaseContainer >> udm.BaseConfigurationItem
    Interfaces udm.Container, udm.ConfigurationItem, udm.Taggable

    Base type for all provisioning providers.

    Public Properties
     
     
    tags : SET_OF_STRING
    If set, only deployables with the same tag will be automatically mapped to this container.

    upm.Provisionable

    Virtual Type
    Type Hierarchy udm.BaseDeployable >> udm.BaseConfigurationItem
    Interfaces udm.ConfigurationItem, udm.Taggable, udm.Deployable

    Base type for all provisionables.

    Children
     
     
    provisioners : LIST_OF_CI<upm.Provisioner >
    A list of provisioners associated with the instance.
    Public Properties
     
     
    boundTemplates : SET_OF_CI<upm.Template >
    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.

    upm.Provisioned

    Virtual Type
    Interfaces udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

    Base type for all provisioneds.

    Parent
     
     
    provider : CI<upm.Provider >
    The provider on which this provisioned runs.
    Children
     
     
    provisioners : LIST_OF_CI<upm.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.
     
     
    provisionable : CI<upm.Provisionable >
    The provisionable from which this provisioned is derived.

    upm.ProvisionedBlueprint

    Type Hierarchy xld.AppliedDistribution >> udm.BaseConfigurationItem
    Interfaces udm.ConfigurationItem

    A provisioned blueprint of a provisioning package to a provisioning environment.

    Parent
     
     
    provisioningEnvironment : CI<upm.ProvisioningEnvironment >
    Provisioning Environment
    Public Properties
     
     
    environmentName : STRING
    The environment name of the the to be provisioned environment
     
     
    provisioneds : SET_OF_CI<udm.Deployed>
    The provisioned items that were provisioned to the provisioning environment.
     
     
    provisioningId : STRING
    The id generated for by XLD to distinguish this provisioning
     
     
    provisioningPackage : CI<upm.ProvisioningPackage >
    The package that was provisioned to the provisioning environment.
     
     
    boundConfigurationItems : SET_OF_CI<udm.ConfigurationItem>
    Resolved configuration items from templates on provisioning package
     
     
    directoryPath : STRING
    The directory path where the provisioned environment and provisioned configuration items will be stored.
     
     
    optimizePlan : BOOLEAN  = true
    Whether to 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.
     
     
    provisionedEnvironment : CI<udm.Environment>
    The environment that was provisioned.
     
     
    unresolvedPlaceholders : MAP_STRING_STRING
    Placeholders provided by the user at provisioning.

    upm.Provisioner

    Virtual Type
    Type Hierarchy udm.EmbeddedDeployableArtifact >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
    Interfaces udm.SourceArtifact, udm.EmbeddedDeployable, udm.Artifact, udm.ConfigurationItem

    Base type for all provisioners.

    Public Properties
     
     
    hostTemplate : CI<upm.Template >
    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

    upm.ProvisioningEnvironment

    Type Hierarchy xld.Domain >> udm.BaseConfigurationItem
    Interfaces udm.ConfigurationItem

    Groups provisioning providers and dictionaries and serves as a target for provisioning.

    Public Properties
     
     
    dictionaries : LIST_OF_CI<upm.Dictionary >
    The dictionaries providing placeholder values. If the same entry exists in multiple dictionaries, the first one in the list is used.
     
     
    providers : SET_OF_CI<upm.Provider >
    The provisioning providers of this provisioning environment.

    upm.ProvisioningPackage

    Type Hierarchy xld.DistributionVersion >> udm.BaseConfigurationItem
    Interfaces udm.ConfigurationItem

    A provisioning package contains provisionables and templates that, when mapped to a provisioning environment, will create CIs in the infrastructure.

    Parent
     
     
    blueprint : CI<upm.Blueprint >
    The blueprint to which this provisioning package belongs.
    Children
     
     
    provisionables : SET_OF_CI<upm.Provisionable >
    The set of provisionables that are part of this package.
     
     
    templates : SET_OF_CI<upm.Template >
    The set of CI templates.
    Public Properties
     
     
    orchestrator : LIST_OF_STRING  = [provisioning]
    The orchestrators that are used to create the deployment plan. Orchestrators will be applied in order.
     
     
    boundTemplates : SET_OF_CI<upm.Template >
    The set of CI bound templates.
     
     
    directoryPath : STRING
    The directory path where the provisioned environment and provisioned configuration items will be stored.
     
     
    environmentName : STRING
    The environment name of the to be provisioned environment
    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.

    upm.Template

    Virtual Type
    Interfaces udm.ConfigurationItem

    Base type for all generated template CIs.

    Children
     
     
    childTemplates : SET_OF_CI<upm.Template >
    Child templates associated with this template.
    Public Properties
     
     
    instanceName : STRING
    The name that the created instance of this template will have. If not specified, the instance name will be generated based on template name, cardinality and provisioned environment name