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:

job input

CSV Input:

job 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:

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.

Project links

Data verified by PyPI on Aug 17, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (5.5.1)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for networktocode from gravatar.com networktocode

Credits

Author: Network to Code, LLC

GitHub Statistics

Data verified by PyPI on Aug 17, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

Apache Software License (Apache-2.0)

Requires

Python <3.15, >=3.10

Provides Extra

all

Tags

nautobot nautobot-app nautobot-plugin

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nautobot_device_onboarding-5.5.0.tar.gz (4.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nautobot_device_onboarding-5.5.0-py3-none-any.whl (4.3 MB view details)

Uploaded Python 3

File details

Details for the file nautobot_device_onboarding-5.5.0.tar.gz.

File metadata

File hashes

Hashes for nautobot_device_onboarding-5.5.0.tar.gz
Algorithm Hash digest
SHA256 cf3033a5dfb3ff73e291feb8cd1fdac32eb026d2bab83d4f09883518ed5a56dd
MD5 9a8fcfba776f52bc8f8a406d6cce5f53
BLAKE2b-256 57d497b6a532636155b19332a0c3c3d4b5399f202b6ef77ed1a26a79b4d9f0b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for nautobot_device_onboarding-5.5.0.tar.gz:

Publisher: release.yml on nautobot/nautobot-app-device-onboarding

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nautobot_device_onboarding-5.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for nautobot_device_onboarding-5.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 72371b276b611789054ebed3d33269df06b65cb8a694e6ae2fc29bec717b2572
MD5 58f51f84655f62af879d21c93e556da8
BLAKE2b-256 66b94761ea5fb4e35a2af241cec7c770bc1cf9da95a2bdcbe3f16286d2ade859

See more details on using hashes here.

Provenance

The following attestation bundles were made for nautobot_device_onboarding-5.5.0-py3-none-any.whl:

Publisher: release.yml on nautobot/nautobot-app-device-onboarding

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

5.5.1

2 files

This release

5.5.0 This release

2 files

5.4.1

2 files

5.4.0

2 files

5.3.0

2 files

5.2.2

2 files

5.2.1

2 files

5.2.0

2 files

5.1.0

2 files

5.0.0

2 files

Pre-release

5.0.0a1

2 files

4.4.6

2 files

4.4.5

2 files

4.4.4

2 files

4.4.3

2 files

4.4.2

2 files

4.4.1

2 files

4.4.0

2 files

4.3.2

2 files

4.3.1

2 files

Yanked

4.3.0

2 files

Yanked reason: contains critical bug

4.2.6

2 files

4.2.5

2 files

4.2.4

2 files

4.2.3

2 files

4.2.2

2 files

4.2.1

2 files

4.2.0

2 files

4.1.0

2 files

4.0.1

2 files

4.0.0

2 files

Pre-release

4.0.0rc3

2 files

Pre-release

4.0.0rc2

2 files

Pre-release

4.0.0rc1

2 files

Pre-release

4.0.0b1

2 files

3.0.1

2 files

3.0.0

2 files

2.0.3

2 files

1.2.0

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.1

2 files

1.0.0

2 files

0.0.0

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page