Command Execution › Run SSH Command Operator › Operator Ports

Operator Ports

Success

• The operator completed successfully.
• The operator depends on the patterns specified in User Command Prompt and Switch User Command Prompt to decide if a command (and the operator) succeeds or fails.

  For example, a pattern of ".*#" succeeds the following command: ‘badCmd’:

  1. The operator executes it:

    # badCmd
  

  2. The output is read (which matches .*# prompt):

    badCmd:  not found
    #
  

  3. Execute the next command.

Failure

• The user provides invalid input; for example, negative prompts timeout, blank user command prompt, and so on.
• Unable to establish a connection to the remote host. Check the remote host, user name, password, and keys provided to the operator.
• The user provides an unknown host in the remote host.
• Unable to authenticate the user on the remote host:
  • User/password authentication: user name or password is invalid
  • User/private key authentication:

    - A bad passphrase is provided for a passphrase-protected private key: the operator indicates it cannot read the key due to an internal IO problem

    - The passphrase is missing for a passphrase-protected private key: the operator indicates that the passphrase required for key authentication is not supplied.

    - A bad private key is provided: the operator indicates that it is unable to parse the private key, the key format is not supported, or that it cannot read the key due to an internal IO problem.

    - The path to the private key file is invalid, non-existent, or cannot be read.

• Unable to switch user. Could not match the data read from the SSH session (within the time to wait for prompts), with the specified Switch User Command Prompt pattern.
• Unable to switch user. Could not match the data read from the SSH session (within the time to wait for prompts), with the specified Switch User Password Text Prompt pattern.
• The user name/password provided are not allowed to log in through SSH.
• The operator could not match the command prompt (specified in User Command Prompt, or Switch User Command Prompt) with the output read from a command within the time to wait for prompts. In this case either:
  • The command finished execution and returned data that did not match the pattern in User Command Prompt, or Switch User Command Prompt.
  • The command’s execution is taking longer than the time to wait for prompts and the operator stopped reading the output data before the command finished. As a result, it did not match the data read with the pattern in User Command Prompt, or Switch User Command Prompt. In this case, you must increase the Time to Wait for Prompts to be greater than the execution time of the longest command in the list.

  Note: In this case, any subsequent commands in the list are not executed and the SSHCommandsOutput only contains the output of the commands that were executed before (including the output read for the current command).

Custom Ports

If set by the user during the process design.