File Plugin Reference 8.6.x
The XL Deploy File plugin allows you to define file, archive (ZIP), or folder (collection of files) resources in a deployment package and manage them on a target host.
This document provides information that is specific to this version of the File plugin. For general information about the plugin, refer to Introduction to the XL Deploy File plugin.
Using the deployables and deployeds
Deployable vs. container table
The following table describes which deployable/container combinations are possible.
| Deployables | Containers | Generated Deployed |
|---|---|---|
| file.File file.Archive | overthere.Host | file.DeployedFile file.DeployedArchive |
| file.Folder | overthere.Host | file.DeployedFolder |
Note: File plugin configuration items (CIs) can only be targeted to containers that are derived from the overthere.Host CI.
Deployed actions table
The following table describes the effect a deployed has on its container.
| Deployed | Create | Destroy | Modify |
|---|---|---|---|
| file.DeployedFile file.DeployedArchive |
|
|
|
| file.DeployedFolder |
|
|
|
CI Reference
Configuration Item Overview
Deployables
| CI | Description |
|---|---|
| file.Archive | An archive artifact that can be packaged in a Deployment Package. Following archive types are supported: zip, jar, war, ear, tar, tar.gz, tgz, tar.bz2, tbz |
| file.File | A single file artifact that can be packaged in a Deployment Package |
| file.Folder | A folder artifact that can be packaged in a Deployment Package |
Deployeds
| CI | Description |
|---|---|
| file.DeployedArchive | The archive as deployed on the Host. |
| file.DeployedArtifactOnHost | Abstract deployed that can target any DeployableArtifact to a Host. |
| file.DeployedFile | The file as deployed on the Host. |
| file.DeployedFolder | The folder as deployed on the Host. |
Configuration Item Details
file.Archive
| Type Hierarchy | udm.BaseDeployableArchiveArtifact >> 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 packaged in a Deployment Package. Following archive types are supported: zip, jar, war, ear, tar, tar.gz, tgz, tar.bz2, tbz
| Public properties | ||
|---|---|---|
|
|
|
checksum: STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
createTargetPath: STRING
|
|
Create the targetPath on the host if it does not exist.
|
||
|
|
|
credentials:
CI<credentials.Credentials>
|
|
Credentials of the URI.
|
||
|
|
|
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
|
||
|
|
|
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.
|
||
|
|
|
targetFileName: STRING
|
|
Name of the artifact on the host.
|
||
|
|
|
targetPath: STRING
|
|
Path to which artifact must be copied to when being deployed.
|
||
|
|
|
targetPathShared: STRING
|
|
Is the targetPath shared by others on the host. When true, the targetPath is not deleted during undeployment; only the artifacts copied to it.
|
| 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
|
||
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
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
|
||
|
|
|
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
|
file.DeployedArchive
| Type Hierarchy | file.DeployedArtifactOnHost >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
The archive as deployed on the Host.
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
targetPath: STRING
|
|
Path to which artifact must be copied to on the host.
|
||
|
|
|
createTargetPath: BOOLEAN
|
|
Create the targetPath on the host if it does not exist.
|
||
|
|
|
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>
|
||
|
|
|
targetFileName: STRING
|
|
Name of the artifact on the host.
|
||
|
|
|
targetPathShared: BOOLEAN = true
|
|
Is the targetPath shared by others on the host. When true, the targetPath is not deleted during undeployment; only the artifacts copied to it.
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
||
|
|
|
copyDirectlyToTargetPath: BOOLEAN
|
|
If set to true, files are directly copied to the target directory without first being uploaded to the staging or temporary directory (like versions of XL Deploy prior to 4.0.0)
|
||
|
|
|
targetPathSharedSubDirectories: BOOLEAN
|
|
The sub directories on the target machine are not deleted if files other than that copied by XL Deploy are present.
|
file.DeployedArtifactOnHost
| Virtual Type | |
|---|---|
| Type Hierarchy | udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Abstract deployed that can target any DeployableArtifact to a Host.
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
targetPath: STRING
|
|
Path to which artifact must be copied to on the host.
|
||
|
|
|
createTargetPath: BOOLEAN
|
|
Create the targetPath on the host if it does not exist.
|
||
|
|
|
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>
|
||
|
|
|
targetFileName: STRING
|
|
Name of the artifact on the host.
|
||
|
|
|
targetPathShared: BOOLEAN = true
|
|
Is the targetPath shared by others on the host. When true, the targetPath is not deleted during undeployment; only the artifacts copied to it.
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
||
|
|
|
copyDirectlyToTargetPath: BOOLEAN
|
|
If set to true, files are directly copied to the target directory without first being uploaded to the staging or temporary directory (like versions of XL Deploy prior to 4.0.0)
|
||
|
|
|
targetPathSharedSubDirectories: BOOLEAN
|
|
The sub directories on the target machine are not deleted if files other than that copied by XL Deploy are present.
|
file.DeployedFile
| Type Hierarchy | file.DeployedArtifactOnHost >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
The file as deployed on the Host.
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
targetPath: STRING
|
|
Path to which artifact must be copied to on the host.
|
||
|
|
|
createTargetPath: BOOLEAN
|
|
Create the targetPath on the host if it does not exist.
|
||
|
|
|
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>
|
||
|
|
|
targetFileName: STRING
|
|
Name of the artifact on the host.
|
||
|
|
|
targetPathShared: BOOLEAN = true
|
|
Is the targetPath shared by others on the host. When true, the targetPath is not deleted during undeployment; only the artifacts copied to it.
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
||
|
|
|
copyDirectlyToTargetPath: BOOLEAN
|
|
If set to true, files are directly copied to the target directory without first being uploaded to the staging or temporary directory (like versions of XL Deploy prior to 4.0.0)
|
||
|
|
|
targetPathSharedSubDirectories: BOOLEAN
|
|
The sub directories on the target machine are not deleted if files other than that copied by XL Deploy are present.
|
file.DeployedFolder
| Type Hierarchy | file.DeployedArtifactOnHost >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
The folder as deployed on the Host.
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
targetPath: STRING
|
|
Path to which artifact must be copied to on the host.
|
||
|
|
|
createTargetPath: BOOLEAN
|
|
Create the targetPath on the host if it does not exist.
|
||
|
|
|
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>
|
||
|
|
|
targetPathShared: BOOLEAN = true
|
|
Is the targetPath shared by others on the host. When true, the targetPath is not deleted during undeployment; only the artifacts copied to it.
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
||
|
|
|
copyDirectlyToTargetPath: BOOLEAN
|
|
If set to true, files are directly copied to the target directory without first being uploaded to the staging or temporary directory (like versions of XL Deploy prior to 4.0.0)
|
||
|
|
|
targetFileName: STRING
|
|
Not applicable for this type.
|
||
|
|
|
targetPathSharedSubDirectories: BOOLEAN
|
|
The sub directories on the target machine are not deleted if files other than that copied by XL Deploy are present.
|
file.File
| Type Hierarchy | udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
A single file artifact that can be packaged in a Deployment Package
| Public properties | ||
|---|---|---|
|
|
|
checksum: STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
createTargetPath: STRING
|
|
Create the targetPath on the host if it does not exist.
|
||
|
|
|
credentials:
CI<credentials.Credentials>
|
|
Credentials of the URI.
|
||
|
|
|
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
|
||
|
|
|
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.
|
||
|
|
|
targetFileName: STRING
|
|
Name of the artifact on the host.
|
||
|
|
|
targetPath: STRING
|
|
Path to which artifact must be copied to when being deployed.
|
||
|
|
|
targetPathShared: STRING
|
|
Is the targetPath shared by others on the host. When true, the targetPath is not deleted during undeployment; only the artifacts copied to it.
|
| 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
|
||
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
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
|
||
|
|
|
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
|
file.Folder
| Type Hierarchy | udm.BaseDeployableFolderArtifact >> 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 packaged in a Deployment Package
| Public properties | ||
|---|---|---|
|
|
|
checksum: STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
createTargetPath: STRING
|
|
Create the targetPath on the host if it does not exist.
|
||
|
|
|
credentials:
CI<credentials.Credentials>
|
|
Credentials of the URI.
|
||
|
|
|
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
|
||
|
|
|
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.
|
||
|
|
|
targetPath: STRING
|
|
Path to which artifact must be copied to when being deployed.
|
||
|
|
|
targetPathShared: STRING
|
|
Is the targetPath shared by others on the host. When true, the targetPath is not deleted during undeployment; only the artifacts copied to it.
|
| 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
|
||
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
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
|
||
|
|
|
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
|