# Nautobot Device Onboarding
<p align="center">
<img src="https://raw.githubusercontent.com/nautobot/nautobot-plugin-device-onboarding/develop/docs/images/icon-DeviceOnboarding.png" class="logo" height="200px">
<br>
<a href="https://github.com/nautobot/nautobot-plugin-device-onboarding/actions"><img src="https://github.com/nautobot/nautobot-plugin-device-onboarding/actions/workflows/ci.yml/badge.svg?branch=develop"></a>
<a href="https://docs.nautobot.com/projects/device-onboarding/"><img src="https://readthedocs.org/projects/nautobot-plugin-device-onboarding/badge/"></a>
<a href="https://pypi.org/project/nautobot-device-onboarding/"><img src="https://img.shields.io/pypi/v/nautobot-device-onboarding"></a>
<a href="https://pypi.org/project/nautobot-device-onboarding/"><img src="https://img.shields.io/pypi/dm/nautobot-device-onboarding"></a>
<br>
A plugin for <a href="https://github.com/nautobot/nautobot">Nautobot</a> to easily onboard new devices.
</p>
## Overview
The `nautobot-device-onboarding` plugin is using the [netmiko](https://github.com/ktbyers/netmiko) and [NAPALM](https://napalm.readthedocs.io/en/latest/) 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 Plugin 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.
### Screenshots
Device Onboarding is a Job that allows you to provide a few required pieces of information and onboard the device.
## Try it out!
This App is installed in the Nautobot Community Sandbox found over at [demo.nautobot.com](https://demo.nautobot.com/)!
> For a full list of all the available always-on sandbox environments, head over to the main page on [networktocode.com](https://www.networktocode.com/nautobot/sandbox-environments/).
## Documentation
Full web-based HTML documentation for this app can be found over on the [Nautobot Docs](https://docs.nautobot.com/) website:
- [User Guide](https://docs.nautobot.com/projects/device-onboarding/en/latest/user/app_overview/) - Overview, Using the App, Getting Started.
- [Administrator Guide](https://docs.nautobot.com/projects/device-onboarding/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the App.
- [Developer Guide](https://docs.nautobot.com/projects/device-onboarding/en/latest/dev/contributing/) - Extending the App, Code Reference, Contribution Guide.
- [Release Notes / Changelog](https://docs.nautobot.com/projects/device-onboarding/en/latest/admin/release_notes/).
- [Frequently Asked Questions](https://docs.nautobot.com/projects/device-onboarding/en/latest/user/faq/).
### Contributing to the Docs
You can find all the Markdown source for the App documentation under the [docs](https://github.com/nautobot/nautobot-plugin-device-onboarding/tree/develop/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](https://www.mkdocs.org/). A container hosting the docs will be started using the invoke commands (details in the [Development Environment Guide](https://docs.nautobot.com/projects/device-onboarding/en/latest/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](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](https://docs.nautobot.com/projects/device-onboarding/en/latest/user/faq/) first. Feel free to also swing by the [Network to Code Slack](https://networktocode.slack.com/) (channel `#nautobot`), sign up [here](http://slack.networktocode.com/) if you don't have an account.
Raw data
{
"_id": null,
"home_page": "https://github.com/nautobot/nautobot-plugin-device-onboarding",
"name": "nautobot-device-onboarding",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "",
"keywords": "nautobot,nautobot-plugin",
"author": "Network to Code, LLC",
"author_email": "info@networktocode.com",
"download_url": "https://files.pythonhosted.org/packages/a7/e0/61960eb743f77f503600ca397c361dc1f4d5431572f255d12ca17206ec95/nautobot_device_onboarding-3.0.1.tar.gz",
"platform": null,
"description": "# Nautobot Device Onboarding\n\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/nautobot/nautobot-plugin-device-onboarding/develop/docs/images/icon-DeviceOnboarding.png\" class=\"logo\" height=\"200px\">\n <br>\n <a href=\"https://github.com/nautobot/nautobot-plugin-device-onboarding/actions\"><img src=\"https://github.com/nautobot/nautobot-plugin-device-onboarding/actions/workflows/ci.yml/badge.svg?branch=develop\"></a>\n <a href=\"https://docs.nautobot.com/projects/device-onboarding/\"><img src=\"https://readthedocs.org/projects/nautobot-plugin-device-onboarding/badge/\"></a>\n <a href=\"https://pypi.org/project/nautobot-device-onboarding/\"><img src=\"https://img.shields.io/pypi/v/nautobot-device-onboarding\"></a>\n <a href=\"https://pypi.org/project/nautobot-device-onboarding/\"><img src=\"https://img.shields.io/pypi/dm/nautobot-device-onboarding\"></a>\n <br>\n A plugin for <a href=\"https://github.com/nautobot/nautobot\">Nautobot</a> to easily onboard new devices.\n</p>\n\n## Overview\n\nThe `nautobot-device-onboarding` plugin is using the [netmiko](https://github.com/ktbyers/netmiko) and [NAPALM](https://napalm.readthedocs.io/en/latest/) 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*.\n\nRegardless, the Onboarding Plugin 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.\n\n### Screenshots\n\nDevice Onboarding is a Job that allows you to provide a few required pieces of information and onboard the device.\n\n\n\n## Try it out!\n\nThis App is installed in the Nautobot Community Sandbox found over at [demo.nautobot.com](https://demo.nautobot.com/)!\n\n> For a full list of all the available always-on sandbox environments, head over to the main page on [networktocode.com](https://www.networktocode.com/nautobot/sandbox-environments/).\n\n## Documentation\n\nFull web-based HTML documentation for this app can be found over on the [Nautobot Docs](https://docs.nautobot.com/) website:\n\n- [User Guide](https://docs.nautobot.com/projects/device-onboarding/en/latest/user/app_overview/) - Overview, Using the App, Getting Started.\n- [Administrator Guide](https://docs.nautobot.com/projects/device-onboarding/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the App.\n- [Developer Guide](https://docs.nautobot.com/projects/device-onboarding/en/latest/dev/contributing/) - Extending the App, Code Reference, Contribution Guide.\n- [Release Notes / Changelog](https://docs.nautobot.com/projects/device-onboarding/en/latest/admin/release_notes/).\n- [Frequently Asked Questions](https://docs.nautobot.com/projects/device-onboarding/en/latest/user/faq/).\n\n### Contributing to the Docs\n\nYou can find all the Markdown source for the App documentation under the [docs](https://github.com/nautobot/nautobot-plugin-device-onboarding/tree/develop/docs) folder in this repository. For simple edits, a Markdown capable editor is sufficient - clone the repository and edit away.\n\nIf you need to view the fully generated documentation site, you can build it with [mkdocs](https://www.mkdocs.org/). A container hosting the docs will be started using the invoke commands (details in the [Development Environment Guide](https://docs.nautobot.com/projects/device-onboarding/en/latest/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](http://localhost:8001). As your changes are saved, the live docs will be automatically reloaded.\n\nAny PRs with fixes or improvements are very welcome!\n\n## Questions\n\nFor any questions or comments, please check the [FAQ](https://docs.nautobot.com/projects/device-onboarding/en/latest/user/faq/) first. Feel free to also swing by the [Network to Code Slack](https://networktocode.slack.com/) (channel `#nautobot`), sign up [here](http://slack.networktocode.com/) if you don't have an account.\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A plugin for Nautobot to easily onboard new devices.",
"version": "3.0.1",
"project_urls": {
"Homepage": "https://github.com/nautobot/nautobot-plugin-device-onboarding",
"Repository": "https://github.com/nautobot/nautobot-plugin-device-onboarding"
},
"split_keywords": [
"nautobot",
"nautobot-plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3a10e5d0efdf73b3fe16628458850f7ad7a650d13f93acaae79ec9dd87bfd16d",
"md5": "463550c05f4b22a08343b7073c9c4538",
"sha256": "f1e8f175c8b3fd402a8a9eb36b6a3bbe383c4a7afd994110074bdf3ae6e2ba74"
},
"downloads": -1,
"filename": "nautobot_device_onboarding-3.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "463550c05f4b22a08343b7073c9c4538",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 37214,
"upload_time": "2023-11-24T19:29:37",
"upload_time_iso_8601": "2023-11-24T19:29:37.746653Z",
"url": "https://files.pythonhosted.org/packages/3a/10/e5d0efdf73b3fe16628458850f7ad7a650d13f93acaae79ec9dd87bfd16d/nautobot_device_onboarding-3.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a7e061960eb743f77f503600ca397c361dc1f4d5431572f255d12ca17206ec95",
"md5": "df9de3bbac4bde09d34c6e7af420ac3c",
"sha256": "f433704d178f6b7eb05edb31d0407e557e2f4b3f3a1fcbad02c951c7948a5dbe"
},
"downloads": -1,
"filename": "nautobot_device_onboarding-3.0.1.tar.gz",
"has_sig": false,
"md5_digest": "df9de3bbac4bde09d34c6e7af420ac3c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 24123,
"upload_time": "2023-11-24T19:29:39",
"upload_time_iso_8601": "2023-11-24T19:29:39.382710Z",
"url": "https://files.pythonhosted.org/packages/a7/e0/61960eb743f77f503600ca397c361dc1f4d5431572f255d12ca17206ec95/nautobot_device_onboarding-3.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-24 19:29:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nautobot",
"github_project": "nautobot-plugin-device-onboarding",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nautobot-device-onboarding"
}
JSON
