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