Net Devices

Manage network devices via SSH

Actions5

Overview

The "Net Devices" node enables managing network devices via SSH by sending configuration commands, running commands, rebooting devices, saving configurations, and retrieving the current running configuration. It is particularly useful for network administrators who want to automate device management tasks such as pushing configuration changes, collecting device status, or performing maintenance operations.

For the Send Config operation specifically, the node sends multiple configuration commands (one per line) to a network device. This is beneficial when automating bulk configuration updates, such as enabling interfaces, setting descriptions, or applying security policies.

Practical examples:

Automate interface configuration changes across multiple switches.
Push VLAN or routing protocol configurations to routers.
Apply security hardening commands on firewalls in batch mode.

Properties

Name	Meaning
Configuration Commands	The configuration commands to send to the device, entered as multiple lines (one command per line).
Advanced Options	A collection of optional settings to control connection and command execution behavior:
- Auto Disconnect	Whether to automatically disconnect from the device after executing commands (default: true).
- Command Retry Count	Number of retry attempts if a command fails (1 to 5, default: 2).
- Command Timeout	Timeout in seconds for each command execution (2 to 300, default: 10).
- Connection Pooling	Enable connection pooling for better performance (default: false).
- Connection Retry Count	Number of retry attempts if connection fails (1 to 10, default: 3).
- Connection Timeout	Timeout in seconds for establishing the connection (3 to 300, default: 15).
- Fail on Error	Whether to fail the workflow if a command error occurs (default: true).
- Fast Mode	Enable fast mode which skips setup steps for simple commands (default: false).
- Retry Delay	Delay in seconds between retry attempts (1 to 60, default: 2).
- Reuse Connection	Whether to reuse existing connections when possible (default: false).

Output

The node outputs an array of JSON objects, one per input item processed, with the following structure:

{
  "success": true,
  "command": "sendConfig",
  "output": "<string>",           // The raw output or response from the device after sending config commands
  "deviceType": "<string>",       // The type/model of the network device
  "host": "<string>",             // Hostname or IP address of the device
  "timestamp": "<ISO8601 string>",// Timestamp of execution completion
  "executionTime": <number>,      // Execution time in milliseconds
  "connectionRetries": <number>,  // Number of connection retry attempts configured
  "commandRetries": <number>,     // Number of command retry attempts configured
  "error": "<string>"             // Present only if the command failed, contains error message
}

If the node encounters errors and Fail on Error is disabled, it will output an object with "success": false and an "error" field describing the failure.

The node does not output binary data.

Dependencies

Requires an API key credential or equivalent authentication to connect to the network device via SSH.
The node depends on an underlying SSH connection handler utility (imported internally) to manage device communication.
Network devices must be reachable over the network and support SSH access.
Proper credentials (username/password or private key) must be configured in the node's credentials.
Optional jump host (bastion) support is available if configured in credentials.

Troubleshooting

Connection failures: If the node cannot connect to the device, verify network reachability, SSH service availability, and correct credentials. The node retries connection attempts based on the configured retry count and delay.
Command timeouts: Commands that take longer than the configured timeout will cause errors. Increase the Command Timeout if necessary.
Command failures: If a command fails, the node retries based on the retry count. If all retries fail and Fail on Error is enabled, the workflow will stop with an error.
Empty or invalid configuration commands: Ensure that the Configuration Commands property is not empty and commands are valid for the target device.
Reuse Connection issues: When reusing connections, stale or dropped connections may cause failures; disabling reuse can help isolate such problems.
Fast Mode: Enabling fast mode skips some setup steps; use it only for simple commands to avoid unexpected behavior.

Common error messages include:

Failed to connect to device ... after X attempts. — Check connectivity and credentials.
Command timeout after X seconds — Increase command timeout or optimize commands.
Command execution failed after X attempts — Review command syntax and device state.