Nautobot SSoT integration for Ubiquiti Unifi.
Project description
Nautobot Ssot Unifi SSoT
An app for Nautobot.
The term SSoT, or Single Source of Truth, refers to the intention of using Nautobot to consolidate data from disparate Systems of Record to create a single resource for all automation needs. This is done by extending the Nautobot SSoT framework which uses the DiffSync library. This plug-in is built with the capability in mind to import and export data from your desired System of Record.
Overview
Developer Note: Add a long (2-3 paragraphs) description of what the App does, what problems it solves, what functionality it adds to Nautobot, what external systems it works with etc.
Screenshots
Developer Note: Add any representative screenshots of the App in action. These images should also be added to the
docs/user/app_use_cases.md
section.
Developer Note: Place the files in the
docs/images/
folder and link them using only full URLs from GitHub, for example:![Overview](https://raw.githubusercontent.com/abates/nautobot-app-ssot-unifi/develop/docs/images/app-overview.png)
. This absolute static linking is required to ensure the README renders properly in GitHub, the docs site, and any other external sites like PyPI.
More screenshots can be found in the Using the App page in the documentation. Here's a quick overview of some of the app's added functionality:
Try it out!
Developer Note: Only keep this section if appropriate. Update link to correct sandbox.
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 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 Documentation
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 documentation can be started using the invoke
commands (details in the Development Environment Guide) on http://localhost:8001. Using this container, as your changes to the documentation are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file nautobot_ssot_unifi-1.0.2.tar.gz
.
File metadata
- Download URL: nautobot_ssot_unifi-1.0.2.tar.gz
- Upload date:
- Size: 18.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f23c38f298d78448d2517c45339852a8c833529fbe5bdb7b44a1ca413b6664b3 |
|
MD5 | a8e3031f3f69dff8d8a6b0a9f19ec169 |
|
BLAKE2b-256 | b17756d06da2f425332be821725ac3fca136be5345cb8e24dfe4ff12f7d9716b |
File details
Details for the file nautobot_ssot_unifi-1.0.2-py3-none-any.whl
.
File metadata
- Download URL: nautobot_ssot_unifi-1.0.2-py3-none-any.whl
- Upload date:
- Size: 19.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 172588f3cf948af64856ebb2b0c9ce5404ae25ea8adcf393a296b23af6f13f69 |
|
MD5 | 5ab38bc9ba48a3b0412c7bd46dec375a |
|
BLAKE2b-256 | b95a8c0014f6168b3fa174a7930396777e7d1ef99fde097d2296a0f7ff9ff5c8 |