...
- Required Parameters
- Parameters which are required to have to be set in the job configuration to proerly run the Jobjob
- Example: To connect to a remote host, the '
host' parameter is always required to run the job properly.
- Example: To connect to a remote host, the '
- Parameters which are required to have to be set in the job configuration to proerly run the Jobjob
- Conditional Optional Parameters
- Parameters which depend on other parameters
- Example: The value of the '
auth_method' parameter ('password' or 'publickey') determines whether one of the conditional parameters - the 'password' or 'publickey' parameter has to be set.
- Example: The value of the '
- are not required or parameters which are technically required but are instantiated throug 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 value '22' therefore the 'port' 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
- The '
- Example 1: technically required, but instantiated with default value
- Parameters which are not required, but depend on specific conditions
- Example: Only a '
host' parameter is required to connect with a remote host. However, if the- connection has to be instantiated over a proxy,
proxy_host' parameter is required.
- Example: Only a '
- Parameters which depend on other parameters
...
Some parameters are technically required to build a connection but are not shown in the 'Required Parameters' section of this document.
- otherwise it is not needed at all
Required Parameters
host
- default value:
- empty
- description:
- This parameter specifies the hostname or IP address of the SSH server to which a connection is to be made.
...