...
This document describes the functionality of the JobSchedulerSSHJob and the parameters to configure the Job properly. Additionaly Additionally this document provides a minimal example for a SSH Job configuration.
...
Unix based operating systems provide a an SSH client, while MS Windows operating systems do not.
With the JobSchedulerSSHJob you can execute The JobSchedulerSSHJob allows the execution of shell commands and scripts on a remote host , running a SSH server , without the need to install requiring a local SSH client to be installed.
For a minimal SSH job only a limited amount number of parameters has to be configured as shown in the example below.
...
- Required Parameters
- Parameters which are required to run the Job
- Example: To connect to a remote host, the '
host' parameter is always required to run the Job job properly.
- Example: To connect to a remote host, the '
- Parameters which are required to run the Job
- Conditional Parameters
- Parameters which depend on other parameters
- Example: Depending on the The value of the '
auth_method' parameter ('password' or 'publickey') determines whether one of the conditional parameters , - the 'password' parameter or the 'publickey' parameter, parameter has to be set.
- Example: Depending on the The value of the '
- Parameters which depend on other parameters
- Additional Parameters
- Parameters which are not required, but depend on specific conditions
- Example: To connect with a remote host only a Only a '
host' parameter is required . If to connect with a remote host. However, if the connection has to be instantiated over a proxy, the an additional parameter 'proxy_host' parameter is required.
- Example: To connect with a remote host only a Only a '
- Parameters which are not required, but depend on specific conditions
| Note |
|---|
Some parameters are technically required to build a connection , but are not shown in the 'Required Parameters' section of this document. This is because some of those parameters are configured with a default value and therefore there is no need to configure them explicitly. |
...
- default value:
- %%
- description:
- Command delimiter characters are specified using this parameter. These delimiters can then used in the command parameter to seperate separate multiple commands. These commands are then excecuted executed in a separate SSH session.
...
- default value:
- empty
- description:
- This parameter specifies the path and name of a user's private key file used for registeration registration on an SSH server. This parameter must be specified if the publickey authorization method has been specified in the
auth_methodparameter.
If the private key file is secured with a passphrase, thepasswordparameter hat to be set with the passphrase.
- This parameter specifies the path and name of a user's private key file used for registeration registration on an SSH server. This parameter must be specified if the publickey authorization method has been specified in the
command
- default value:
- empltyempty
- description:
- 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_delimiterparameter.
- 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
...
- default value:
- empty
- description:
- This parameter can be used as an alternative to
command,command_delimiterandcommand_script_file. It contains scriptcode script code which will be saved to a temporary (script-)file on the remote host and executed there. The script can access task 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.
- This parameter can be used as an alternative to
...
- default value:
- empty
- description
- This parameter specifies the port number of the proxy, should a proxy be used to create the connection to the SSH server.
proxy_user
- default value:
- empty
- description
- 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.
proxy_password
- default value:
- empty
- description
- This parameter specifies the password for the proxy server user account, should a proxy be used to connect to the SSH server.
command_script_param
- default value:
- empty
- description
- This parameter contains a parameterstringparameter string, which will be appended when calling the
command_scriptor thecommand_script_file.
- This parameter contains a parameterstringparameter string, which will be appended when calling the
ignore_error
- default value:
- false
- description
- If the value true is set, 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.
ignore_exit_code
- default value:
- empty
- description
- This parameter configures one or more exit codes which will not be treated as errors. Multiple exit codes can be defined comma seperated separated or using ranges.
- examples:
- 255
- 2,3,4,100
- 4,50-60,210-220
ignore_signal
- default value:
- false
- description
- If the value true is set, 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.
- If the value true is set, 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.
ignore_stderr
- default value:
- false
- description
- 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.
If the value true is set, then output to stderr will not be reported as an error by the Job Scheduler.
- 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.
simulate_shell
- default value:
- false
- description
- If the value true is set, then a login to a shell is simulated to execute commands. Some scripts may cause problems if no shell is present.
simulate_shell_prompt_trigger
- default value:
- empty
- description
- 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.
simulate_shell_login_timeout
- default value:
- empty
- description
- 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.
simulate_shell_inactivity_timeout
- default value:
- empty
- description
- 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.
...