Using rConfig CLI Diagnostic Tools

rConfig provides command-line tools for detailed device connectivity troubleshooting. These tools produce verbose output showing exact protocol interactions, timing, and where failures occur.

Looking for the in-browser version?

Since V8.2.0, the same debug run can be triggered and streamed inside the rConfig UI through the Live Debug Console. The CLI remains the right choice for long-running sessions that exceed the UI’s 5-minute streaming window or for hosts where shell-only access is preferred.

When to use this

Use the CLI diagnostic tool when a device backup fails and you need to see exactly what rConfig sends to the device and what comes back. It is the fastest way to diagnose authentication failures, prompt detection problems, and protocol errors without waiting for a scheduled backup job to retry.

Prerequisites

• Shell access to the rConfig server (SSH or console)
• The device ID of the device to test (found in the Devices list or the device detail page URL)
• Working directory of the rConfig installation: /var/www/html/rconfig8/current

Running the Debug Command

The primary diagnostic tool is the artisan rconfig:download-device command with the debug flag:

cd /var/www/html/rconfig8/current
php artisan rconfig:download-device <device_id> -d

Debug a single device (ID 1001):

cd /var/www/html/rconfig8/current
php artisan rconfig:download-device 1001 -d

Debug multiple devices:

php artisan rconfig:download-device 1001 1002 1003 -d

Run without verbose output (no -d flag, for a silent production-mode test):

php artisan rconfig:download-device 1001

Finding the Device ID

From the Devices list: The device ID appears in the leftmost column of the devices table.

From the device detail page: The ID appears in the page header. Click the Copy Debug Command icon to copy the complete debug command to your clipboard.

From the URL: The ID is the number at the end of the URL when viewing a device detail page:

https://rconfig.company.com/devices/1001
                                       ^^^^
                                    Device ID

Interpreting Debug Output

Debug output shows the full protocol conversation in sequence.

SSH session:

Connecting to device...
Authentication successful
Detecting prompt...
Prompt detected: Router#
Sending command: show running-config
[command output appears here line by line]
Prompt detected: Router#
Command complete
Configuration saved to: /path/to/config/file

Telnet session:

Connecting to device...
Username: admin
Password: ********
Login successful
Detecting prompt...
Prompt detected: Router>
Sending command: enable
Enable Password: ********
Prompt detected: Router#
Sending command: show running-config
[command output appears here]
Prompt detected: Router#

Key Patterns to Recognise

Timeout (prompt never detected):

Detecting prompt...
[60 second pause]
Error: Timeout waiting for prompt

Indicates the prompt configuration is incorrect or the device is not displaying the expected prompt. See Device Prompt Troubleshooting.

False prompt match (output truncated):

Sending command: show running-config
#config-version=...
Prompt detected: #
Command complete

rConfig matched # inside command output instead of waiting for the real prompt. The configuration is truncated. Fix by making the prompt more specific.

Authentication failure:

Connecting to device...
Username: admin
Password: ********
Error: Authentication failed
Permission denied

Incorrect username, wrong password, or the account is disabled on the device. See Authentication Verification.

Hung connection (no timeout, no output):

Connecting to device...
Authentication successful
Detecting prompt...
[indefinite hang with no output]

The device is waiting for input rConfig cannot provide: an initial configuration wizard, a banner requiring a keypress, or a privilege escalation prompt without credentials configured.

Saving Debug Output

Redirect output to a file for detailed analysis or to share with support:

php artisan rconfig:download-device 1001 -d > /tmp/device-1001-debug.txt 2>&1

Common mistakes

• Running the command from the wrong directory: The artisan command must be run from /var/www/html/rconfig8/current. Running it from another path will fail with a “command not found” error.
• Debugging multiple devices at once: While multiple device IDs are supported, debug one device at a time for clean, readable output. Resolve each device individually.
• Missing stderr in redirected output: Using > alone loses error messages. Always include 2>&1 to capture both stdout and stderr in the output file.

What’s next

• Live Debug Console - Stream the same debug output in the browser without shell access
• Device Prompt Troubleshooting - Fix prompt configuration if debug output shows a timeout or false prompt detection
• Advanced Troubleshooting Techniques - Diagnose timeout, stalled connection, and vendor-specific issues