Overview

This node operation connects to a network device via SSH to retrieve the current running configuration of the device. It is useful for network administrators who need to audit, backup, or analyze the live configuration of network devices such as routers or switches. For example, it can be used to automatically fetch and store device configurations for compliance or troubleshooting purposes.

Use Case Examples

1. Automatically fetch the running configuration of a Cisco router to back it up before making changes.
2. Retrieve the current configuration of multiple network devices in a workflow to compare settings or detect unauthorized changes.

Properties

Output

JSON

• success - Indicates if the command to get the running configuration was successful.
• command - The operation command executed, here it would be 'getRunningConfig'.
• output - The actual running configuration data retrieved from the device.
• deviceType - Type of the network device connected to.
• host - Hostname or IP address of the network device.
• timestamp - ISO timestamp when the command was executed.
• executionTime - Time taken in milliseconds to execute the command.
• connectionRetries - Number of connection retry attempts made.
• commandRetries - Number of command retry attempts made.
• error - Error message if the command execution failed.

Dependencies

• Requires SSH access credentials to the network device, including host, port, username, authentication method (password or private key), and optionally jump host settings if used.

Troubleshooting

• Connection failures due to incorrect credentials, network issues, or device unavailability. Check credentials and network connectivity.
• Command execution failures due to unsupported commands on the device or timeout settings being too low. Adjust command timeout and verify device compatibility.
• Workflow failure if 'Fail on Error' is enabled and the command fails. Consider disabling this option to allow workflow continuation on errors.

Links

• Network Configuration - Wikipedia - General information about network device configurations.
• SSH Protocol - Information about SSH protocol used for secure device connections.