Page History
...
Name | Required | Default Value | Purpose | Example | ||||||
---|---|---|---|---|---|---|---|---|---|---|
host | yes | This argument specifies the hostname or IP address of the SSH server to which a connection is to be made. | ||||||||
| yes | This argument specifies the user account to be used when connecting to the SSH server. | ||||||||
port | no | 22 | This argument specifies the port number of the SSH server. | |||||||
auth_method | no | publickey | This argument specifies the authentication method for the SSH server - the publickey and password methods are supported. The path name of the private key file is specified with the | |||||||
password | no | This argument specifies the user account's password for authentication by the SSH server and has to be specified if the password authentication method is specified with the | ||||||||
auth_file | no | This argument specifies the path and name of a private key file used for authentication with an SSH server. This argument has to be specified if the publickey authentication method is specified with the | ||||||||
command_delimiter | no | %% | Command delimiter characters can be specified using this argument. The delimiters are used in command arguments to separate multiple commands. The commands can be executed in separate SSH sessions. | |||||||
command | no | This argument specifies a command that should be executed on the SSH server. Multiple commands can be separated by the command delimiter that is specified using the | ||||||||
command_script | no | This argument can be used as an alternative to | ||||||||
command_script_file | no | This argument can be used as an alternative to
| ||||||||
command_script_param | no | This argument contains a parameter string, which will be appended to the script or script file remotely if the | ||||||||
create_env_vars | no | Populates the remote shell with JS7_* environment variables of the current taskjob, for a full list see JS7 - Job Environment Variables, chapter: Environment Variables that are automatically available to Shell Jobs | ||||||||
filter_regex | no | .* | This argument specifies a regular expression to filter variables that should be propagated to the remote shell as environment variables. Names of environment variables on the remote host are prefixed with JS7_VAR_ and the variable name is spelled in upper case letters, for example myVariable => JS7_VAR_MYVARIABLE If no regular expression is specified then all variables are propagated.
| |||||||
proxy_host | no | The value of this argument is the host name or the IP address of a proxy used to establish the connection to the SSH server. Use of a proxy is optional. | ||||||||
proxy_port | no | This argument specifies the port number of a proxy that is used to establish the connection to the SSH server. | ||||||||
proxy_user | no | The value of this argument specifies the user account for authentication with the proxy server that is used to connect to the SSH server. | ||||||||
proxy_password | no | This argument specifies the password for the proxy server user account if a proxy is used to connect to the SSH server. | ||||||||
ignore_error | no | false | If the value of this argument is set to | |||||||
exit_codes_to_ignore | no | This argument is used to specify one or more exit codes that will not be considered as errors. Multiple exit codes can be defined using comma separated values. |
| |||||||
ignore_stderr | no | This job checks if any output to stderr has been created by a command that is executed on the SSH server and reports such output as an error. | ||||||||
simulate_shell | no | If this value is set to | ||||||||
credential_store_file | no | Location of a credential store database (*.kdbx) | ./config/private/jobs.kdbx | |||||||
credential_store_key | no | Location of a credential store key file (*.key) | ./config/private/jobs.key |
...
The SSHJob can be used with a credential store to hold sensitive arguments. For use of the credential_store_*
arguments see JS7 - Use of Credential Store with JITL Jobs.
Variables
The SSHJob has access to variables from the following sources:
- Global Variables
- Sources
- The variables are available from any Agent and are used to populate the remote shell.
- For a full list see JS7 - Job Environment Variables, chapter: Environment Variables that are automatically available to Shell Jobs.
- Mapping
- Environment variables use the prefix
JS7_
.
- Environment variables use the prefix
- Sources
- Specific Variables
- Sources
- Order variables that are added when planning or submitting an order.
- Workflow variables that are added dynamically during execution of the workflow.
- Job Resource variables that are added from JS7 - Job Resources at workflow level and at job level.
- Mapping
- Specific variables use names within the scope of JS7 - Object Naming Rules and are mapped to environment variables in the remote SSH session:
- Environment variables use the prefix
JS7_VAR_
. - If the same variable names are used in a number of sources then the following precedence applies:
- order variables, workflow variables, job resource variables.
- for job resource variables the order of assignment of the job resource is considered: a variable with the same name used by a previously assigned job resource will not be overwritten by a later job resource. Job resources assigned at workflow level take priority over job resources assigned at job level.
- Sources
Examples:
- The global variable
JS7_AGENT_TZ
is available with the remote SSH session and indicates the JS7 Agent's local time zone. - A specific variable
$dbName
is mapped to the environment variableJS7_VAR_DBNAME
in the remote SSH session. - A specific variable
$ScriptDir
is specified by a job resource with a value /usr/scripts and is declared with a workflow using the default value /var/scripts. The resulting environment variableJS7_VAR_SCRIPTDIR
will hold the value /var/scripts unless a different value is specified by the order that is added to the workflow.
Further Resources
...