JS7 JobScheduler

Space shortcuts

Page tree

Versions Compared

Old Version 31

changes.mady.by.user Santiago Aucejo Petzoldt

Saved on

compared with

New Version Current

changes.mady.by.user Andreas Püschel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameRequiredDefault ValuePurposeExample
hostyes

This argument specifies the hostname or IP address of the SSH server to which a connection is to be made.


user

yes

This argument specifies the user account to be used when connecting to the SSH server.


portno22

This argument specifies the port number of the SSH server.


auth_methodnopublickey

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 auth_file argument when the publickey authentication method is used. If the private key file is secured by a password then this has to be specified with the password argument. Available authentication methods depend on the SSH server configuration. Not all SSH server configurations support the password authentication method.


passwordno

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_method argument. 
Alternatively, this argument is used to specify the passphrase for a private key if the publickey authentication method is used with the auth_method argument.


auth_fileno

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 auth_method argument. 
If the private key file is secured with a passphrase then the passphrase has to be specified with the password argument.


command_delimiterno%%

Command delimiter characters can be specified using this argument. These delimiters are used in command arguments to separate multiple commands. The commands can be executed in separate SSH sessions.


commandno

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_delimiter argument.


command_scriptno

This argument can be used as an alternative to command, command_delimiter and command_script_file. It contains script code that will be stored to a temporary file on the remote host and will be executed. The script can access task and order arguments by environment variables. Environment variable names are written in upper case. Order arguments overwrite a job's arguments of the same name.


command_script_fileno

This argument can be used as an alternative to command_script. It contains the name of a local file that will be transferred to the remote host and will be executed. The script can access order variables from environment variables. Environment variable names are written in upper case.

Note

The SSH Job can transfer a command script file to the remote host only if SFTP is allowed on the remote SSH Server.


command_script_paramno

If the command_script or command_script_file argument is used then this argument can hold an argument string that is passed on when executing the command script file on the remote host.


create_env_varsno
Populates the remote shell with the JS7_* environment variables of the current job, for a full list see JS7 - Job Environment Variables, chapter: Environment Variables that are automatically available to Shell Jobs
filter_regexno.*

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.

Display feature availability
StartingFromRelease2.3.0


proxy_hostno

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_portno

This argument specifies the port number of a proxy that is used to establish the connection to the SSH server.


proxy_userno

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_passwordno

This argument specifies the password for the proxy server user account if a proxy is used to connect to the SSH server.


ignore_errornofalse

If the value of this argument is set to true then execution errors caused by commands on the SSH server will be ignored. Otherwise such execution errors are reported by the Agent.


exit_codes_to_ignoreno

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 semicolon separated values.

Note
The semicolon delimiter is part of the JITL JobArgument implementation and is used in all JobArguments of the type List. It is independent from the command_delimiter argument, which is only available with the JITL SSHJob to separate a number of commands on the remote side.

2;3;4;100

ignore_stderrno

This job checks if any output to stderr has been created by a command that is executed on the SSH server. It reports such output as an error and fails the current order.
If the value is set to true then output to stderr will be reported as an error by the Agent but will not fail the current order.


simulate_shellno

If this value is set to true then a pseudo-terminal similar to a shell is used to execute commands. Some scripts may cause problems if no shell is present. In addition, this argument can be required by older SSH daemons to detect whether the SSHJob has closed the connection and killed terminated running child processes.


credential_store_fileno
Location of a credential store database (*.kdbx)./config/private/jobs.kdbx
credential_store_keyno
Location of a credential store key file (*.key)./config/private/jobs.key

...

  • The cancel operation is applied to the order, not to the SSHJob. In case of cancellation the job will continue until completion and the order will be put in the failed state.
  • The cancel/killforce operation is applied to the order and to the job. The SSHJob will be killed immediatelyforcibly terminated, similarly child processes in the remote SSH session will be killedterminated. The order will be put in set to the failed state.
    • For older SSH servers, for example OpenSSH before version 7.5, to kill terminate child processes in the remote SSH session the simulate_shell job attribute has to be used.

...