Script Plugin Manual 7.5.x

    The XL Deploy Script plugin uses the ssh to execute local script files on hosts.

    This document provides information that is specific to this version of the Script plugin. For general information about the plugin, refer to Introduction to the XL Deploy Script plugin.


    • XL Deploy 7.0.0 or later


    • The plugin does not support deployments on Microsoft Windows-based hosts

    Release notes

    Script plugin 7.5.0


    • [DEPL-11930] - Fix step ordering following standards for cloud and container plugins

    Script plugin 7.0.0

    Initial release

    CI Reference

    Configuration Item Overview


    script.Script Script file applied on the host.


    script.ExecutedScript Script applied on the host.

    Configuration Item Details


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

    Script applied on the host.

    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.
    executeOnNoop: BOOLEAN
    Execute the script on NOOP state.
    executeOrder: INTEGER = 50
    Order at which the script execution should happen.
    placeholders: MAP_STRING_STRING
    A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>


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

    Script file applied on the host.

      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
    executeOnNoop: STRING
    Execute the script on NOOP state. (boolean) default(false)
    executeOrder: STRING
    Order at which the script execution should happen. (integer) default(50)
    fileUri: STRING
    The URI pointing to the (remote) location of the file this artifact represents
    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)
    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
    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