...

The SSHJob arguments can look like this:

Explanation:

• The workflow implements two jobs:
  • Job: execute-ssh
    • Argument: command
      

      • The value of the argument is a number of shell commands:

        Code Block
        language bash linenumbers true
        echo "printing environment variables" printenv echo "adding hostname $HOSTNAME to variable remote_hostname" echo "remote_hostname=$HOSTNAME" >> $JS7_RETURN_VALUES

        The last line appends a key=value pair to a temporary file that is made available from the JS7_RETURN_VALUES environment variable. The name being remote_hostname and the value being provided from the HOSTNAME environment variable.
        This creates an order variable with the name remote_hostname that is available to subsequent jobs and instructions in a workflow.

    • Argument: create_env_vars
      • The argument is assigned the value true that specifies that for any order variables the job will create environment variables in the remote session.
        • For example, an order variable with the name date will be made available from the environment variable JS7_VAR_DATE.
      • For details see chapter Variables.
    • For the full list of available arguments see next chapter.
  • Job: display-result
    • Argument: no arguments
    • Environment Variables
      • The job is assigned an environment variable with the name REMOTE_HOSTNAME and the value $remote_hostname which is a reference to the order variable created by the previous job.
    • Script

      • The job script looks like this:

        Code Block
        language bash linenumbers true
        echo "using workflow: $JS7_WORKFLOW_NAME" echo "running job: $JS7_JOB_NAME" echo "remote hostname: $REMOTE_HOSTNAME"

        The job script makes use of the REMOTE_HOSTNAME environment variable that is populated from the order variable created by the previous job.

Documentation

The Job Documentation including the full list of arguments can be found under: https://www.sos-berlin.com/doc/JS7-JITL/SSHJob.xml

...

...

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.

Cancellation

The following operations are available:

Anchor
variables variables

...

Variables

Forwarding Variables

The SSHJob has access to variables from the following sources:

...

• 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 variable JS7_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 variable JS7_VAR_SCRIPTDIR will hold the value /var/scripts unless a different value is specified by the order that is added to the workflow.

Passing back Variables

The command script or commands of the SSHJob executed on the remote host can pass back variables to the workflow. To this purpose the command script or commands append any number of key=value pairs to a temporary file that will be picked up by the SSHJob. Each key=value pair is passed back to the workflow and becomes an order variable.

Example:

The command 

echo MYPARAM=myTestValue >> $JS7_RETURN_VALUES

appends MYPARAM=myTestValue to the temporary file defined by the environment variable JS7_RETURN_VALUES. For Unix the environment variable is specified using $JS7_RETURN_VALUES, for Windows the syntax is %JS7_RETURN_VALUES%.

The JS7_RETURN_VALUES environment variable is made available by the SSHJob during job execution. When the SSHJob completes it will read the key=value pairs from the temporary file and will add them as order variables to the job's outcome. The order variable MYPARAM  can be used in subsequent jobs. When calling up the variable the syntax $MYPARAM is used for Unix and Windows. Users should consider case-sensitive spelling of order variables.

Cancellation

The following operations are available:

• 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/force operation is applied to the order and to the job. The SSHJob will be forcibly terminated, similarly child processes in the remote SSH session will be terminated. The order will be set to the failed state.
  • For older SSH servers, for example OpenSSH before version 7.5, to terminate child processes in the remote SSH session the simulate_shell job attribute has to be used.

Further Resources

• JS7 - JITL Common ParametersVariables
• JS7 - Job Resources
• JS7 - Use of Credential Store with JITL Jobs

...