Page History

The value of this parameter specifies the path and name of a user's private key file used for authorisation on an SSH server.

This parameter must be specified if the publickey authorization method has been specified in the auth_method parameter.

Should the private key file be secured by a password, then this must be specified using the password parameter.

This parameter specifies a command that is to be executed on the SSH server. Multiple commands can be separated by the command delimiter that is specified using the command_delimiter parameter.

DataType: SOSOptionCommandString

This parameter can be used as an alternative to command, command_delimiter and command_script_file. It contains scriptcode which will be transferred to the remote host as a file and will then be executed there. The script can access job and order parameters by environment variables. The names are in upper case and have "SCHEDULER_PARAM_" as a prefix.

Order parameters with the same name overwrite task parameters.

DataType: SOSOptionString

Script file name to Execute

The value of this parameter contains the file-name (and path-name, if needed) of a local (script-)file, which will be transferred to the remote host and will then be executed there. The script can access job- and order-parameters by environment variables. The names of the environment variables are in upper case and have the string "SCHEDULER_PARAM_" as a prefix.

Order parameters with the same name overwrite task parameters.

This parameter can be used as an alternative to command, command_delimiter and command_script.

---- examples ----

               example: usage of parameter command_script_file

<job  title="SSH example job" order="no">

    <description >

        <include  file="jobs/SOSSSHJob2JSAdapter.xml"/>

    </description>

    <params >

        <param  name="host" value="wilma.sos"/>

        <param  name="port" value="22"/>

        <param  name="user" value="test"/>

        <param  name="password" value="*****"/>

        <param  name="auth_method" value="password"/>

        <param  name="command_script_file" value="c:/temp/test.sh"/>

    </params>

    <script  language="java" java_class="sos.scheduler.job.SOSSSHJob2JSAdapter"/>

    <run_time />

</job>

<job  title="SSH example job" order="no">

    <description >

        <include  file="jobs/SOSSSHJob2JSAdapter.xml"/>

    </description>

    <params >

        <param  name="host" value="wilma.sos"/>

        <param  name="port" value="22"/>

        <param  name="user" value="test"/>

        <param  name="password" value="*****"/>

        <param  name="auth_method" value="password"/>

        <param  name="command_script_file" value="c:/temp/test.sh"/>

    </params>

    <script  language="java" java_class="sos.scheduler.job.SOSSSHJob2JSAdapter"/>

    <run_time />

</job>

Die Parameter des SSH-Jobs sind in diesem Beispiel innerhalb des params-tags spezifiziert. Dabei ist für das auszuführende Skript ein Name einer Datei im lokalen Filesystem angegeben. Diese wird, falls vorhanden, zunächst auf den SSH-Host kopiert und dann dort ausgeführt.

DataType: SOSOptionInFileName

This parameter contains a parameter string, which will be appended when calling the command_script or the command_script_file.

Host-Name

This parameter specifies the hostname (e.g. wilma.sos) or IP address (e.g. IPv4 192.168.0.1) of the (FTP, SFTP, SSH, SMTP,  etc.) server to which a connection has to be made.

DataType: SOSOptionHostName

Alias: HostName

Port-Number to be used for Data-Transfer

Port by which files should be transferred. For FTP this is usually port 21, for SFTP this is usually port 22.

DataType: SOSOptionPortNumber

Should the value true be specified, then execution errors caused by commands on the SSH server are ignored. Otherwise such execution errors for jobs and orders are reported by the Job Scheduler.

This parameter configures one or more exit codes which will not be treated as errors. Multiple exit codes can be defined comma separated or using ranges. Examples:

255

2,3,4,100

4,50-60,210-220

Ignore_Hangup_Signal

With this parameter the behavior of the remote running job (Script, executable) will be influenced. If the job is killed by the JS-Operations-GUI, the running job will continue if the value of this parameter is set to true.

http://en.wikipedia.org/wiki/Nohup and http://en.wikipedia.org/wiki/SIGHUP
DataType: SOSOptionBoolean

Should the value true be specified, then on Unix systems all signals will be ignored that terminate the execution of a command on the SSH server - if for example a command is terminated using kill.

Note that by default the Job Scheduler reports errors for commands that are terminated by signals.

This job checks if any output to stderr has been created by a command that is being executed on the SSH server and reports this as an error.

Should the value true be specified for this parameter, then output to stderr will not be reported as an error by the Job Scheduler.

If any output to stderr has been created or the exit code is unequal 0 then the job usually throws an exception. Whenever the job throws an exception then its task ends with the exit code 1. If the job is started by an order and an exception is thrown then the order goes to the error node of the job chain.

Should this value false be specified, then it prevents an exception is thrown, the task has the exit code of the command that is being executed on the SSH server and an order goes to the next node of the job chain.

Password for UserID

Password for authentication at the FTP/SFTP server.

For SSH/SFTP connections that make use of public/private key authentication the password parameter is specified for the passphrase that optionally secures a private key.

DataType: SOSOptionPassword

The value of this parameter is the host name or the IP address of a proxy used to create the connection to the SSH server. The use of a proxy is optional.

This parameter specifies the password for the proxy server user account, should a proxy be used to connect to the SSH server.

This parameter specifies the port number of the proxy, should a proxy be used to create the connection to the SSH server.

The value of this parameter specifies the user account for authorization by the proxy server should a proxy be used to connect to the SSH server.

Should the value true be specified for this parameter, then a login to a shell is simulated to execute commands. Some scripts may cause problems if no shell is present.

The parameter simulate_shell_prompt_trigger must be specified if this parameter is used.

If no new characters are written to stdout or stderr after the given number of milliseconds, the job assumes that that the command has been carried out and the shell is waiting for commands.

If no new characters are written to stdout or stderr after the given number of milliseconds, the job assumes that that the login has been carried out and the shell is waiting for commands.

The expected command line prompt. Using this prompt the job tries to find out if commands may be entered or have been carried out. If no prompt can be configured, timeout parameters have to be used.

UserID of user in charge

User name for authentication at the (FTP/SFTP) server.

DataType: SOSOptionUserName

This parameter specifies the command to set an environmental variable on the remote host.

default: 'export'

This parameter specifies the command to read the content of a file on the remote host. The content will then be written to stdout of the remote host. The command reads return values from a temporary file.

default: 'cat'

This parameter specifies the command to delete a file on the remote host. The command deletes a temporary file after proccessing.

default: 'rm'

The os specific command to to kill a remote running pid.

The os specific command to to terminate a remote running pid.

The os specific command to get the PID of the active shell.

The command to get the child processes related to the given pid.

The timeout in seconds after which a kill signal will be send.

This parameter activates ssh session management.

This parameter can be used to activate transmission of JobScheduler-parameters as ssh environment variables.

This parameter is used to determine the name of the jobchain for cleanup.

Content of STDOUT

The output of the process into STDOUT is reported as the value of this parameter.

Content of STDERR

The output of the process into STDERR is reported as the value of this parameter.

Job exit code

The exit code of the process is the value of this parameter. The exit code is zero if the process ended without any error.

DataType: SOSOptionString

SSH2 library by Trilead: info@trilead.com, (www.trilead.com)      
see http://www.ganymed.ethz.ch/ssh2/ (www.ganymed.ethz.ch/ssh2) as well.
SSH is a registered trademark of SSH Communications Security Corp in the United States and in certain other jurisdictions.