remoteScript.Unix
Execute script on Unix host
Type hierarchy: remoteScript.Unix > remoteScript.Ssh > remoteScript.RemoteScript > xlrelease.PythonScript > xlrelease.BasePythonScript > udm.BaseConfigurationItem
Label: Unix
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 (SCP, SFTP, SU, SUDO, INTERACTIVE_SUDO, SFTP_CYGWIN, SFTP_WINSSHD) |
sudo | Boolean | Indicates that the script will be executed using sudo (deprecated since XL Release 5.0.0) |
customScriptTask
Custom Script Task
- Label: Custom Script Task
- Kind: xlrelease.CustomScriptTask (parent)
- Required: false
- Reference type: xlrelease.CustomScriptTask
- As containment: true
script
Shell script to execute on the remote host
- Label: Script
- Kind: String
- Size: LARGE
- Required: true
- Category: input
scriptIgnoreVariableInterpolation
If disabled ‘${}’ placeholder will be replaced with variables defined in XLR. Variable interpolation is enabled by default.
- Label: Disable variable interpolation
- Kind: Boolean
- Default value: false
- Required: false
- Category: input
remotePath
Path on the remote host where the script will be executed
- Label: Remote Path
- Kind: String
- Required: false
- Category: input
output
Console output of the process
- Label: Output
- Kind: String
- Required: false
- Category: output
err
Error stream of the process
- Label: Err
- Kind: String
- Required: false
- Category: output
temporaryDirectoryPath
Directory in which temporary files are stored. This directory will be cleaned up when the connection is closed.
- Label: Temporary Directory Path
- Kind: String
- Required: false
- Category: input
jumpstation
Jumpstation that should be used to reach this host.
- Label: Jumpstation
- Kind: remoteScript.Jumpstation
- Required: false
- Category: input
- Reference type: remoteScript.Jumpstation
remoteCharacterEncoding
The character encoding used to transcode files from one connection to the other
- Label: Remote Character Encoding
- Kind: String
- Default value: UTF-8
- Required: true
- Category: input
address
Address of the host
- Label: Address
- Kind: String
- Required: true
- Category: input
port
Port on which the SSH server runs
- Label: Port
- Kind: Integer
- Default value: 22
- Required: true
- Category: input
username
Username to connect with
- Label: Username
- Kind: String
- Required: true
- Category: input
password
Password to use for authentication
- Label: Password
- Kind: Password
- Password: true
- Required: false
- Category: input
privateKey
Private key to use for authentication
- Label: Private Key
- Kind: String
- Size: LARGE
- Required: false
- Category: input
privateKeyFile
Private key file to use for authentication
- Label: Private Key File
- Kind: String
- Required: false
- Category: input
passphrase
Optional passphrase for the private key in the private key file
- Label: Passphrase
- Kind: Password
- Password: true
- Required: false
- Category: input
sudoUsername
Username to sudo to when accessing files or executing commands
- Label: SUDO username
- Kind: String
- Required: false
- Category: input
suUsername
Username to su to when accessing files or executing commands
- Label: SU username
- Kind: String
- Required: false
- Category: input
suPassword
Password of user to su to when accessing files or executing commands
- Label: SU password
- Kind: Password
- Password: true
- Required: false
- Category: input
connectionType
Type of SSH connection to create (SCP, SFTP, SU, SUDO, INTERACTIVE_SUDO, SFTP_CYGWIN, SFTP_WINSSHD)
- Label: Connection type
- Kind: String
- Default value: SCP
- Required: true
- Category: input
sudo
Indicates that the script will be executed using sudo (deprecated since XL Release 5.0.0)
- Label: Sudo
- Kind: Boolean
- Default value: false
- Required: false
- Category: input
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
- Key:
remoteScript.Unix.configurationUri
- Kind: String
- Default value:
- Hidden: true
maxOutputPropertySize
Maximum size of output property values of type string. Default value is 32768
- Key:
remoteScript.Unix.maxOutputPropertySize
- Kind: Integer
- Default value: 32768
- Hidden: true
iconLocation
Icon Location
- Key:
remoteScript.Unix.iconLocation
- Kind: String
- Default value:
- Hidden: true
iconClass
Icon Class
- Key:
remoteScript.Unix.iconClass
- Kind: String
- Default value:
- Hidden: true
outputVarHelpText
Output Var Help Text
- Key:
remoteScript.Unix.outputVarHelpText
- Kind: String
- Default value: The output of the script can be stored in release variables; specify the variables to be used (optional)
- Hidden: true
taskColor
Task Color
- Key:
remoteScript.Unix.taskColor
- Kind: String
- Default value: #009CDB
- Hidden: true
preconditionEnabled
Indicates whether preconditions should be enabled
- Key:
remoteScript.Unix.preconditionEnabled
- Kind: Boolean
- Default value: true
- Hidden: true
failureHandlerEnabled
Indicates whether failure handler should be enabled
- Key:
remoteScript.Unix.failureHandlerEnabled
- Kind: Boolean
- Default value: true
- Hidden: true
scriptLocation
Script Location
- Key:
remoteScript.Unix.scriptLocation
- Kind: String
- Default value: remoteScript/RemoteScriptWrapper.py
- Hidden: true
tmpDeleteOnDisconnect
If true, delete the temporary connection directory when the connection is closed
- Key:
remoteScript.Unix.tmpDeleteOnDisconnect
- Kind: Boolean
- Default value: true
- Category: input
- Hidden: true
tmpFileCreationRetries
Number of times Overthere attempts to create a temporary file with a unique name
- Key:
remoteScript.Unix.tmpFileCreationRetries
- Kind: Integer
- Default value: 1000
- Category: input
- Hidden: true
connectionTimeoutMillis
Number of milliseconds Overthere waits for a connection to a remote host to be established
- Key:
remoteScript.Unix.connectionTimeoutMillis
- Kind: Integer
- Default value: 120000
- Category: input
- Hidden: true
protocol
Protocol
- Key:
remoteScript.Unix.protocol
- Kind: String
- Default value: ssh
- Hidden: true
allocateDefaultPty
If true, a default PTY (dummy:80:24:0:0) is allocated when executing a command
- Key:
remoteScript.Unix.allocateDefaultPty
- Kind: Boolean
- Default value: false
- Category: input
- Hidden: true
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
- Key:
remoteScript.Unix.allocatePty
- Kind: String
- Category: input
- Hidden: true
interactiveKeyboardAuthRegex
Regular expression to look for in keyboard-interactive authentication before sending the password
- Key:
remoteScript.Unix.interactiveKeyboardAuthRegex
- Kind: String
- Default value: .*Password:[ ]?
- Category: input
- Hidden: true
sudoCommandPrefix
Sudo command to prefix to the original command. The placeholder {0} is replaced with the sudoUsername
- Key:
remoteScript.Unix.sudoCommandPrefix
- Kind: String
- Default value: sudo -u {0}
- Category: input
- Hidden: true
sudoQuoteCommand
If true, the original command is quoted when it is prefixed with sudoCommandPrefix
- Key:
remoteScript.Unix.sudoQuoteCommand
- Kind: Boolean
- Default value: false
- Category: input
- Hidden: true
sudoPreserveAttributesOnCopyFromTempFile
If true, files are copied from the connection temporary directory using the -p flag to the cp command
- Key:
remoteScript.Unix.sudoPreserveAttributesOnCopyFromTempFile
- Kind: Boolean
- Default value: true
- Category: input
- Hidden: true
sudoPreserveAttributesOnCopyToTempFile
If true, files are copied to the connection temporary directory using the -p flag to the cp command
- Key:
remoteScript.Unix.sudoPreserveAttributesOnCopyToTempFile
- Kind: Boolean
- Default value: true
- Category: input
- Hidden: true
sudoPasswordPromptRegex
Regular expression to look for in interactive sudo before sending the password
- Key:
remoteScript.Unix.sudoPasswordPromptRegex
- Kind: String
- Default value: .[Pp]assword.:
- Category: input
- Hidden: true
sudoOverrideUmask
If true, permissions are explicitly changed with chmod -R go+rX after uploading a file or directory
- Key:
remoteScript.Unix.sudoOverrideUmask
- Kind: Boolean
- Default value: true
- Category: input
- Hidden: true
suCommandPrefix
Su command to prefix to the original command. The placeholder {0} is replaced with the sudoUsername
- Key:
remoteScript.Unix.suCommandPrefix
- Kind: String
- Default value: su - {0} -c
- Category: input
- Hidden: true
suQuoteCommand
If true, the original command is quoted when it is prefixed with suCommandPrefix
- Key:
remoteScript.Unix.suQuoteCommand
- Kind: Boolean
- Default value: true
- Category: input
- Hidden: true
suPreserveAttributesOnCopyFromTempFile
If true, files are copied from the connection temporary directory using the -p flag to the cp command
- Key:
remoteScript.Unix.suPreserveAttributesOnCopyFromTempFile
- Kind: Boolean
- Default value: true
- Category: input
- Hidden: true
suPreserveAttributesOnCopyToTempFile
If true, files are copied to the connection temporary directory using the -p flag to the cp command
- Key:
remoteScript.Unix.suPreserveAttributesOnCopyToTempFile
- Kind: Boolean
- Default value: true
- Category: input
- Hidden: true
suPasswordPromptRegex
Regular expression to look for before sending the password
- Key:
remoteScript.Unix.suPasswordPromptRegex
- Kind: String
- Default value: .[Pp]assword.:
- Category: input
- Hidden: true
suOverrideUmask
If true, permissions are explicitly changed with chmod -R go+rX after uploading a file or directory
- Key:
remoteScript.Unix.suOverrideUmask
- Kind: Boolean
- Default value: true
- Category: input
- Hidden: true
os
Os
- Key:
remoteScript.Unix.os
- Kind: Enum
- Allowed values: WINDOWS, UNIX, ZOS
- Default value: UNIX
- Hidden: true