Description:

This step executes a command on a remote server using the Secure Shell (SSH) protocol.

The Send SSH Command workflow step establishes an SSH connection to a specified remote host using the supplied connection details, executes the specified command, captures the command output, and stores the result in a FlowWright Variable or Global Variable.

This step provides an efficient way to automate remote server administration, application deployment, infrastructure monitoring, DevOps operations, and system integration directly from FlowWright workflows.

The step supports:

• Remote command execution over SSH
• Configurable host and port
• Username and password authentication
• Dynamic command execution using workflow variables
• Storage of command output in Variables or Global Variables
• Integration with Linux, UNIX, and other SSH-enabled systems

This step can be used for:

• Remote server administration
• DevOps automation
• Application deployment
• Infrastructure monitoring
• System health verification
• Batch server operations
• Business process automation

Usage:

The Send SSH Command step is typically placed before deployment, monitoring, configuration management, or system validation activities within a workflow.

The workflow connects to the specified remote server, executes the configured command, and stores the command output for use by subsequent workflow steps.

A typical workflow might look like this:

Once the command has been executed, later workflow steps can:

• Evaluate the command output
• Update workflow variables
• Generate reports
• Trigger deployment activities
• Send notifications
• Create audit records
• Continue infrastructure automation workflows

The remote server must be reachable over the network and configured to accept SSH connections before this step is executed.

Example:

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

• Create a new process definition named “clsSSHCommandDef” and open it 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. Enter the remote host and port. Enter the SSH command. Specify 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. Enter the username and password. Click the Save button. 

• The “Logging” configuration is necessary for documentation and also measures workflow progress and 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 Process Instance and execute it. When the workflow reaches the Send SSH Command step, FlowWright establishes an SSH connection to the specified host using the configured connection information, executes the specified command, captures the command output, and stores the result in the configured Variable or Global Variable. If the operation completes successfully, the workflow follows the True return path. If the server cannot be reached, authentication fails, the command cannot be executed, or the SSH session cannot be established, the workflow follows the False return path. 
• Click the process step to view its properties. The step should successfully execute the command, store the command output, and return True upon completion. Verify that the configured Variable or Global Variable contains the expected command output.

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

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

Tips:

• Verify that the remote server is reachable before executing the workflow.
• Ensure that the SSH service is enabled and listening on the configured port.
• Use an account with only the permissions required to execute the intended commands.
• Store sensitive information such as usernames and passwords securely using FlowWright variables or secure configuration mechanisms.
• Use workflow variables to dynamically build commands during runtime.
• Validate the command output before using it in subsequent workflow steps.
• Use the True and False return paths to implement appropriate success and error handling.
• Combine this step with REST Call, Update Variables, Send Email, Conditional Routing, or PowerShell workflow steps to automate infrastructure management and deployment workflows.

Notes:

• The remote server must support SSH connections.
• The executing workflow must have network connectivity to the specified host and port.
• Invalid hostnames, authentication failures, firewall restrictions, or unavailable SSH services may cause the step to return False.
• Long-running commands may increase workflow execution time.
• Command output is stored in the configured Variable or Global Variable for use by subsequent workflow steps.
• Avoid embedding sensitive credentials directly within workflow definitions whenever possible.
• The workflow should include appropriate error handling for the False return path.
• Ensure that executed commands comply with your organization's security, infrastructure, and operational policies.

Definition Sample:

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

Note: Verify and complete any missing configuration after importing the sample, including:

• Host name or IP address
• SSH port
• Username and password
• Command configuration
• Output variable mapping
• Network connectivity
• Environment-specific settings

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.