Nautobot Device Onboarding

An App for Nautobot.

Overview

The nautobot-device-onboarding plugin is using the netmiko and NAPALM libraries to simplify the onboarding process of a new device into Nautobot down to, in many cases, an IP Address and a Location. In some cases, the user may also have to specify a specific Device Platform and Device Port.

Regardless, the Onboarding App greatly simplifies the onboarding process by allowing the user to specify a small amount of info and having the app populate a much larger amount of device data in Nautobot.

Support Matrix (Sync Devices From Network)

Data Attribute	Cisco IOS	Cisco XE	Cisco NXOS	Cisco XR	Cisco WLC	Juniper Junos	Arista EOS	F5	HP Comware	Palo Alto Panos	Aruba AOSCX	Aruba OS	Brocade/Ruckus Fastiron	HP Procurve
Hostname	✅	✅	✅	🧪	✅	✅	✅	🧪	🧪	🧪	🧪	🧪	🧪	🧪
Platform	✅	✅	✅	🧪	✅	✅	✅	🧪	🧪	🧪	🧪	🧪	🧪	🧪
Manufacturer	✅	✅	✅	🧪	✅	✅	✅	🧪	🧪	🧪	🧪	🧪	🧪	🧪
Serial Number	✅	✅	✅	🧪	✅	✅	✅	🧪	🧪	🧪	🧪	🧪	🧪	🧪
Device Type	✅	✅	✅	🧪	✅	✅	✅	🧪	🧪	🧪	🧪	🧪	🧪	🧪
Mgmt Interface	✅	✅	✅	🧪	✅	✅	✅	🧪	🧪	🧪	🧪	🧪	🧪	🧪
Mgmt IP Address	✅	✅	✅	🧪	✅	✅	✅	🧪	🧪	🧪	🧪	🧪	🧪	🧪
Virtual Chassis (Stacks)	✅	✅	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌

Support Matrix (Sync Data From Network)

Interfaces	Cisco IOS	Cisco XE	Cisco NXOS	Cisco XR	Cisco WLC	Juniper Junos	Arista EOS	F5	Palo Alto Panos	Aruba AOSCX	Aruba OS	Brocade/Ruckus Fastiron	HP Procurve
Name	✅	✅	✅	🧪	❌	✅	✅	🧪	❌	🧪	🧪	🧪	🧪
IP Address	✅	✅	✅	🧪	❌	✅	✅	🧪	❌	🧪	🧪	🧪	🧪
Type	✅	✅	✅	🧪	❌	✅	✅	🧪	❌	🧪	🧪	🧪	🧪
MTU	✅	✅	✅	🧪	❌	✅	✅	🧪	❌	🧪	🧪	🧪	🧪
Description	✅	✅	✅	🧪	❌	✅	✅	🧪	❌	🧪	🧪	🧪	🧪
Mac Address	✅	✅	✅	🧪	❌	✅	✅	🧪	❌	🧪	🧪	🧪	🧪
Link Status	✅	✅	✅	🧪	❌	✅	✅	🧪	❌	🧪	🧪	🧪	🧪
802.1Q mode	✅	✅	✅	🧪	❌	✅	✅	🧪	❌	🧪	🧪	🧪	🧪
Lag Member	✅	✅	✅	🧪	❌	✅	✅	🧪	❌	🧪	🧪	🧪	🧪
Vrf Membership	✅	✅	✅	🧪	❌	✅	✅	🧪	❌	🧪	🧪	🧪	🧪
Software Version	✅	✅	✅	🧪	❌	✅	✅	🧪	❌	🧪	🧪	🧪	🧪

VLANS	Cisco IOS	Cisco XE	Cisco XR	Cisco NXOS	Cisco WLC	Juniper Junos	Arista EOS	F5	Palo Alto Panos	Aruba AOSCX	Aruba OS	Brocade/Ruckus Fastiron	HP Procurve
Untagged VLANs	✅	✅	❌	✅	❌	✅	✅	🧪	❌	🧪	🧪	🧪	🧪
Tagged VLANs	✅	✅	❌	✅	❌	✅	✅	🧪	❌	🧪	🧪	🧪	🧪

Cabling	Cisco IOS	Cisco XE	Cisco XR	Cisco NXOS	Cisco WLC	Juniper Junos	Arista EOS	F5	Palo Alto Panos	Aruba AOSCX	Aruba OS	Brocade/Ruckus Fastiron	HP Procurve
Terminations A	🧪	🧪	❌	🧪	❌	🧪	❌	🧪	❌	🧪	🧪	🧪	🧪
Terminations B	🧪	🧪	❌	🧪	❌	🧪	❌	🧪	❌	🧪	🧪	🧪	🧪

Legend
✅ - Supported and stable.
❌ - No current support.
🧪 - Supported, but has limited testing.

Screenshots

Device Onboarding is a Job that allows you to provide a few required pieces of information and onboard the device.

As Job data and Job execution will be same for both Manual Input and CSV Input.

Manual Input:

CSV Input:

Try it out!

This App is installed in the Nautobot Community Sandbox found over at demo.nautobot.com!

For a full list of all the available always-on sandbox environments, head over to the main page on networktocode.com.

Documentation

Full web-based HTML documentation for this app can be found over on the Nautobot Docs website:

• User Guide - Overview, Using the App, Getting Started.
• Administrator Guide - How to Install, Configure, Upgrade, or Uninstall the App.
• Developer Guide - Extending the App, Code Reference, Contribution Guide.
• Release Notes / Changelog.
• Frequently Asked Questions.

Contributing to the Docs

You can find all the Markdown source for the App documentation under the docs folder in this repository. For simple edits, a Markdown capable editor is sufficient: clone the repository and edit away.

If you need to view the fully generated documentation site, you can build it with mkdocs. A container hosting the docs will be started using the invoke commands (details in the Development Environment Guide) on http://localhost:8001. As your changes are saved, the live docs will be automatically reloaded.

Any PRs with fixes or improvements are very welcome!

Questions

For any questions or comments, please check the FAQ first. Feel free to also swing by the Network to Code Slack (channel #nautobot), sign up here if you don't have an account.