Custom SSH

Execute commands on network devices via SSH with configurable ciphers

Actions5

Restore Configuration

AI-generated

Overview

This node operation restores configuration to a network device via SSH. It supports applying configuration commands either from direct text input or from binary data provided by a previous node. Users can choose how to apply the configuration (merge or replace) and whether to save the configuration after applying. The node is designed for network administrators who need to automate configuration restoration on devices such as routers, switches, and access points, supporting various device-specific behaviors and security options.

Use Case Examples

  1. Restoring configuration commands entered as text to a Cisco IOS device, merging with existing configuration and saving afterward.
  2. Applying a binary configuration file to an Aruba OS switch, replacing the entire configuration without saving immediately.

Properties

Name Meaning
Host IPv4/IPv6 address or hostname of the device to connect via SSH.
Port SSH port number of the device.
Cipher Selection Select specific cipher or cipher group for the SSH connection.
Configuration Source Choose whether to provide configuration commands as text input or binary data from a previous node.
Configuration Commands Configuration commands to apply when using text input as the source.
Binary Property Name of the binary property containing the configuration file when using binary data as the source.
Apply Method How to apply the configuration: merge with existing or replace entirely.
Save After Apply Whether to save the configuration after applying it.
Advanced Security Options Options to configure compatibility level, security level, and allowance of legacy algorithms for the SSH connection.
Connection Options Various connection-related options such as timeouts, prompts, retries, logging, terminal type, and device type for vendor-specific optimizations.

Output

JSON

  • success - Indicates if the configuration restore was successful.
  • host - The hostname or IP address of the device.
  • linesApplied - Number of configuration lines applied to the device.
  • errors - Any errors encountered during the configuration application.
  • configSource - Source type of the configuration (text or binary).
  • applyMethod - Method used to apply the configuration (merge or replace).
  • savePerformed - Indicates if the configuration was saved after applying.
  • cipher - The cipher used for the SSH connection.

Dependencies

  • An API key credential for SSH authentication

Troubleshooting

  • Ensure the binary property name matches the property containing the binary data when using binary configuration source, otherwise an error 'No binary data found in property' will occur.
  • If the SSH credentials are missing or incorrect, the node will throw an error indicating no credentials provided for SSH connection.
  • Timeouts or prompt detection failures may occur if the regular expressions for username, password, or command prompts do not match the device's actual prompts; adjust these in connection options accordingly.
  • Using the 'Replace' apply method can be dangerous as it replaces the entire configuration; ensure you have backups before using this option.

Discussion