Windows Plugin Reference 25.1.x
The XL Deploy Windows plugin enables XL Deploy to perform common Microsoft Windows configuration and deployment tasks.
This document provides information that is specific to this version of the Windows plugin. For general information about the plugin, refer to Introduction to the XL Deploy Windows plugin.
Requirements
- XL Deploy 5.0.0 or later
- Microsoft Windows Server 2003 R2, 2008, 2008 R2, 2012, or 2012 R2
- Requirements on the target Windows machine:
- Administrative access
- PowerShell 2.0 must be installed
Using the deployables and deployeds
Deployable vs. Container table
The following table describes which deployable/container combinations are possible:
| Deployable | Container | Generated deployed |
|---|---|---|
| windows.Msi | overthere.Host | windows.InstalledMsi |
| windows.RegFile | overthere.Host | windows.ImportedRegFile |
| windows.ServiceSpec | overthere.Host | windows.Service |
| windows.ShareSpec | overthere.Host | windows.Share |
Deployed Actions Table
The following table describes the effect a deployed has on its container:
| Deployed | Actions performed for operations | |||
|---|---|---|---|---|
| Create | Destroy | Modify | Noop | |
| windows.InstalledMsi |
|
|
|
|
| windows.ImportedRegFile |
|
|
Nothing | |
| windows.Service |
|
|
|
|
| windows.Share |
|
|
|
|
CI Reference
Configuration Item Overview
Deployables
| CI | Description |
|---|---|
| windows.Msi | MSI file. Note that MSI files cannot be scanned for placeholders like EAR, WAR, ZIP, and TAR files, and other formats supported by TrueZIP/TrueVFS. |
| windows.RegFile | Windows .reg file |
| windows.ServiceSpec | Specification of a Windows service |
| windows.ShareSpec | Specification of a Windows share |
Deployeds
| CI | Description |
|---|---|
| windows.ImportedRegFile | Imported Windows .reg file |
| windows.InstalledMsi | Installed MSI |
| windows.Service | Windows service |
| windows.Share | Windows share |
Configuration Item Details
windows.ImportedRegFile
| Type Hierarchy | powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployedArtifact >> powershell.BasePowerShellDeployedArtifact >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Imported Windows .reg file
| 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>
|
||
|
|
|
startOnCreate: BOOLEAN = true
|
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
|
stopOnDestroy: BOOLEAN = true
|
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
|
stopStartOnModify: BOOLEAN = true
|
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
|
stopStartOnNoop: BOOLEAN = true
|
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified.
|
| Hidden properties | ||
|---|---|---|
|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder: INTEGER = 72
|
|
Order at which the create step will be executed.
|
||
|
|
|
createScript: STRING = windows/import-reg-file.ps1
|
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
|
createVerb: STRING = Import
|
|
Verb that is used to prefix the description for the create step.
|
||
|
|
|
destroyOptions: SET_OF_STRING = [uploadClasspathResources]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder: INTEGER = 40
|
|
Order at which the destroy step will be executed.
|
||
|
|
|
destroyVerb: STRING = Destroy
|
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
|
discoverOrder: INTEGER = 50
|
|
Order at which the discover step will be executed.
|
||
|
|
|
maxBatchSize: INTEGER = 100
|
|
Maximum number of steps in a batch.
|
||
|
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder: INTEGER = 72
|
|
Order at which the modify step will be executed.
|
||
|
|
|
modifyScript: STRING = windows/import-reg-file.ps1
|
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
|
modifyVerb: STRING = Import
|
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
|
noopOptions: SET_OF_STRING = [uploadClasspathResources]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
noopOrder: INTEGER = 50
|
|
Order at which the noop step will be executed.
|
||
|
|
|
noopVerb: STRING = Noop
|
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
|
startOptions: SET_OF_STRING = [uploadClasspathResources]
|
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
startOrder: INTEGER = 90
|
|
Order at which the start step will be executed.
|
||
|
|
|
startVerb: STRING = Start
|
|
Verb that is used to prefix the description for the start step.
|
||
|
|
|
stopOptions: SET_OF_STRING = [uploadClasspathResources]
|
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
stopOrder: INTEGER = 10
|
|
Order at which the stop script will be executed.
|
||
|
|
|
stopVerb: STRING = Stop
|
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
|
batchSteps: BOOLEAN
|
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
||
|
|
|
classpathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
|
destroyScript: STRING
|
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
|
discoverScript: STRING
|
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
|
exposePasswordPropertiesOnHosts: BOOLEAN
|
|
Whether to add the host password to the powershell variable values.
|
||
|
|
|
libraryScripts: LIST_OF_STRING
|
|
List of scripts to append to the the step script.
|
||
|
|
|
noopScript: STRING
|
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
|
startScript: STRING
|
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
|
stopScript: STRING
|
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
||
|
|
|
useSidecarIniFile: BOOLEAN
|
|
Whether to use a sidecar '.ini' file to transfer the powershell variable values.
|
windows.InstalledMsi
| Type Hierarchy | powershell.ExtensiblePowerShellDeployedArtifact >> powershell.BaseExtensiblePowerShellDeployedArtifact >> powershell.BasePowerShellDeployedArtifact >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Installed MSI
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
additionalInstallProperties: STRING
|
|
Additional install properties for this MSI
|
||
|
|
|
additionalUninstallProperties: STRING
|
|
Additional uninstall properties for this MSI
|
||
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
logOptions: STRING
|
|
Options for the /L command line option, see http://technet.microsoft.com/en-us/library/cc759262(v=ws.10).aspx
|
||
|
|
|
placeholders: MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
||
|
|
|
startOnCreate: BOOLEAN = true
|
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
|
stopOnDestroy: BOOLEAN = true
|
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
|
stopStartOnModify: BOOLEAN = true
|
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
|
stopStartOnNoop: BOOLEAN = true
|
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified.
|
| Hidden properties | ||
|---|---|---|
|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder: INTEGER = 60
|
|
Order at which the create step will be executed.
|
||
|
|
|
createScript: STRING = windows/install-msi.ps1
|
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
|
createVerb: STRING = Install
|
|
Verb that is used to prefix the description for the create step.
|
||
|
|
|
destroyOptions: SET_OF_STRING = [uploadArtifactData]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder: INTEGER = 40
|
|
Order at which the destroy step will be executed.
|
||
|
|
|
destroyScript: STRING = windows/uninstall-msi.ps1
|
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
|
destroyVerb: STRING = Uninstall
|
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
|
discoverOrder: INTEGER = 50
|
|
Order at which the discover step will be executed.
|
||
|
|
|
maxBatchSize: INTEGER = 100
|
|
Maximum number of steps in a batch.
|
||
|
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder: INTEGER = 60
|
|
Order at which the modify step will be executed.
|
||
|
|
|
modifyVerb: STRING = Modify
|
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
|
noopOptions: SET_OF_STRING = [uploadClasspathResources]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
noopOrder: INTEGER = 50
|
|
Order at which the noop step will be executed.
|
||
|
|
|
noopVerb: STRING = Noop
|
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
|
startOptions: SET_OF_STRING = [uploadClasspathResources]
|
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
startOrder: INTEGER = 90
|
|
Order at which the start step will be executed.
|
||
|
|
|
startVerb: STRING = Start
|
|
Verb that is used to prefix the description for the start step.
|
||
|
|
|
stopOptions: SET_OF_STRING = [uploadClasspathResources]
|
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
stopOrder: INTEGER = 10
|
|
Order at which the stop script will be executed.
|
||
|
|
|
stopVerb: STRING = Stop
|
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
|
batchSteps: BOOLEAN
|
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
||
|
|
|
classpathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
|
discoverScript: STRING
|
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
|
exposePasswordPropertiesOnHosts: BOOLEAN
|
|
Whether to add the host password to the powershell variable values.
|
||
|
|
|
libraryScripts: LIST_OF_STRING
|
|
List of scripts to append to the the step script.
|
||
|
|
|
modifyScript: STRING
|
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
|
noopScript: STRING
|
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
|
startScript: STRING
|
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
|
stopScript: STRING
|
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
||
|
|
|
useSidecarIniFile: BOOLEAN
|
|
Whether to use a sidecar '.ini' file to transfer the powershell variable values.
|
windows.Msi
| Type Hierarchy | powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
MSI file. Note that MSI files cannot be scanned for placeholders like EAR, WAR, ZIP, and TAR files, and other formats supported by TrueZIP/TrueVFS.
| Public properties | ||
|---|---|---|
|
|
|
additionalInstallProperties: STRING
|
|
Additional install properties for this MSI (string)
|
||
|
|
|
additionalUninstallProperties: STRING
|
|
Additional uninstall properties for this MSI (string)
|
||
|
|
|
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
|
||
|
|
|
excludeFileNamesRegexToTranscode: STRING
|
|
A regex of file type that needs to be ignored for transcode
|
||
|
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
|
Specifies file encodings in this artifact. Key: regular expression matching file names; value: character set. Character set encoding is used for placeholder replacement and transcoding files to z/OS.
|
||
|
|
|
fileUri: STRING
|
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
|
isRescanned: BOOLEAN
|
|
Indicates if the artifact has been rescanned
|
||
|
|
|
logOptions: STRING
|
|
Options for the /L command line option, see http://technet.microsoft.com/en-us/library/cc759262(v=ws.10).aspx (string)
|
||
|
|
|
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
|
||
|
|
|
startOnCreate: STRING
|
|
If set to true, the start script will be executed if this deployed is being created. (boolean) default(true)
|
||
|
|
|
stopOnDestroy: STRING
|
|
If set to true, the stop script will be executed if this deployed is being destroyed. (boolean) default(true)
|
||
|
|
|
stopStartOnModify: STRING
|
|
If set to true, the stop and start scripts will be executed if this deployed is being modified. (boolean) default(true)
|
||
|
|
|
stopStartOnNoop: STRING
|
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified. (boolean) default(true)
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
textFileNamesRegexToTranscode: 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 to transcode to EBCDIC
|
| 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
|
windows.RegFile
| Type Hierarchy | powershell.BasePowerShellDeployableFileArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
Windows .reg file
| 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
|
||
|
|
|
excludeFileNamesRegexToTranscode: STRING
|
|
A regex of file type that needs to be ignored for transcode
|
||
|
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
|
Specifies file encodings in this artifact. Key: regular expression matching file names; value: character set. Character set encoding is used for placeholder replacement and transcoding files to z/OS.
|
||
|
|
|
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
|
||
|
|
|
startOnCreate: STRING
|
|
If set to true, the start script will be executed if this deployed is being created. (boolean) default(true)
|
||
|
|
|
stopOnDestroy: STRING
|
|
If set to true, the stop script will be executed if this deployed is being destroyed. (boolean) default(true)
|
||
|
|
|
stopStartOnModify: STRING
|
|
If set to true, the stop and start scripts will be executed if this deployed is being modified. (boolean) default(true)
|
||
|
|
|
stopStartOnNoop: STRING
|
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified. (boolean) default(true)
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
textFileNamesRegexToTranscode: 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 to transcode to EBCDIC
|
| 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
|
windows.Service
| Type Hierarchy | powershell.ExtensiblePowerShellDeployed >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer |
Windows service
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
binaryPathName: STRING
|
|
Path of the service binary
|
||
|
|
|
startTimeout: INTEGER = 30
|
|
Amount of seconds to wait for the service to start. Note: If the service goes into the Pending state, the actual timeout used will be the double the specified amount.
|
||
|
|
|
startupType: STRING = Automatic
|
|
Startup type is this service. Defaults to Automatic
|
||
|
|
|
stopTimeout: INTEGER = 30
|
|
Amount of seconds to wait for the service to start. Note: If the service goes into the Pending state, the actual timeout used will be the double the specified amount.
|
||
|
|
|
dependsOn: LIST_OF_STRING
|
|
Services this service depends on
|
||
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
password: STRING
|
|
Password of the account this service should log on as
|
||
|
|
|
serviceDescription: STRING
|
|
Description of this service
|
||
|
|
|
serviceDisplayName: STRING
|
|
Display name of this service
|
||
|
|
|
serviceName: STRING
|
|
Name of the service. Defaults to the name of the deployed if not specified
|
||
|
|
|
startOnCreate: BOOLEAN = true
|
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
|
stopOnDestroy: BOOLEAN = true
|
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
|
stopStartOnModify: BOOLEAN = true
|
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
|
stopStartOnNoop: BOOLEAN = true
|
|
If set to true, this service is stopped and started when another component in the same package is deployed
|
||
|
|
|
username: STRING
|
|
Username of the account this service should log on as
|
| Hidden properties | ||
|---|---|---|
|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder: INTEGER = 60
|
|
Order at which the create step will be executed.
|
||
|
|
|
createScript: STRING = windows/install-service.ps1
|
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
|
createVerb: STRING = Install
|
|
Verb that is used to prefix the description for the create step.
|
||
|
|
|
destroyOptions: SET_OF_STRING = [uploadClasspathResources]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder: INTEGER = 40
|
|
Order at which the destroy step will be executed.
|
||
|
|
|
destroyScript: STRING = windows/uninstall-service.ps1
|
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
|
destroyVerb: STRING = Uninstall
|
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
|
discoverOrder: INTEGER = 50
|
|
Order at which the discover step will be executed.
|
||
|
|
|
discoverScript: STRING = windows/inspect-services.ps1
|
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
|
maxBatchSize: INTEGER = 100
|
|
Maximum number of steps in a batch.
|
||
|
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder: INTEGER = 60
|
|
Order at which the modify step will be executed.
|
||
|
|
|
modifyVerb: STRING = Modify
|
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
|
noopOptions: SET_OF_STRING = [uploadClasspathResources]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
noopOrder: INTEGER = 50
|
|
Order at which the noop step will be executed.
|
||
|
|
|
noopVerb: STRING = Noop
|
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
|
startOptions: SET_OF_STRING = [uploadClasspathResources]
|
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
startOrder: INTEGER = 90
|
|
Order at which the start step will be executed.
|
||
|
|
|
startScript: STRING = windows/start-service.ps1
|
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
|
startVerb: STRING = Start
|
|
Verb that is used to prefix the description for the start step.
|
||
|
|
|
stopOptions: SET_OF_STRING = [uploadClasspathResources]
|
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
stopOrder: INTEGER = 10
|
|
Order at which the stop script will be executed.
|
||
|
|
|
stopScript: STRING = windows/stop-service.ps1
|
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
||
|
|
|
stopVerb: STRING = Stop
|
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
|
batchSteps: BOOLEAN
|
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
||
|
|
|
classpathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
|
exposePasswordPropertiesOnHosts: BOOLEAN
|
|
Whether to add the host password to the powershell variable values.
|
||
|
|
|
libraryScripts: LIST_OF_STRING
|
|
List of scripts to append to the the step script.
|
||
|
|
|
modifyScript: STRING
|
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
|
noopScript: STRING
|
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
|
useSidecarIniFile: BOOLEAN
|
|
Whether to use a sidecar '.ini' file to transfer the powershell variable values.
|
windows.ServiceSpec
| Type Hierarchy | powershell.BasePowerShellDeployable >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployable, udm.Taggable |
Specification of a Windows service
| Public properties | ||
|---|---|---|
|
|
|
binaryPathName: STRING
|
|
Path of the service binary (string)
|
||
|
|
|
dependsOn: LIST_OF_STRING
|
|
Services this service depends on (list_of_string)
|
||
|
|
|
password: STRING
|
|
Password of the account this service should log on as (string)
|
||
|
|
|
serviceDescription: STRING
|
|
Description of this service (string)
|
||
|
|
|
serviceDisplayName: STRING
|
|
Display name of this service (string)
|
||
|
|
|
serviceName: STRING
|
|
Name of the service. Defaults to the name of the deployed if not specified (string)
|
||
|
|
|
startOnCreate: STRING
|
|
If set to true, the start script will be executed if this deployed is being created. (boolean) default(true)
|
||
|
|
|
startTimeout: STRING
|
|
Amount of seconds to wait for the service to start. Note: If the service goes into the Pending state, the actual timeout used will be the double the specified amount. (integer) default(30)
|
||
|
|
|
startupType: STRING
|
|
Startup type is this service. Defaults to Automatic (string) default(Automatic)
|
||
|
|
|
stopOnDestroy: STRING
|
|
If set to true, the stop script will be executed if this deployed is being destroyed. (boolean) default(true)
|
||
|
|
|
stopStartOnModify: STRING
|
|
If set to true, the stop and start scripts will be executed if this deployed is being modified. (boolean) default(true)
|
||
|
|
|
stopStartOnNoop: STRING
|
|
If set to true, this service is stopped and started when another component in the same package is deployed (boolean) default(true)
|
||
|
|
|
stopTimeout: STRING
|
|
Amount of seconds to wait for the service to start. Note: If the service goes into the Pending state, the actual timeout used will be the double the specified amount. (integer) default(30)
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
username: STRING
|
|
Username of the account this service should log on as (string)
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
The set of CI templates.
|
windows.Share
| Type Hierarchy | powershell.ExtensiblePowerShellDeployed >> powershell.BaseExtensiblePowerShellDeployed >> powershell.BasePowerShellDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer |
Windows share
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
targetPath: STRING
|
|
Target path of the share
|
||
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
shareName: STRING
|
|
Name of the share. Defaults to the name of the deployed if not specified
|
||
|
|
|
startOnCreate: BOOLEAN = true
|
|
If set to true, the start script will be executed if this deployed is being created.
|
||
|
|
|
stopOnDestroy: BOOLEAN = true
|
|
If set to true, the stop script will be executed if this deployed is being destroyed.
|
||
|
|
|
stopStartOnModify: BOOLEAN = true
|
|
If set to true, the stop and start scripts will be executed if this deployed is being modified.
|
||
|
|
|
stopStartOnNoop: BOOLEAN = true
|
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified.
|
| Hidden properties | ||
|---|---|---|
|
|
|
createOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources]
|
|
Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
createOrder: INTEGER = 60
|
|
Order at which the create step will be executed.
|
||
|
|
|
createScript: STRING = windows/create-share.ps1
|
|
PowerShell script invoked to create a resource (or deploy an artifact) on Windows.
|
||
|
|
|
createVerb: STRING = Create
|
|
Verb that is used to prefix the description for the create step.
|
||
|
|
|
destroyOptions: SET_OF_STRING = [uploadClasspathResources]
|
|
Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
destroyOrder: INTEGER = 40
|
|
Order at which the destroy step will be executed.
|
||
|
|
|
destroyScript: STRING = windows/delete-share.ps1
|
|
PowerShell script invoked to destroy a resource (or undeploy an artifact) on Windows.
|
||
|
|
|
destroyVerb: STRING = Destroy
|
|
Verb that is used to prefix the description for the destroy step.
|
||
|
|
|
discoverOrder: INTEGER = 50
|
|
Order at which the discover step will be executed.
|
||
|
|
|
discoverScript: STRING = windows/inspect-shares.ps1
|
|
Script invoked to discover and inspect deployeds of this type.
|
||
|
|
|
maxBatchSize: INTEGER = 100
|
|
Maximum number of steps in a batch.
|
||
|
|
|
modifyOptions: SET_OF_STRING = [uploadArtifactData, uploadClasspathResources]
|
|
Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
modifyOrder: INTEGER = 60
|
|
Order at which the modify step will be executed.
|
||
|
|
|
modifyVerb: STRING = Modify
|
|
Verb that is used to prefix the description for the modify step.
|
||
|
|
|
noopOptions: SET_OF_STRING = [uploadClasspathResources]
|
|
Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
noopOrder: INTEGER = 50
|
|
Order at which the noop step will be executed.
|
||
|
|
|
noopVerb: STRING = Noop
|
|
Verb that is used to prefix the description for the noop step.
|
||
|
|
|
startOptions: SET_OF_STRING = [uploadClasspathResources]
|
|
Options for the start step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
startOrder: INTEGER = 90
|
|
Order at which the start step will be executed.
|
||
|
|
|
startVerb: STRING = Start
|
|
Verb that is used to prefix the description for the start step.
|
||
|
|
|
stopOptions: SET_OF_STRING = [uploadClasspathResources]
|
|
Options for the stop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,exposeDeployedApplication,exposePreviousDeployed).
|
||
|
|
|
stopOrder: INTEGER = 10
|
|
Order at which the stop script will be executed.
|
||
|
|
|
stopVerb: STRING = Stop
|
|
Verb that is used to prefix the description for the stop step.
|
||
|
|
|
batchSteps: BOOLEAN
|
|
If set to true, multiple steps at the same order will be batched together in one batch to improve performance over high-latency WinRM connections
|
||
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
||
|
|
|
classpathResources: SET_OF_STRING
|
|
Additional classpath resources that should be uploaded to the working directory before executing the script.
|
||
|
|
|
exposePasswordPropertiesOnHosts: BOOLEAN
|
|
Whether to add the host password to the powershell variable values.
|
||
|
|
|
libraryScripts: LIST_OF_STRING
|
|
List of scripts to append to the the step script.
|
||
|
|
|
modifyScript: STRING
|
|
PowerShell script invoked to modify a resource (or an artifact) on Windows.
|
||
|
|
|
noopScript: STRING
|
|
PowerShell script invoked to noop a resource or an artifact on Windows.
|
||
|
|
|
startScript: STRING
|
|
PowerShell script invoked to start a resource of an artifact on Windows.
|
||
|
|
|
stopScript: STRING
|
|
PowerShell script invoked to stop a resource or an artifact on Windows.
|
||
|
|
|
useSidecarIniFile: BOOLEAN
|
|
Whether to use a sidecar '.ini' file to transfer the powershell variable values.
|
windows.ShareSpec
| Type Hierarchy | powershell.BasePowerShellDeployable >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployable, udm.Taggable |
Specification of a Windows share
| Public properties | ||
|---|---|---|
|
|
|
shareName: STRING
|
|
Name of the share. Defaults to the name of the deployed if not specified (string)
|
||
|
|
|
startOnCreate: STRING
|
|
If set to true, the start script will be executed if this deployed is being created. (boolean) default(true)
|
||
|
|
|
stopOnDestroy: STRING
|
|
If set to true, the stop script will be executed if this deployed is being destroyed. (boolean) default(true)
|
||
|
|
|
stopStartOnModify: STRING
|
|
If set to true, the stop and start scripts will be executed if this deployed is being modified. (boolean) default(true)
|
||
|
|
|
stopStartOnNoop: STRING
|
|
If set to true, the stop and start scripts will be executed if this deployable is not being modified. (boolean) default(true)
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
targetPath: STRING
|
|
Target path of the share (string)
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
The set of CI templates.
|