Product Knowledge Base

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

FEATURE AVAILABILITY STARTING FROM RELEASE 1.9

Mode Of Operation

The SOSSSHJob2JSAdapterJSch uses the JSch implementation from JCraft for SSH connections and adds the use of return values to the already existing functionality of the SOSSSHJob2JSAdapter class.

The Job sets an environment variable to the session on the remote host with the name "SCHEDULER_RETURN_VALUES" which is available for the script or command to be executed on the remote machine. The value for this environment variable will be generated at runtime.

After the execution of the script or command the jobs reads the return values from a temporary created file on the remote host, returns them to the Jobscheduler for further processing and deletes the temporary file afterwards.

passing variables back to the JobScheduler

To use this feature you have to make sure that your command or command script writes the key-value-pair you want to have passed back to the JobScheduler, to the temporarily created file.

example

The command

echo MYPARAM=myTestParam >> $SCHEDULER_RETURN_VALUES

writes

MYPARAM=myTestParam 

to the temporary file defined by

$SCHEDULER_RETURN_VALUES.

New Parameters

general information

The default values use the linux bash syntax. These parameters have to be set only if running on systems using a different syntax than the linux bash syntax. Please choose the format of the command value and it placeholders according to the operating system on the remote host.

preCommand

  • format: 
    • <command> <placeholder1> = <placeholder2>
  • default value: 
    • export %1s=%2s
  • description: 
    • The command to set an environment variable. The values for placeholders 1 and 2 will be set implicitly through the job execution. The placeholders are mandatory.

postCommandRead

  • format: 
    • <command> <placeholder>
  • default value: 
    • cat %s
  • description:
    • The command to read the temporary file where the return values are written to through the script/command execution of the SSH job. The placeholder will be substituted through the job execution. 

postCommandDelete

  • format: 
    • <command> <placeholder>
  • default value: 
    • rm %s
  • description:
    • The command to delete the temporary file with the return values. The placeholder will be substituted through the job execution. 

Configuration

The SOSSSHJob2JSAdapterJSch job will replace the existing SOSSSHJob2JSAdapter Job in future releases. 

To use the return-values-feature configure a SSH job with JOE and choose SOSSSHJob2JSAdapterJSch. 

Example of the parameter configuration for a Windows Client 

For known limitations using the SSH Job to connect to a Windows Remote Host see Limitations when using SSH jobs for Windows.

 

 

 

  • No labels