nautobot-device-onboarding

v4.1.0

A app for Nautobot to easily onboard new devices. For more information about how to use this package see README

Latest version published 1 month ago

License: Apache-2.0

PyPI

GitHub

Package Health Score

70 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Sustainable

Popularity

Small

GitHub Stars: 44
Forks: 30
Contributors: 40

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package nautobot-device-onboarding, we found that it has been starred 44 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Oct 23, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like nautobot-device-onboarding is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 44
Open PR: 11
Last Release: 1 month ago
Last Commit: 2 months ago

Further analysis of the maintenance status of nautobot-device-onboarding based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that nautobot-device-onboarding demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 40
Funding: No

With more than 10 contributors for the nautobot-device-onboarding repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like nautobot-device-onboarding is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: <3.13,>=3.8

Age: 4 years
Latest Release: 1 month ago
Dependencies: 0 Direct
Versions: 17
Maintainers: 1
Wheels: OS Independent

Readme

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:

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.

FAQs

What is nautobot-device-onboarding?

A app for Nautobot to easily onboard new devices. Visit Snyk Advisor to see a full health score report for nautobot-device-onboarding, including popularity, security, maintenance & community analysis.

Is nautobot-device-onboarding popular?

The python package nautobot-device-onboarding receives a total of 1,176 weekly downloads. As such, nautobot-device-onboarding popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is nautobot-device-onboarding well maintained?

We found that nautobot-device-onboarding demonstrated a healthy version release cadence and project activity. It has a community of 40 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is nautobot-device-onboarding safe to use?

The python package nautobot-device-onboarding was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 22 November-2024, at 15:00 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP