Skip to main content

A app for Nautobot to easily onboard new devices.

Project description

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 WLC Juniper Junos Arista EOS F5 HP Comware
Hostname 🧪
Platform 🧪
Manufacturer 🧪
Serial Number 🧪
Device Type 🧪
Mgmt Interface 🧪
Mgmt IP Address 🧪

Support Matrix (Sync Data From Network)

Interfaces Cisco IOS Cisco XE Cisco NXOS Cisco WLC Juniper Junos Arista EOS F5
Name
IP Address
Type
MTU
Description
Mac Address
Link Status
802.1Q mode
Lag Member
Vrf Membership
VLANS Cisco IOS Cisco XE Cisco NXOS Cisco WLC Juniper Junos Arista EOS F5
Untagged VLANs
Tagged VLANs
Cabling Cisco IOS Cisco XE Cisco NXOS Cisco WLC Juniper Junos Arista EOS F5
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.

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 details


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-4.1.0.tar.gz (2.2 MB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for nautobot_device_onboarding-4.1.0.tar.gz
Algorithm Hash digest
SHA256 87b019e7f9b67d4e95a94d4b2a51f1a2212e6023353e21f9734ac5e6269233ac
MD5 469001af0665e9eb30a0c4812b62d218
BLAKE2b-256 fb83e18a30d471751ed4f4f57a9b9fabd67d8b03bfd59b056da06916819632a0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nautobot_device_onboarding-4.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 128a899d2e38b4e25895b3a54fbedb56ad1d4cb15f1f5a86d6683d2257664455
MD5 795f37c201c15c04649fd9cc3f9f56c5
BLAKE2b-256 bbf2448d18984b1e79af4989fd9a68cdbb799d4ef856a3ee6c2f77ef8d0aecdc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page