SSH Interface
The SSH interface type defines the communication details with a remote machine using SSH protocol.
To create a new SSH interface, do the following:
Go to Project Tree > Shared Objects, right click Interfaces, select New Interface and then select SSH from the Interface Type dropdown menu to open the New Interface window.
Populate the connection's settings and click Save.
Go to Project Tree > Shared Objects, right click Interfaces, select New Interface and then select SSH from the File System section to open the New Interface window.
Enter a suitable name for your new SSH Interface, then click Create:
Populate the connection's settings and click Save.
Connection Settings
| Parameter | Description |
| Host | Hostname or IP address of the remote server. |
| Port | Port of the remote server. |
| User | Username. |
| Password | Password. |
Example of Using an SSH Interface
To create a Broadway Flow that runs on an SSH interface, do the following:
Create an interface using SSH interface type.
Create a Broadway flow either under Shared Objects or under a Logical Unit. Add a new Actor called SSH Actor, use the Interface defined in Step one and use the ls command.
SSH Actor Error Handling in Broadway Automation
When using the SSH actor in Broadway automation to execute shell commands on remote systems, the following logic governs how output and errors are handled:
Command Completion and Exception Handling
Successful Completion: If the executed command exits with code 0, the actor does not raise an exception, regardless of whether any output is present on STDERR.
Failure Handling: If the command exits with a non-zero exit code, the actor raises an exception. The exception message includes:
- The command’s exit code (e.g., Error code 4)
- The full contents of STDERR, to assist with diagnostics
Output Stream Behavior
- When the command completes successfully (exit code = 0), the contents of STDERR (if any) are merged into the STDOUT stream. This ensures that all command output, including non-critical diagnostics, is available for processing in subsequent steps.
This behavior ensures reliable automation by distinguishing between actual failures and informational output, while preserving all relevant command output for review and processing.
SSH Interface
The SSH interface type defines the communication details with a remote machine using SSH protocol.
To create a new SSH interface, do the following:
Go to Project Tree > Shared Objects, right click Interfaces, select New Interface and then select SSH from the Interface Type dropdown menu to open the New Interface window.
Populate the connection's settings and click Save.
Go to Project Tree > Shared Objects, right click Interfaces, select New Interface and then select SSH from the File System section to open the New Interface window.
Enter a suitable name for your new SSH Interface, then click Create:
Populate the connection's settings and click Save.
Connection Settings
| Parameter | Description |
| Host | Hostname or IP address of the remote server. |
| Port | Port of the remote server. |
| User | Username. |
| Password | Password. |
Example of Using an SSH Interface
To create a Broadway Flow that runs on an SSH interface, do the following:
Create an interface using SSH interface type.
Create a Broadway flow either under Shared Objects or under a Logical Unit. Add a new Actor called SSH Actor, use the Interface defined in Step one and use the ls command.
SSH Actor Error Handling in Broadway Automation
When using the SSH actor in Broadway automation to execute shell commands on remote systems, the following logic governs how output and errors are handled:
Command Completion and Exception Handling
Successful Completion: If the executed command exits with code 0, the actor does not raise an exception, regardless of whether any output is present on STDERR.
Failure Handling: If the command exits with a non-zero exit code, the actor raises an exception. The exception message includes:
- The command’s exit code (e.g., Error code 4)
- The full contents of STDERR, to assist with diagnostics
Output Stream Behavior
- When the command completes successfully (exit code = 0), the contents of STDERR (if any) are merged into the STDOUT stream. This ensures that all command output, including non-critical diagnostics, is available for processing in subsequent steps.
This behavior ensures reliable automation by distinguishing between actual failures and informational output, while preserving all relevant command output for review and processing.
