Skip to content

rConfig Oxidized Import Tool Guide

10 mins V7 Pro

Available from V7.3.5

rConfig Oxidized Import Tool

This tool allows you to import devices from Oxidized into rConfig. It includes commands for creating device mappings, loading devices from Oxidized, and importing them into rConfig.

Introduction

Thinking of moving on from Oxidized? You’re not alone. While Oxidized excels at collecting device configs, rConfig supercharges your workflow with scheduling, templating, auditing, and rich reporting—all in one place. Our Oxidized Import Tool smooths the transition: in just a few commands you’ll map device types, parse your hosts file, and import everything straight into rConfig. No manual copy‑and‑pasting—just rapid, automated onboarding so you can focus on real network management.

Why a CLI Tool?

We designed the Oxidized Import Tool as a CLI utility to keep it lean, scriptable, and automation‑friendly. With a CLI you can:

  • Integrate seamlessly into CI/CD pipelines or cron jobs
  • Run on headless servers without GUI overhead
  • Chain commands in scripts for fully automated workflows
  • Customize behavior easily via flags and options

This means faster, repeatable imports that slot right into your existing toolchain—no clicks required!

Why You’ll Love It

  • Speed: Go from hosts file to imported devices in minutes.
  • Consistency: Your Oxidized types map perfectly to rConfig settings every time.
  • Clarity: Dry‑run mode shows you exactly what’s coming—so no surprises.
Play

The Three-Step Workflow

Let’s break down the import flow:

  1. 🔧 Create Device Mappings — Tell rConfig how to translate Oxidized types.
  2. 📂 Load Devices — Turn your Oxidized hosts file into rConfig‑ready JSON.
  3. 🚀 Import Devices — Push that JSON into rConfig and watch the magic happen.

1. 🔧 Create Device Type Mappings

Command: php artisan rconfig:oxidized-device-mappings

Kick off by mapping your Oxidized device types to rConfig’s templates, vendors, and categories.

Options:

  • --list — See all existing mappings
  • --add — Create a brand‑new mapping
  • --edit=TYPE — Tweak an existing mapping
  • --delete=TYPE — Remove a mapping you no longer need
  • --info — Quick help for this command

Example:

Terminal window
# Add mappings interactively
php artisan rconfig:oxidized-device-mappings --add

Why it matters: Accurate mappings ensure devices import with the right prompts, tags, and settings—no manual clean‑up later.

2. 📂 Load Devices from Oxidized

Command: php artisan rconfig:oxidized-load-devices /path/to/hosts.txt

This step reads your Oxidized hosts file and spits out a tidy JSON file for rConfig.

Hosts File Format:

hostname:device_type[:username:password[:enable_password]]

Examples:

router1.local:ios
switch2.local:ios:admin:cisco123
fw1.local:asa:admin:cisco123:enable_pw

What happens under the hood:

  1. ✔️ Validates connectivity
  2. 🔄 Applies your mappings
  3. 📄 Generates rconfig_import.json
  4. 📝 Logs any hiccups for easy troubleshooting

3. 🚀 Import Devices into rConfig

Command: php artisan rconfig:oxidized-import-devices /path/to/rconfig_import.json

Time to bring your devices home:

Options:

  • --group=ID — Assign all imported devices to a default group (default: 1)
  • --dry-run — Preview the import without touching the database
  • --info — Need a refresher? We’ve got you covered.

Import Flow:

  1. 🧐 Validate JSON structure
  2. 🔍 Check for existing devices
  3. ➕ Create new devices with the right templates
  4. 📑 Link tags, vendors, and categories
  5. 📥 Schedule immediate config grabs

Full Workflow at a Glance

  1. Create mappings
    Terminal window
    php artisan rconfig:oxidized-device-mappings --add
  2. Load hosts
    Terminal window
    php artisan rconfig:oxidized-load-devices /path/to/hosts.txt
  3. Import JSON
    Terminal window
    php artisan rconfig:oxidized-import-devices --dry-run /path/to/rconfig_import.json

Feel free to swap --dry-run for a live run when you’re ready.

Pro Tips & Troubleshooting

  • Start with --dry-run to spot errors early.
  • Pre-create credential sets in rConfig to avoid hiccups.
  • Double‑check mappings when a device fails—typos happen!
  • Keep your JSON files for audit trails and rollbacks.
  • Logs are your friend: validation errors point you straight to the problem.

Happy importing! Got feedback or questions? Give us a shout on Slack or open an issue on GitHub.