rConfig - Device Import Workbook

5 mins V7 Pro V6 Core

rConfig Workbook: Designing and Setting Up Devices for Maximum Productivity

Introduction

This workbook is designed to help rConfig users efficiently design and set up multiple models and devices. It outlines the dependencies and best practices necessary for a smooth onboarding process. By following the steps and using the provided tables, users can get up and running quickly while ensuring their configuration remains robust and scalable.

Section 1: Prerequisites for Device Setup

Before adding devices to rConfig, you need to prepare the following components. When importing or migrating large datasets of devices from legacy tools, it’s a useful exercise to update naming standards, tagging, and other critical data such as templates to ensure consistency and alignment with your current operational needs.

Vendors: Devices are linked to a vendor by its unique ID.
- Use: Helps identify the manufacturer for filtering and organization. Used indirectly by devices when downloading or backing up configurations.
Templates: Devices use templates for connectivity, linked by their unique IDs.
- Use: Defines the connection protocols and methods required for device access. Used indirectly by devices when establishing connections.
Commands: Commands to be executed on devices are organized in command groups.
- Use: Executes specific tasks or retrieves information from devices. Used indirectly by devices when downloading or backing up configurations.
Command Groups: Devices are linked to command groups by their IDs.
- Use: Groups related commands for streamlined device management. Used directly by devices to determine command execution workflows.
Tags: Devices can have multiple tags for categorization, linked by their IDs.
- Use: Simplifies searching, filtering, and organizing devices. Used directly by devices for easier identification and categorization for backup tasks, compliance reporting, etc.
Device Credentials: Each device needs associated credentials, linked by their unique IDs.
- Use: Provides secure access and authentication for devices. Used directly by devices for login and command execution.
Model Naming: Models should be consistent across devices to ensure accuracy and reuse.
- Use: Ensures uniformity and simplifies tracking across devices. Used indirectly for documentation and tracking purposes.

Section 2: Device Dependencies and Relationships

To ensure devices are properly set up, it is essential to understand their relationships to other tables:

2.1 Vendors

Purpose: Identify the manufacturer of a device.
Example:

ID	Vendor Name
1	Cisco
2	Juniper

2.2 Templates

Purpose: Define connection protocols and methods.
Additional Information: It is ideal to have prepared template code/YAML files ready to upload to the server that have already been tested with device types. This should include a filename column.
Example:

ID	Template Name	Connection Type
1	Cisco SSH	SSH
2	Juniper SSH	SSH

2.3 Commands

Purpose: Specify the commands executed on devices.
Additional Information: Must have a command groups column as an array for CG IDs.
Example:

ID	Command	Description
1	show version	Displays software version
2	show interfaces	Lists device interfaces

2.4 Command Groups

Purpose: Group related commands for execution.
Example:

ID	Group Name	Description
1	Core Switches	Commands for core devices
2	Access Switches	Commands for access layer

2.5 Tags

Purpose: Categorize devices for easier filtering.
Example:

ID	Tag Name	Description
1	Core	Core infrastructure
2	Access	Access layer devices

2.6 Device Credentials

Purpose: Provide secure access to devices.
Example:

ID	Credential Name	Username	Password	Enable Password	Description
1	Core Creds	admin	**	**	Core devices login
2	Access Creds	user	**	**	Access devices login

Example:

ID	Credential Name	Username	Description
1	Core Creds	admin	Core devices login
2	Access Creds	user	Access devices login

Section 3: Adding Devices

Introduction

There are multiple methods to import devices, including the following. In the V7 UI, under Settings > Import/Export, there is a useful template that can be downloaded to populate for the final import. Devices’ final import table should be designed per the table below.

Methods for Adding Devices:

Manual Addition:
- Navigate to the devices page and click the “Add Device” button.
Clone Existing Device:
- Use the “Clone” button to duplicate an existing device.
REST API:
- Add devices programmatically. Refer to the API documentation.
CSV Import:
- Bulk import devices using a CSV file.
Third-Party Integration:
- Leverage integrations to add devices automatically.

Device Table Example:

ID	Device Name	IP Address	Vendor ID	Template ID	Tag IDs	Command Group ID	Credential ID	Port Override	Default Creds On	Username	Password	Enable Password	Main Prompt	Enable Prompt	Device Model
1	CoreSwitch01	192.168.1.1	1	1	1,2	1	1	22	1	admin	**	**	>	#	CS1000
2	AccessSwitch1	192.168.2.1	2	2	2	2	2	22	0	user	**	**	>	#	AS2000

Section 4: Post-Addition Actions

After adding a device:

A download job starts immediately. Use the Queue Manager and Activity Logs to monitor progress.
Available actions via the dropdown menu on the devices page:
- View Device
- Edit Device
- Clone Device
- Disable Device
- Delete Device

Section 5: Best Practices for Device Setup

Consistency: Maintain consistent naming conventions for models.
Dependencies First: Ensure all dependencies (e.g., vendors, templates, tags) are set up before adding devices.
Review Logs: Regularly monitor the activity logs for errors or anomalies.
Use Tags: Utilize tags for efficient categorization and filtering.
Test Connections: Validate connectivity for each template and credential before adding devices.

Conclusion

Setting up devices in rConfig involves careful planning and preparation of dependencies. By designing your vendors, templates, commands, and other components upfront, you can ensure a productive and error-free setup process. Use this workbook to guide your rConfig implementation and optimize your network configuration management workflows.