# SSH

The SSH node is useful for executing commands via the Secure Shell Protocol.

🔑 Credential

You can find authentication information for this node here.

# Basic Operations

  • Execute a command
  • Download a file
  • Upload a file

Note: To attach a file for upload, you will need to use an additional node such as the Read Binary File node or the HTTP Request node to pass the file as a data property.

# Node Reference

  • Authentication: A dropdown list to choose between Password or Private Key authentication.
  • Resource: A dropdown list used to specify if you are executing a command or processing a file.
  • Operation: A dropdown list to select the action to be performed. When selecting Command as the Resource, only Execute is available. For a File Resource you can select either Upload or Download.
  • Command: Only visible for Command resources. The command to execute on the remote machine.
  • Working Directory: Only visible for Command resources. The directory where the command should be executed.
  • Path: Only visible for Download operation on file resources. The path where the desired file is found.
  • Binary Property: Only visible for file resources. The name of the binary property which contains the data for the file to be uploaded.
  • Target Directory: Only visible for Upload operations on file resources. The directory to upload the file to. The name of the file does not need to be specified, it's taken from the binary data file name. To override this behavior, set the parameter File Name under options.

# Example Usage

This workflow allows you to remotely connect to your computer via SSH. This example usage workflow would use the following nodes.

The final workflow should look like the following image.

A workflow with the SSH node

# 1. Start node

The start node exists by default when you create a new workflow.

# 2. SSH node

  1. From the SSH Credentials dropdown, select Create New or an existing credential.
  2. Select Password from the Authentication dropdown list.
  3. Select Command from the Resource dropdown list.
  4. The Execute option is automatically selected as the Operation.
  5. In the Command field enter the command to execute. Here we used ls just to see the local directory contents.
  6. In the Working Directory field you can enter where the command should be executed. Here we ran it in the root directory.
  7. Click on Execute Node to run the node.

SSH Node