Skip to main content

184 docs tagged with "Enterprise"

Documentation specific to NetBox Enterprise deployments and features

View all tags

Branch Events

Branch operations, such as syncing and merging, are tracked as events. This record of events serves as a history for each branch.

Branches

A branch represents a divergent state from the main database.

Branching Plugin

The NetBox branching plugin allows you to create and work with branches in NetBox, similar to version control systems. This enables you to make changes in isolation and merge them back to the main branch when ready.

Built-in Plugins in NetBox Enterprise

NetBox Enterprise ships with a curated set of built-in plugins that extend the platform's core capabilities—offering enhanced features without the complexity of manual setup. These plugins are pre-integrated and supported within the platform, ensuring streamlined deployment and reliable performance.

Built-in Plugins in NetBox Enterprise (v1.9)

NetBox Enterprise ships with a curated set of built-in plugins that extend the platform's core capabilities—offering enhanced features without the complexity of manual setup. These plugins are pre-integrated and supported within the platform, ensuring streamlined deployment and reliable performance.

Change Diffs

A change diff summarized all changes to particular NetBox object within a branch. It serves to simplify the process of reviewing changes within a branch, and avoids the need to review successive individual changes which might otherwise prove tedious.

Change Log

Release notes and changelog for NetBox Change Management

Comments

Comment model for NetBox Change Management reviews

Creating a Branch

First, navigate to Branching > Branches to view the list of any existing branches. Click the "Add" button at top right to create a new branch.

Custom Sessions

Custom sessions can be used to modify the default HTTP behavior. Below are a few examples, most of them from here.

Development

Thanks for your interest in contributing to pynetbox! This introduction covers a few important things to know before you get started.

Device Discovery

The device discovery backend leverages NAPALM to connect to network devices and collect network information.

Diode

Diode is a data ingestion service for NetBox that greatly simplifies and enhances the process of adding and updating data in NetBox, ensuring your network source of truth is always accurate and up to date. Our guiding principle in designing Diode has been to make it as easy as possible to get data into NetBox, removing as much burden as possible from the user while shifting that effort to technology.

Diode SDK Go

Diode SDK Go is a Go library for interacting with the Diode ingestion service utilizing gRPC.

Diode SDK Python

Diode SDK Python is a Python library for interacting with the Diode ingestion service utilizing gRPC.

Getting Started

This guide will help you get started with development on pynetbox. It covers setting up your development environment and running tests.

Git

The Git configuration manager outlines a policy management system where an agent fetches policies from a Git repository.

Installing Custom NetBox Plugins

While NetBox Enterprise comes with a variety of certified and other community plugins built-in, there are cases where you will want to include additional plugins in your NetBox runtime.

Linux Root-Level Changes

This document summarizes the system-level changes made to a Linux host when installing a NetBox Enterprise Embedded Cluster, particularly in relation to directories, files, and runtime configurations affected under /.

Linux Root-Level Changes

This document summarizes the system-level changes made to a Linux host when installing a NetBox Enterprise Embedded Cluster, particularly in relation to directories, files, and runtime configurations affected under /.

Local

Local config manager retrieves policies from the local configuration file passed to the agent.

Migrating to NetBox Enterprise

Migrating from NetBox open source to NetBox Labs Enterprise is a simple and efficient process. Because NetBox Enterprise is built on the same open source platform, database imports can be completed quickly, enabling a smooth transition.

Migrating to NetBox Enterprise

Migrating from NetBox open source to NetBox Labs Enterprise is a simple and efficient process. Because NetBox Enterprise is built on the same open source platform, database imports can be completed quickly, enabling a smooth transition.

NetBox Assurance: Getting Started with NetBox Assurance

This guide will help you set up, configure, and start using NetBox Assurance to maintain accurate network documentation and proactive drift detection. Follow these steps to go from installation to your first operational workflow.

NetBox Assurance: NetBox Assurance

NetBox Assurance automatically detects operational drift between your intended network design (documented in NetBox) and your actual network infrastructure. It continuously monitors network and infrastructure, comparing your intended design against real-world infrastructure to uncover discrepancies and provide proactive remediation capabilities.

NetBox Assurance: Using the NetBox Assurance UI

The NetBox Assurance plugin provides a comprehensive web interface within NetBox for monitoring network drift, viewing deviation reports, and managing remediation workflows. This guide covers the interface features, navigation, and operational workflows for day-to-day use of NetBox Assurance.

NetBox Branching

NetBox is the world's leading source of truth for network infrastructure, featuring an extensive and complex data model. But sometimes it can be challenging to orchestrate changes, especially when working within a large team. This plugin introduces a new paradigm for NetBox to help overcome these challenges: branching.

NetBox Custom Objects

NetBox is the world's leading source of truth for infrastructure, featuring an extensive data model. Sometimes it can be useful to extend the NetBox data model to fit specific organizational needs. The Custom Objects plugin introduces a new paradigm for NetBox to help overcome these challenges, allowing NetBox adminstrators to extend the NetBox data model without writing a line of code.

NetBox Custom Objects

NetBox is the world's leading source of truth for infrastructure, featuring an extensive data model. Sometimes it can be useful to extend the NetBox data model to fit specific organizational needs. The Custom Objects plugin introduces a new paradigm for NetBox to help overcome these challenges, allowing NetBox adminstrators to extend the NetBox data model without writing a line of code.

NetBox Custom Objects

NetBox is the world's leading source of truth for infrastructure, featuring an extensive data model. Sometimes it can be useful to extend the NetBox data model to fit specific organizational needs. The Custom Objects plugin introduces a new paradigm for NetBox to help overcome these challenges, allowing NetBox adminstrators to extend the NetBox data model without writing a line of code.

