...
A minimal SSH Job configuration
Excerpt | |||||||||
---|---|---|---|---|---|---|---|---|---|
|
Parameters
- Required Parameters
- Parameters which have to be set in the job configuration to properly run the job
- Example: The
host
parameter is always required to run a job that connects to a remote host.
- Example: The
- Parameters which have to be set in the job configuration to properly run the job
- Optional Parameters
- Parameters which are not required or parameters which are technically required but are instantiated through a default value and therefore do not have to be set in the job configuration
- Example 1: technically required, but instantiated with default value
- To connect to a remote host, the
port
parameter is required. The parameter is instantiated with the default value22
therefore theport
parameter does not have to be set in the job configuration.
- To connect to a remote host, the
- Example 2: not required
- The
proxy_host
parameter is only used if the jobs connection has to be instantiated over a proxy, otherwise it is not needed at all
- The
- Example 1: technically required, but instantiated with default value
- Parameters which are not required or parameters which are technically required but are instantiated through a default value and therefore do not have to be set in the job configuration
...
- default value:
- empty
- description:
- This parameter specifies the path and name of a user's private key file used for registration on an SSH server. This parameter must be specified if the publickey authorization method has been specified in the
auth_method
parameter.
If the private key file is secured with a passphrase, thepassword
parameter the passphrase parameter hat to be set with the passphrase.
- This parameter specifies the path and name of a user's private key file used for registration on an SSH server. This parameter must be specified if the publickey authorization method has been specified in the
...
- default value:
- empty
- description:
This parameter can be used as an alternative to
command
,command_delimiter
andcommand_script
. It contains the name of a local (script-)file, which will be transferred to the remote host and executed there. The script can access task and order parameters by environment variables. Environment variable names are written in upper case and have "SCHEDULER_PARAM_" as a prefix. Order parameters with the same name overwrite task parameters.Note The SSH Job is only able to transfer a command script file to the remote machine if SFTP is allowed on the remote SSH Server.
proxy_host
- default value:
- empty
- description
- 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.
...