Skip to main content

Connect

Establishes an SSH connection to a remote server.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs​

  • Host - The hostname or IP address of the SSH server.
  • Port - The port number for the SSH connection. Default is 22.
  • Private Key Path - The file path to the private key for authentication (optional if using password).

Options​

  • Ignore Host Key Check - When enabled, skips verification of the server's host key. Security risk, use with caution.
  • Timeout - The maximum time (in seconds) to wait for the connection to be established. Default is 30 seconds.
  • Credentials - The SSH credentials containing username and password for authentication.

Output​

  • Client Id - A unique identifier for the established SSH connection, used by other SSH nodes.

How It Works​

The Connect node establishes an SSH connection to a remote server using either password or private key authentication:

  1. Validates the provided credentials (must include a username)
  2. If a private key path is provided, uses key-based authentication
  3. Otherwise, uses password authentication from the credentials
  4. Validates the host and port values
  5. Establishes the SSH connection with the specified timeout
  6. Stores the connection and returns a client ID for use with other SSH nodes

Requirements​

  • Valid SSH server hostname or IP address
  • Valid credentials with username (and password if not using private key)
  • Network access to the SSH server on the specified port
  • Private key file (if using key-based authentication)

Error Handling​

The node will return specific errors in the following cases:

  • Empty or invalid username in credentials
  • Invalid private key file path
  • Missing password when private key path is not provided
  • Empty or invalid host value
  • Invalid port number (must be greater than zero)
  • Connection timeout exceeded
  • SSH authentication failures
  • Network connectivity issues

Usage Notes​

  • The client ID output must be passed to other SSH nodes to perform operations
  • For security, it's recommended to use private key authentication instead of passwords
  • The connection should be closed using the Disconnect node when no longer needed
  • When using "Ignore Host Key Check", be aware of the security implications of man-in-the-middle attacks