Device Sync Overview

Device Sync Overview: Automated Network Device Inventory Management in rConfig V8

Device Sync enables automated synchronization of network device inventory from upstream monitoring and management platforms into rConfig V8. Instead of manually entering device information, Device Sync extracts device data from systems like Zabbix, Nautobot, and NetBox, transforms it to rConfig format, and imports it into a staging area for review before production deployment.

This integration eliminates duplicate data entry, ensures inventory consistency across platforms, and reduces the time required to onboard large numbers of devices into rConfig.

Supported Platforms

rConfig V8 has been tested and verified with the following upstream platforms:

Platform	rConfig V8 Support	Platform Version Tested	Documentation
Zabbix	✓ Verified	6.4.10+	Zabbix Sync Setup
Nautobot	✓ Verified	2.0+	Nautobot Sync Setup
NetBox	✓ Verified	3.5+	NetBox Sync Setup

Note

Additional platforms can be integrated upon request. Contact rConfig support to discuss your specific monitoring or management system requirements.

How Device Sync Works

Device Sync follows a standard ETL (Extract, Transform, Load) pattern with a review stage:

1. Extract: Connect to upstream platform API and retrieve device inventory data in raw format
2. Transform: Parse and map upstream device attributes to rConfig format using tags and field mappings
3. Load to staging: Import transformed devices into rConfig staging table for administrator review
4. Review and approve: Administrator validates staged devices and resolves any mapping issues
5. Import to production: Approved devices are moved from staging to active rConfig device inventory
6. Schedule synchronization: Automated sync jobs keep inventory current with upstream platform changes

This idempotent process prevents duplicate device creation and maintains data integrity across synchronizations.

Key Benefits

Eliminate manual entry: Automatically import hundreds or thousands of devices without manual data entry.

Single source of truth: Maintain device inventory in your monitoring platform and sync to rConfig automatically.

Consistent metadata: Device attributes, tags, categories, and credentials stay synchronized across platforms.

Staged review process: Review and validate devices before they enter production inventory.

Scheduled synchronization: Keep device inventory current with automated sync jobs at regular intervals.

Error handling: Comprehensive logging identifies mapping issues and failed imports for easy troubleshooting.

Idempotent operations: Re-running sync jobs updates existing devices rather than creating duplicates.

ETL Process Explained

Extract Phase

Connection: rConfig connects to upstream platform API using authentication credentials

Filtering: Apply platform-specific filters to extract only relevant devices (e.g., by host group, site, or device role)

Raw retrieval: Device data is retrieved in the upstream platform’s native format

Validation: Verify API response structure and data completeness

Transform Phase

Tag parsing: Read rConfig-specific tags from upstream platform device metadata

Field mapping: Map upstream device attributes to rConfig fields:

• Hostname → Device name
• IP address → Management IP
• Platform tags → Device template, vendor, model
• Custom tags → Categories, tags, credential sets

Credential assignment: Associate devices with rConfig credential sets based on tag mappings

Template selection: Assign appropriate device templates based on vendor and platform type

Load to Staging Phase

Staging import: Transformed devices are imported into device_sync_staging table

Duplicate detection: Check for existing devices by hostname or IP address

Validation: Verify all required fields are present and valid

Error logging: Record any devices that fail validation with detailed error messages

Review and Approve Phase

Administrator review: View staged devices in rConfig UI or via CLI commands

Conflict resolution: Resolve duplicate hostnames, missing credentials, or invalid templates

Selective approval: Choose which staged devices to import into production

Bulk operations: Approve all, reject all, or selectively import devices

Production Import Phase

Device creation: Approved devices are created in main rConfig device inventory

Relationship linking: Associate devices with groups, tags, categories, and credentials

Initial backup: Schedule immediate configuration retrieval for newly imported devices

Staging cleanup: Clear staging table after successful import

Required Tag Mappings

Upstream platforms must tag devices with rConfig-specific metadata for successful import:

Tag Name	Purpose	Value Format	Required
rconfig::template	Device template	Template ID or name	Yes
rconfig::credentialset	Authentication credentials	Credential set ID or name	Yes
rconfig::vendor	Device manufacturer	Vendor ID or name	Yes
rconfig::category	Device category	Category ID or name	Yes
rconfig::tag	Device tags	Comma-separated IDs or names	No
rconfig::model	Device model	Model string	No
rconfig::prompt	Command prompt regex	Prompt pattern	No
rconfig::enable_prompt	Enable prompt regex	Enable prompt pattern	No

