Config Docs

ssh-workflows

SSH Workflows — PacketPilot Config

Adding a Device

By IP Address

  1. Open the Inventory tab
  2. Click Add Device
  3. Enter the device IP address or hostname
  4. Select the vendor (or Auto-detect)
  5. Enter SSH credentials:
    • Username
    • Password (or SSH key file path)
  6. Click Save

The device is added to the inventory. Config will test the SSH connection immediately.

By Subnet Scan

  1. Open the Inventory tab
  2. Click Scan Subnet
  3. Enter a subnet in CIDR notation (e.g. 192.168.1.0/24)
  4. Click Scan

Config scans the subnet and lists all discovered hosts. For each host that responds on port 22, it attempts to identify the vendor from the SSH banner. Select the devices you want to add, enter credentials once, and click Add Selected.

Note: Credentials entered during scan are used for all discovered devices. If devices have different credentials, add them individually or in groups by vendor.

SSH Sessions

Opening a Session

Double-click a device in the inventory to open an SSH terminal in a new tab.

The terminal opens in the Sessions tab and behaves like a standard SSH client. All terminal output is logged.

SSH Authentication Methods

Password authentication:

  • Config prompts for the password on session open if credentials are not stored
  • Optionally save the password in the device record (encrypted with your master password)

SSH key authentication:

  • Specify the private key file path in the device record
  • Supported formats: OpenSSH (PEM-compatible), PPK (PuTTY), RSA/DSA/ECDSA

Multi-Device Sessions

Click Multi-SSH in the toolbar, select multiple devices in the inventory, and click Open. A separate terminal tab opens for each device. Commands typed in one tab are not automatically broadcast — use the Bulk Operations panel for that.

Bulk Operations

Bulk Operations let you send the same command or configuration to multiple devices simultaneously.

Running a Bulk Command

  1. Select two or more devices in the inventory
  2. Click Bulk Operations in the toolbar
  3. Enter a command (e.g. show version) or a configuration block
  4. Click Run

Results appear in a split panel — one column per device. Output is color-coded:

  • Green: command succeeded
  • Red: command failed
  • Yellow: partial output or warning

Applying Configuration Changes

Enter configuration mode commands (e.g. Cisco IOS configuration statements). Config will enter configuration mode on each device and apply the changes in sequence.

Example: Enable SNMP on multiple switches:

configure terminal
snmp-server community public ro
snmp-server location Server-Room-A
end
copy running-config startup-config

Rollback

If any device reports an error during a bulk config push, Config can automatically roll back the entire change set. Enable Auto-rollback on error in the Bulk Operations panel before running.

Capturing and Exporting

Capturing Command Output

Right-click a device or session tab and select Capture Output. All subsequent output in that session is saved to a file.

To export a captured session:

  1. Open the session tab
  2. Click Export in the session toolbar
  3. Choose format: Plain text (.txt), JSON, or PDF

Exporting Findings for Analyze

Config can export device findings as a structured JSON or PDF report that can be imported directly into PacketPilot Analyze.

To export:

  1. Right-click a device or multi-selection

  2. Select Export Findings

  3. Choose:

    • JSON — structured findings with device context, ideal for API-based workflows
    • PDF — human-readable report with findings, recommendations, and raw output snippets

  4. Save the file, then open Analyze and upload it as a new case

Device Management

Credential Storage

Credentials are stored in Config's local SQLite database, encrypted with the master password you set on first launch. They are never sent to any external service.

To update credentials for a device:

  1. Right-click the device → Edit Device
  2. Update username/password
  3. Click Save

Device Groups

Organize devices into groups for easier bulk operations. Right-click the inventory → New Group. Drag devices into groups.

Config Backups

Enable automatic config backups for a device:

  1. Right-click the device → Schedule Backup
  2. Choose frequency: daily, weekly
  3. Config automatically runs show running-config and stores the output locally

To restore:

  1. Right-click the device → Backups
  2. Select a backup from the list
  3. Click Restore

Troubleshooting SSH Connection

| Symptom | Likely Cause | Fix | |---------|-------------|-----| | "Connection refused" | SSH service not running on device | Check show ssh on the device | | "Authentication failed" | Wrong username or password | Re-enter credentials in device edit | | "Connection timed out" | Firewall blocking port 22 | Verify network path from Config PC to device | | "Host key verification failed" | Device SSH host key changed | Right-click device → Reset Host Key | | "No route to host" | Wrong IP or subnet issue | Ping device from Config PC to verify | | Device appears offline after scan | Device blocks ICMP | Use SSH-port scan instead of ICMP scan in Settings |