NetBox Custom Objects

NetBox is the world's leading source of truth for infrastructure, featuring an extensive data model. Sometimes it can be useful to extend the NetBox data model to fit specific organizational needs. The Custom Objects plugin introduces a new paradigm for NetBox to help overcome these challenges, allowing NetBox adminstrators to extend the NetBox data model without writing a line of code.

NetBox Discovery: NetBox Discovery

NetBox Discovery is an advanced network discovery and observability solution designed to simplify documenting your network and help detect network drift. It extends NetBox by providing automated network and device discovery capabilities through the orb-agent, a lightweight and scalable discovery component.

NetBox Enterprise Backups

Much like the NetBox software itself, NetBox Enterprise uses 2 main datastores: PostgreSQL, and Redis.

NetBox Enterprise: Built-in Plugins in NetBox Enterprise

NetBox Enterprise ships with a curated set of built-in plugins that extend the platform's core capabilities—offering enhanced features without the complexity of manual setup. These plugins are pre-integrated and supported within the platform, ensuring streamlined deployment and reliable performance.

NetBox Enterprise: Linux Root-Level Changes

This document summarizes the system-level changes made to a Linux host when installing a NetBox Enterprise Embedded Cluster, particularly in relation to directories, files, and runtime configurations affected under /.

NetBox Enterprise: Migrating to NetBox Enterprise

Migrating from NetBox open source to NetBox Labs Enterprise is a simple and efficient process. Because NetBox Enterprise is built on the same open source platform, database imports can be completed quickly, enabling a smooth transition.

Network Discovery

The network discovery backend leverages NMAP to scan networks and discover IP information.

Object Changes

This model serves as a proxy for NetBox's native ObjectChange model.

OpenTelemetry Infinity

The opentelemetry_infinity backend embeds the OpenTelemetry Infinity process inside Orb Agent to run manageable and policy-driven otel-collector-contrib instances. Each Orb policy will spin up a new otelcol-contrib process running the configuration provided by the policy.

Orb Agent - the NetBox Discovery agent

Orb agent is a component of the NetBox Discovery solution. It provides network discovery and observability capabilities and is developed by NetBox Labs.

Pktvisor

The pktvisor backend embeds the pktvisord process inside Orb Agent to run deep packet analytics, active probes, and streaming aggregations directly at the edge. Pktvisor policies let you decide which network taps to activate, which analyzers to run, and how the resulting metrics are exported to your observability stack.

Policies

Change management policies for NetBox Change Management

Policy Rules

Policy rules for NetBox Change Management policies

Release Checklist

This document outlines the steps required to prepare and publish a new release of pynetbox.

Release Notes

ServiceNow NetBox CMDB Integration documentation - Version v1.3.3

Release Notes

ServiceNow NetBox CMDB Integration documentation - Version v1.3.4

Reverting a Branch

Once a branch has been merged, it is generally no longer needed, and can no longer be activated. However, occasionally you may find it necessary to undo the changes from a branch (due to an error or an otherwise undesired state). This can be done by reverting the branch. Only merged branches can be reverted.

Reviews

Review model for NetBox Change Management workflow

SNMP Discovery

The SNMP discovery backend leverages SNMP (Simple Network Management Protocol) to connect to network devices and collect network information.

snow faq

ServiceNow NetBox CMDB Integration documentation

Snow Faq

ServiceNow NetBox CMDB Integration documentation - Version v1.2.6

Snow Faq

ServiceNow NetBox CMDB Integration documentation - Version v1.3.3

Snow Faq

ServiceNow NetBox CMDB Integration documentation - Version v1.3.4

Snow Upgrading

ServiceNow NetBox CMDB Integration documentation - Version v1.2.6

Snow Upgrading

ServiceNow NetBox CMDB Integration documentation - Version v1.3.3

Snow Upgrading

ServiceNow NetBox CMDB Integration documentation - Version v1.3.4

Snow User Guide

ServiceNow NetBox CMDB Integration documentation - Version v1.2.6

Snow User Guide

ServiceNow NetBox CMDB Integration documentation - Version v1.3.3

Snow User Guide

ServiceNow NetBox CMDB Integration documentation - Version v1.3.4

Technical Information

This document provides a comprehensive mapping of Cisco Meraki object types to their corresponding NetBox object types, based on the integration implementation.

Using NetBox Custom Objects with NetBox Branching

As of version 0.4.0 Custom Objects is compatible with NetBox Branching, but not fully supported. This means that users can safely use both plugins together, but there are some caveats to be aware of. See below to learn how each of the Custom Objects models interacts with NetBox Branching.

Using NetBox Custom Objects with NetBox Branching

As of version 0.4.0 Custom Objects is compatible with NetBox Branching, but not fully supported. This means that users can safely use both plugins together, but there are some caveats to be aware of. See below to learn how each of the Custom Objects models interacts with NetBox Branching.

Using the REST API

This plugin includes support for activating and deactivating branches via the REST API in addition to conventional creation, modification, and deletion operations.

v1.9: Installing Custom NetBox Plugins (v1.9)

While NetBox Enterprise comes with a variety of certified and other community plugins built-in, there are cases where you will want to include additional plugins in your NetBox runtime.

Vault Secrets Manager

The Orb Agent can integrate with HashiCorp Vault to securely manage sensitive information such as passwords and API keys. This feature allows you to reference secrets stored in Vault directly in your policy configurations without hardcoding sensitive values.

Worker

The worker backend allows to run custom implementation as part of Orb Agent.