remoteScript.WindowsSsh

Execute script on Windows host with SSH

Type hierarchy: remoteScript.WindowsSsh > remoteScript.Ssh > remoteScript.RemoteScript > xlrelease.PythonScript > xlrelease.BasePythonScript > udm.BaseConfigurationItem
Label: Windows (SSH)

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
address String Address of the host
port Integer Port on which the SSH server runs
username String Username to connect with
password Password Password to use for authentication
privateKey String Private key to use for authentication
privateKeyFile String Private key file to use for authentication
passphrase Password Optional passphrase for the private key in the private key file
sudoUsername String Username to sudo to when accessing files or executing commands
suUsername String Username to su to when accessing files or executing commands
suPassword Password Password of user to su to when accessing files or executing commands
connectionType String Type of SSH connection to create (SFTP_CYGWIN, SFTP_WINSSHD)

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

address

Address of the host

port

Port on which the SSH server runs

username

Username to connect with

password

Password to use for authentication

privateKey

Private key to use for authentication

privateKeyFile

Private key file to use for authentication

passphrase

Optional passphrase for the private key in the private key file

sudoUsername

Username to sudo to when accessing files or executing commands

suUsername

Username to su to when accessing files or executing commands

suPassword

Password of user to su to when accessing files or executing commands

connectionType

Type of SSH connection to create (SFTP_CYGWIN, SFTP_WINSSHD)

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
protocol String Protocol
allocateDefaultPty Boolean If true, a default PTY (dummy:80:24:0:0) is allocated when executing a command
allocatePty String Specification for the PTY to be allocated when executing a command. The format is TERM:COLS:ROWS:WIDTH:HEIGHT, e.g. xterm:80:24:0:0
interactiveKeyboardAuthRegex String Regular expression to look for in keyboard-interactive authentication before sending the password
sudoCommandPrefix String Sudo command to prefix to the original command. The placeholder {0} is replaced with the sudoUsername
sudoQuoteCommand Boolean If true, the original command is quoted when it is prefixed with sudoCommandPrefix
sudoPreserveAttributesOnCopyFromTempFile Boolean If true, files are copied from the connection temporary directory using the -p flag to the cp command
sudoPreserveAttributesOnCopyToTempFile Boolean If true, files are copied to the connection temporary directory using the -p flag to the cp command
sudoPasswordPromptRegex String Regular expression to look for in interactive sudo before sending the password
sudoOverrideUmask Boolean If true, permissions are explicitly changed with chmod -R go+rX after uploading a file or directory
suCommandPrefix String Su command to prefix to the original command. The placeholder {0} is replaced with the sudoUsername
suQuoteCommand Boolean If true, the original command is quoted when it is prefixed with suCommandPrefix
suPreserveAttributesOnCopyFromTempFile Boolean If true, files are copied from the connection temporary directory using the -p flag to the cp command
suPreserveAttributesOnCopyToTempFile Boolean If true, files are copied to the connection temporary directory using the -p flag to the cp command
suPasswordPromptRegex String Regular expression to look for before sending the password
suOverrideUmask Boolean If true, permissions are explicitly changed with chmod -R go+rX after uploading a file or directory
os Enum Os

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

protocol

Protocol

allocateDefaultPty

If true, a default PTY (dummy:80:24:0:0) is allocated when executing a command

allocatePty

Specification for the PTY to be allocated when executing a command. The format is TERM:COLS:ROWS:WIDTH:HEIGHT, e.g. xterm:80:24:0:0

interactiveKeyboardAuthRegex

Regular expression to look for in keyboard-interactive authentication before sending the password

sudoCommandPrefix

Sudo command to prefix to the original command. The placeholder {0} is replaced with the sudoUsername

sudoQuoteCommand

If true, the original command is quoted when it is prefixed with sudoCommandPrefix

sudoPreserveAttributesOnCopyFromTempFile

If true, files are copied from the connection temporary directory using the -p flag to the cp command

sudoPreserveAttributesOnCopyToTempFile

If true, files are copied to the connection temporary directory using the -p flag to the cp command

sudoPasswordPromptRegex

Regular expression to look for in interactive sudo before sending the password

sudoOverrideUmask

If true, permissions are explicitly changed with chmod -R go+rX after uploading a file or directory

suCommandPrefix

Su command to prefix to the original command. The placeholder {0} is replaced with the sudoUsername

suQuoteCommand

If true, the original command is quoted when it is prefixed with suCommandPrefix

suPreserveAttributesOnCopyFromTempFile

If true, files are copied from the connection temporary directory using the -p flag to the cp command

suPreserveAttributesOnCopyToTempFile

If true, files are copied to the connection temporary directory using the -p flag to the cp command

suPasswordPromptRegex

Regular expression to look for before sending the password

suOverrideUmask

If true, permissions are explicitly changed with chmod -R go+rX after uploading a file or directory

os

Os