Custom SSH

Execute commands on network devices via SSH with configurable ciphers

Actions5

Backup Configuration

AI-generated

Overview

This node operation connects to a network device via SSH to backup its configuration. It supports retrieving either the running or startup configuration and can return the configuration as plain text or as a binary file. This is useful for network administrators who want to automate configuration backups of devices such as switches, routers, or gateways.

Use Case Examples

  1. Backing up the running configuration of a Cisco IOS device to text output for audit purposes.
  2. Backing up the startup configuration of an Aruba OS switch and saving it as a binary file for archival.

Properties

Name Meaning
Host IPv4/IPv6 address or hostname of the device to connect to via SSH.
Port SSH port of the device, default is 22.
Cipher Selection Select specific cipher or cipher group for the SSH connection to ensure compatibility and security.
Configuration Type Type of configuration to retrieve: running (current active) or startup (used at boot).
Return Type Format to return the configuration: as text or as a binary file.
Advanced Security Options Options to configure compatibility level, security level, and allowance of legacy algorithms for the SSH connection.
Connection Options Various connection parameters such as timeouts, prompts, retry behavior, logging, terminal type, and device-specific settings to optimize SSH connection and command execution.

Output

Binary

When 'Return Type' is set to 'Binary File', the configuration is returned as a binary file with MIME type 'text/plain' and a filename formatted as '_-config.txt'.

JSON

  • success - Indicates if the backup operation was successful.
  • host - The device hostname or IP address.
  • configType - The type of configuration backed up (running or startup).
  • configuration - The configuration text retrieved from the device (present if return type is text).
  • fileName - The name of the binary file containing the configuration (present if return type is binary).
  • cipher - The cipher used for the SSH connection.

Dependencies

  • An SSH password credential is required for authentication.

Troubleshooting

  • Ensure SSH credentials are correctly configured and provided; missing credentials will cause connection failure.
  • Verify the device is reachable at the specified host and port and that SSH is enabled.
  • If the selected cipher is not supported by the device, enable fallback ciphers or select a compatible cipher manually.
  • Timeouts may occur if the device is slow to respond; adjust connection and prompt timeouts accordingly.
  • For binary output, ensure the downstream nodes can handle binary data properly.

Discussion