Example upstream platform tagging:

Device: core-router-01.example.com
Tags:
  - rconfig::template=Cisco IOS
  - rconfig::credentialset=Production Routers
  - rconfig::vendor=Cisco
  - rconfig::category=Core Network
  - rconfig::tag=Router,Production,Core
  - rconfig::model=Catalyst 9500

Caution

All required tags must be present on upstream devices for successful import. Missing required tags will cause devices to fail validation during the transform phase.

Configuration Workflow

Initial Setup

1. Configure upstream platform: Set up API access and authentication credentials
2. Tag devices: Apply rConfig-specific tags to devices in upstream platform
3. Configure rConfig connection: Add upstream platform connection details in rConfig
4. Test connection: Verify API connectivity and authentication
5. Configure field mappings: Define how upstream fields map to rConfig attributes
6. Set up filters: Specify which devices to include in sync operations

First Synchronization

1. Run initial sync: Execute manual sync to extract, transform, and load devices
2. Review staged devices: Check staging table for validation errors or conflicts
3. Resolve issues: Fix missing tags, invalid templates, or credential problems
4. Approve devices: Import staged devices into production inventory
5. Verify import: Confirm devices appear correctly in rConfig device list
6. Test connectivity: Validate device connections and configuration retrieval

Ongoing Operations

1. Schedule automated sync: Set up cron job or scheduled task for regular synchronization
2. Monitor sync logs: Review sync job results and error logs periodically
3. Update mappings: Adjust tag mappings as device inventory evolves
4. Maintain upstream tags: Keep rConfig-specific tags current in upstream platform

CLI vs. UI Operations

Device Sync can be managed through both command-line and web interface:

Command-Line Interface (CLI)

Best for:

• Automated scripting and cron jobs
• Detailed troubleshooting with verbose output
• Integration with CI/CD pipelines
• Batch operations on large device inventories

Web Interface (UI)

Best for:

• Visual review of staged devices
• Selective device approval
• Quick status checks
• Conflict resolution with context

Access: Navigate to Integrations > Device Sync > Select platform

Synchronization Best Practices

Start with test group: Begin with a small subset of devices to validate mappings before full-scale sync.

Maintain consistent tagging: Establish tagging standards in upstream platform and enforce them across device inventory.

Use credential sets: Create reusable credential sets in rConfig before syncing to streamline device authentication.

Schedule during maintenance windows: Run initial large-scale syncs during low-activity periods to avoid performance impact.

Review before production: Always review staged devices before importing to catch validation errors early.

Monitor sync logs: Regularly check sync job logs for errors, warnings, or devices that failed validation.

Keep mappings current: Update field mappings when adding new device types or changing upstream platform structure.

Document custom configurations: Maintain documentation for platform-specific filters and custom tag mappings.

Troubleshooting Common Issues

API connection failures

Check network connectivity: Verify rConfig server can reach upstream platform API endpoint

Validate credentials: Confirm API token or username/password are correct and not expired

Review firewall rules: Ensure firewalls allow traffic between rConfig and upstream platform

Check API permissions: Verify API user has sufficient permissions to read device inventory

Missing required tags

Review upstream tagging: Check that all required rConfig tags are applied to devices

Verify tag format: Ensure tag values match expected format (ID vs. name, comma separation)

Check case sensitivity: Some platforms are case-sensitive for tag names

Update tag mappings: Modify field mappings if upstream platform uses different tag structure

Duplicate device conflicts

Identify duplicates: Review staging table for devices with matching hostnames or IPs

Update existing devices: Use update mode instead of create mode for known devices

Resolve manually: Decide which device record to keep and remove duplicates from staging

Adjust filters: Refine upstream platform filters to exclude unwanted duplicates

Template or credential errors

Verify existence: Confirm template and credential set names/IDs exist in rConfig

Check permissions: Ensure sync user has access to referenced templates and credentials

Create missing resources: Add templates or credential sets before re-running sync

Use default values: Configure fallback template or credential set for devices with missing tags

Related Documentation

• Zabbix Sync Setup - Configure Zabbix integration
• Nautobot Sync Setup - Configure Nautobot integration
• NetBox Sync Setup - Configure NetBox integration
• Device Management - Understanding device configuration in rConfig
• Device Templates - Configuring device templates
• Connection Profiles - Setting up connection credentials