Overview
This node, named "Net Devices," allows users to manage network devices via SSH by executing various operations such as retrieving the current running configuration, rebooting the device, saving the configuration, sending commands, or sending configuration commands. It is particularly useful in network automation workflows where administrators need to programmatically interact with network devices for monitoring, configuration, or maintenance tasks.
For example, a user can automate the retrieval of a device's running configuration to back it up regularly, or send configuration commands to update interface settings without manual SSH login.
Properties
| Name | Meaning |
|---|---|
| Advanced Options | Collection of optional parameters to customize connection and command execution behavior: |
| - Auto Disconnect | Whether to automatically disconnect after command execution (true/false) |
| - Command Retry Count | Number of retry attempts for command failures (1 to 5) |
| - Command Timeout | Timeout for command execution in seconds (2 to 300) |
| - Connection Pooling | Whether to enable connection pooling for better performance (true/false) |
| - Connection Retry Count | Number of retry attempts for connection failures (1 to 10) |
| - Connection Timeout | Timeout for establishing connection in seconds (3 to 300) |
| - Fail on Error | Whether to fail the workflow on command errors (true/false) |
| - Fast Mode | Whether to enable fast mode for simple commands (skips setup steps) |
| - Retry Delay | Delay between retry attempts in seconds (1 to 60) |
| - Reuse Connection | Whether to reuse existing connections when possible (true/false) |
Output
The node outputs an array of JSON objects, each representing the result of the operation performed on a network device. The structure includes:
success(boolean): Indicates if the operation succeeded.command(string): The name of the executed operation or command.output(string): The textual output returned from the device (e.g., running config, command response).deviceType(string): The type/model of the network device.host(string): The hostname or IP address of the device.timestamp(ISO string): The time when the operation was executed.executionTime(number): Duration in milliseconds taken to execute the command.connectionRetries(number): Number of connection retry attempts made.commandRetries(number): Number of command retry attempts made.error(string, optional): Error message if the operation failed.
If the node encounters errors but is configured to continue on failure, it outputs error details similarly structured.
The node does not output binary data.
Dependencies
- Requires an API key credential to authenticate and connect to the target network device(s) over SSH.
- Supports authentication via password or private key with optional passphrase.
- May use a jump host (bastion) for connecting through intermediate hosts if configured.
- Relies on internal utilities for SSH connection handling and command execution.
- No additional external services are required beyond the network device itself.
Troubleshooting
- Connection Failures: If the node cannot connect to the device, it retries based on the configured connection retry count and delay. Common causes include incorrect credentials, unreachable host, or network issues.
- Command Execution Errors: Commands may fail due to syntax errors, unsupported commands on the device, or device state. The node retries command execution per the configured retry count.
- Timeouts: Both connection and command execution have configurable timeouts. If these are too low, operations may fail prematurely; increase timeout values as needed.
- Fail on Error Setting: If enabled, the node will stop the workflow on errors; disabling it allows the workflow to continue and outputs error details instead.
- Fast Mode: Enabling fast mode skips some setup steps and may cause issues with complex commands; disable if unexpected errors occur.
- Reuse Connection: When enabled, the node attempts to reuse existing SSH connections which can improve performance but may cause stale session issues.