Command Execution › Run SSH Script Operator

Run SSH Script Operator

The Run SSH Script operator works in interactive mode to accommodate network devices, where the presence of a file system is unknown.

Note: For non-interactive SSH communication, use a proxy touchpoint or a host group.

The operator uses the login credentials that you specify to do the following:

• Open an SSH connection to the remote host.
• Build a "conn" object.

  Note: When you specify a script, either bean shell or JavaScript, the "conn" object is made available in the scope of this script.

  You can leverage the public methods of the "conn" object in the script. You can use these public methods to automate operations executed on an SSH pseudo terminal. Examples include sending commands to the remote SSH host, waiting for the prompt after sending each command, and retrieving the output of each command from the server through SSH.

Unlike the Run Telnet Script operator, the Run SSH Script operator provides you with the "conn" object after logging in to the SSH host.

The difference between the Run SSH Script operator and the Run SSH Commands operator is that in the Run SSH Commands operator:

• The output of all commands can be automatically saved in the operator’s dataset.
• The regular expression specified in the user command prompt field is used to match the prompt after execution of all commands in the list.
• The time to wait for prompts applies to all commands in the list, hence it should be greater than the execution time of the longest command in the list.

While in the Run SSH Script:

• You can specify which command output to view or save in the operator’s dataset by calling the following commands in this sequence:
  1. ‘conn.sendLine()’
  2. ‘conn.waitFor()’
  3. ‘conn.getLastOutput()’
• You can specify a different regular expression to match the prompt after execution of each command.
• You can specify a different time to wait for the prompt after execution of each command.