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 Palo Alto Panos Aruba AOSCX
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
Software Version
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.2.5.tar.gz (2.2 MB view details)

Uploaded Source

Built Distribution

nautobot_device_onboarding-4.2.5-py3-none-any.whl (579.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for nautobot_device_onboarding-4.2.5.tar.gz
Algorithm Hash digest
SHA256 5c1ccd77d99e56be1e939b60951f82ca2b9bb7d34cd58346e5079fceb9f39f3c
MD5 0b7264c24e8c4a6b9ab1cd9ada00a56e
BLAKE2b-256 f63e14cf3db9238fdee405c45498ddf7ebdee28feacf3d2206a09e5d231b2d82

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nautobot_device_onboarding-4.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7897d5eae91de0de15ee44e198469c93345c2bb892fb1c14e512e84097df0523
MD5 51c2562fd01caf10a08e051e5c3fc422
BLAKE2b-256 63350e67ae46ba678eb244c26516967dfe445fa2eddc3e2b54a04f5a585ccdd1

See more details on using hashes here.

Supported by

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