NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-08-17 21:18:16 -06:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

More restructuring

Browse Source
This commit is contained in:
Jeremy Stretch 2024-01-10 10:55:25 -05:00
parent edab0c7a9f
commit f3dc354b8f
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -12,6 +12,10 @@
NetBox exists to empower network engineers. Since its release in 2016, it has become the go-to solution for modeling and documenting network infrastructure for thousands of organizations worldwide. As a successor to legacy IPAM and DCIM applications, NetBox provides a cohesive, extensive, and accessible data model for all things networked. By providing a single robust user interface and programmable APIs for everything from cable maps to device configurations, NetBox serves as the central source of truth for the modern network.
<p align="center">
<img src="docs/media/screenshots/netbox-ui.png" width="600" alt="NetBox user interface screenshot" />
</p>
<p align="center">
<a href="#netboxs-role">NetBox's Role</a> |
<a href="#why-netbox">Why NetBox?</a> |
@ -21,20 +25,16 @@ NetBox exists to empower network engineers. Since its release in 2016, it has be
<a href="#screenshots">Screenshots</a>
</p>
<p align="center">
<img src="docs/media/screenshots/netbox-ui.png" width="600" alt="NetBox user interface screenshot" />
</p>
## NetBox's Role
NetBox functions as the **source of truth** for your network infrastructure. Its job is to define and validate the _intended state_ of all network components and resources. NetBox does not interact with network nodes directly; rather, it makes this data available programmatically to purpose-built automation, monitoring, and assurance tools. This separation of duties enables the construction of a robust yet flexible automation system.
The diagram below illustrates the recommended deployment architecture for an automated network, leveraging NetBox as the central authority for network state. This approach allows for individual tools to be swapped out to meet the user's needs while retaining an easy-to-follow workflow.
<p align="center">
<img src="docs/media/misc/reference_architecture.png" alt="Reference network automation architecture" />
</p>
The diagram above illustrates the recommended deployment architecture for an automated network, leveraging NetBox as the central authority for network state. This approach allows for individual tools to be swapped out to meet the user's changing needs while retaining an easy-to-follow workflow.
## Why NetBox?
### Comprehensive Data Model
@ -73,7 +73,7 @@ Users can define event rules to automatically trigger a custom script or outboun
NetBox automatically logs the creation, modification, and deletion of all managed objects, providing a thorough change history. Changes can be attributed to the executing user, and related changes are grouped automatically by request ID.
> [!INFO]
> [!NOTE]
> A complete list of NetBox's myriad features can be found in [the introductory documentation](https://docs.netbox.dev/en/stable/introduction/).
## Getting Started