clsSSHCommand Step

Use this step to send SSH command.

Last published at: August 22nd, 2025

Description:

This step sends an SSH command to a remote server. 

 

Inputs

  • host – Enter host info
  • port - Enter port info
  • username - Enter username
  • pass - Enter password
  • command - Enter command
  • varGlobal - Store result in the variable or global
 

 

Returns

  • True – step executed successfully 
  • False - step failed to execute 
 

 

 

Usage:

 

 

Example:

Let’s build and execute the “clsSSHCommandDef” example:

  • Create a new process definition called “clsSSHCommandDef” and open the definition in designer mode. 
  • Drag a “clsSSHCommand, and a placeholder step to the canvas.
  • Connect the dots between the “Start” and other steps, as shown above.
  • Configure the connection line properties between the steps, as shown above. 
  • Click the "clsSSHCommand" step to configure its "Required" properties. Provide a name for the step. Provide the remote host and port information. Provide the SSH command. Provide a variable or global to store the SSH command result. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description. 

 

  • Click the "clsSSHCommand" step to configure its "Optional" properties. Provide the username and password. Click the Save button. 

 

  • The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.

 

  • Save the process definition, create a new instance, and then execute it. Render the process instance. Click the process step to view its properties. The step should store the SSH command result in a variable or a global, as configured. 
  • The process instance may return “Error” due to incorrect configuration, as shown below. Click the process step to view the error information. 

 

  • An example is included here for reference. Click the “AI - How to Fix” button to view the suggestions. 

 

  • The suggestions generated by the “AI - How to Fix” are included here for reference. 

 

Definition Sample:

You may download the sample definition(s) from the link here and later import them (drag-and-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page. 

Note: Please verify and complete the process steps for any missing configurations, such as file path references and database connections, after import. Then, save the definition to confirm the changes. 

Click here to download the sample file.