remoteScript.RemoteScript

Description unavailable

Type hierarchy: remoteScript.RemoteScript > xlrelease.PythonScript > xlrelease.BasePythonScript > udm.BaseConfigurationItem
Label: Remote Script: Remote Script
Virtual: true

Properties

Property Kind Description
customScriptTask xlrelease.CustomScriptTask (parent) Custom Script Task
script String Shell script to execute on the remote host
scriptIgnoreVariableInterpolation Boolean If disabled ‘${}’ placeholder will be replaced with variables defined in XLR. Variable interpolation is enabled by default.
remotePath String Path on the remote host where the script will be executed
output String Console output of the process
err String Error stream of the process
temporaryDirectoryPath String Directory in which temporary files are stored. This directory will be cleaned up when the connection is closed.
jumpstation remoteScript.Jumpstation Jumpstation that should be used to reach this host.
remoteCharacterEncoding String The character encoding used to transcode files from one connection to the other

customScriptTask

Custom Script Task

script

Shell script to execute on the remote host

scriptIgnoreVariableInterpolation

If disabled ‘${}’ placeholder will be replaced with variables defined in XLR. Variable interpolation is enabled by default.

remotePath

Path on the remote host where the script will be executed

output

Console output of the process

err

Error stream of the process

temporaryDirectoryPath

Directory in which temporary files are stored. This directory will be cleaned up when the connection is closed.

jumpstation

Jumpstation that should be used to reach this host.

remoteCharacterEncoding

The character encoding used to transcode files from one connection to the other

Hidden properties

Property Kind Description
configurationUri String URI of the HTML file to render the task for custom script tasks
maxOutputPropertySize Integer Maximum size of output property values of type string. Default value is 32768
iconLocation String Icon Location
iconClass String Icon Class
outputVarHelpText String Output Var Help Text
taskColor String Task Color
preconditionEnabled Boolean Indicates whether preconditions should be enabled
failureHandlerEnabled Boolean Indicates whether failure handler should be enabled
scriptLocation String Script Location
tmpDeleteOnDisconnect Boolean If true, delete the temporary connection directory when the connection is closed
tmpFileCreationRetries Integer Number of times Overthere attempts to create a temporary file with a unique name
connectionTimeoutMillis Integer Number of milliseconds Overthere waits for a connection to a remote host to be established

configurationUri

URI of the HTML file to render the task for custom script tasks

maxOutputPropertySize

Maximum size of output property values of type string. Default value is 32768

iconLocation

Icon Location

iconClass

Icon Class

outputVarHelpText

Output Var Help Text

taskColor

Task Color

preconditionEnabled

Indicates whether preconditions should be enabled

failureHandlerEnabled

Indicates whether failure handler should be enabled

scriptLocation

Script Location

tmpDeleteOnDisconnect

If true, delete the temporary connection directory when the connection is closed

tmpFileCreationRetries

Number of times Overthere attempts to create a temporary file with a unique name

connectionTimeoutMillis

Number of milliseconds Overthere waits for a connection to a remote host to be established