Command Execution › Run SSH Command Operator › Input Parameters › Commands

Commands

Remote Hostname

The host name or IP of the computer to connect to.

Use Indexed String Variable for Commands?

If this check box is not selected, you can enter commands in the Commands field. Select this field to specify the commands as indexed String variables in the Commands Indexed String Variable field.

Commands

List of commands to execute on the remote host. Do not end the list with an 'exit' command, as the operator automatically exits the SSH session after the last command executes.

Commands Indexed String Variable

Name of the dataset variable that contains a list of commands to execute on the remote host. Do not end the list with an 'exit' command, as the operator automatically exits the SSH session after the last command executes.

Save Output to Dataset Variable?

Select this check box to copy the output of each command to the dataset of the operator. The output of each command is stored in the SSHCommandsOutput variable.

Commands Output Size limit

Specifies the maximum number of bytes of each command's output to save in the dataset variable of the operator. If this number is not specified, the operator uses value: 4096.

User Command Prompt

This field serves two purposes:

• Indicates that the user is logged in. The operator looks for this prompt after the user logs in.
• Indicates that a command (in the list of Commands or Commands Array executed on the SSH session under this user) has finished. The operator can then send the next command in the list.

This field is generally an indication of the command prompt of the user. The field is typically specified as "#", "$", ">", and so on, but must be specified as a regular expression. For example: ".*[$>?:#]" to match any input (including new lines) followed by $ or > or ? or : or #. Specify all the prompts that you expect to see during the execution of the commands.

Important! Start the regular expression with .* to match all data returned by the command until the prompt shows up. This regular expression should match all output from the command until the next prompt.

Note: The brackets are required around the $ to indicate the $ character. $ has a special meaning in regular expressions if it is not surrounded by brackets.

Time to Wait for Prompts (sec):

The amount of time (in seconds) to wait for a prompt before giving up on the prompt to send the commands. If this field is left blank, the operator uses value: 60.

This field applies to the prompts expected after executing each command specified in the operator. The operator cannot tell if a command that executed in the SSH session returned all its data. The operator keeps reading the output of the command until it matches the specified User or Switch User Command prompt or until this timeout is up (whichever comes first). The operator then proceeds to process the output of the command before moving to the next command or failing the operator.

Important! Set this time to be greater than the execution time of the longest command that the operator executes.