inventory-monitor
A comprehensive NetBox plugin for asset management with semi-automatic discovery processes. This plugin extends NetBox with powerful inventory tracking capabilities, including asset lifecycle management, probe monitoring, contract tracking, and RMA (Return Merchandise Authorization) processing.
classDiagram
class AssetType {
+CharField name
+SlugField slug
+CharField description
+ColorField color
}
class Asset {
+CharField serial
+CharField partnumber
+CharField assignment_status
+CharField lifecycle_status
+GenericForeignKey assigned_object
+ForeignKey type
+ForeignKey order_contract
+CharField project
+CharField vendor
+DecimalField price
+DateField warranty_start
+DateField warranty_end
+is_recently_probed()
}
class AssetService {
+DateField service_start
+DateField service_end
+DecimalField service_price
+CharField service_category
+CharField service_category_vendor
+ForeignKey asset
+ForeignKey contract
}
class Contract {
+CharField name
+CharField name_internal
+ForeignKey contractor
+CharField type
+DecimalField price
+DateField signed
+DateField invoicing_start
+DateField invoicing_end
+ForeignKey parent
}
class Contractor {
+CharField name
+CharField company
+CharField address
+ForeignKey tenant
}
class Invoice {
+CharField name
+CharField project
+ForeignKey contract
+DecimalField price
+DateField invoicing_start
+DateField invoicing_end
}
class Probe {
+DateTimeField time
+CharField device_descriptor
+CharField site_descriptor
+CharField location_descriptor
+CharField serial
+ForeignKey device
+ForeignKey site
+ForeignKey location
+JSONField discovered_data
+is_recently_probed()
}
class RMA {
+CharField rma_number
+ForeignKey asset
+CharField original_serial
+CharField replacement_serial
+CharField status
+DateField date_issued
+DateField date_replaced
+update_asset_serial()
}
class ExternalInventory {
+CharField inventory_number
+CharField status
+CharField project_code
+CharField user_name
+ManyToManyField assets
}
AssetType ||--o{ Asset : type
Asset ||--o{ AssetService : asset
Asset ||--o{ RMA : asset
Asset ||--o{ Probe : serial
Asset }o--|| Contract : order_contract
AssetService }o--|| Contract : contract
Contract }o--|| Contractor : contractor
Contract ||--o{ Invoice : contract
Contract ||--o{ Contract : parent
ExternalInventory }o--o{ Asset : assets
Asset --> Device : assigned_object
Asset --> Site : assigned_object
Asset --> Location : assigned_object
The central model representing physical or logical inventory items.
Key Fields:
serial: Unique identifier for the assetpartnumber: Manufacturer part numberassignment_status: Current assignment status (stocked, assigned, retired, etc.)lifecycle_status: Lifecycle stage (new, in_use, maintenance, decommissioned, etc.)assigned_object: Generic foreign key to NetBox objects (Device, Site, Location, etc.)type: Link to AssetType for categorizationorder_contract: Associated purchase contractwarranty_start/end: Warranty period trackingSpecial Features:
is_recently_probed() methodDiscovery and monitoring data collection points populated by external scripts (e.g., SNMP discovery tools).
Key Fields:
time: Timestamp of the probe data collectionserial: Links to Asset via serial number matchingdevice_descriptor, site_descriptor, location_descriptor: Context information from discoverydiscovered_data: JSON field for flexible data storage from external toolscategory: Probe type classificationNote: Probe data is populated by external discovery scripts, not generated by the plugin itself.
Business relationship management.
Contract Features:
Complete RMA workflow management.
Key Features:
Service and maintenance contract tracking.
Features:
Integration with external inventory management systems.
Features:
pip install inventory-monitor
git clone https://github.com/CESNET/inventory-monitor-plugin.git
cd inventory-monitor-plugin
pip install .
configuration.py:PLUGINS = [
"inventory_monitor",
]
python manage.py migrate
sudo systemctl restart netbox netbox-rq
Configure the plugin in your NetBox configuration.py:
PLUGINS_CONFIG = {
"inventory_monitor": {
# Probe Status Settings
"probe_recent_days": 7, # Days to consider probe "recent"
# External Inventory Status Configuration
"external_inventory_status_config": {
"1": {"label": "Active", "color": "success"},
"0": {"label": "Pending Activation", "color": "warning"},
"2": {"label": "Decommissioned", "color": "danger"},
},
# Custom tooltip template for status display
"external_inventory_tooltip_template": "<span class='badge text-bg-{color}'>{code}</span> {label}",
}
}
probe_recent_days (default: 7): Number of days to consider a probe "recent". Affects visual indicators and status badges.external_inventory_status_config: Maps status codes to display labels and Bootstrap colorsexternal_inventory_tooltip_template: Template string for formatting status tooltipsStatus Configuration Structure:
{
"status_code": {
"label": "Human readable label",
"color": "bootstrap_color_class" # primary, secondary, success, danger, warning, info, light, dark
}
}
Template Variables:
{code}: The status code{label}: The translated label{color}: The Bootstrap color classFor file attachments, install and configure netbox-attachments:
pip install netbox-attachments
After installation, the plugin adds an "Inventory Monitor" section to the NetBox navigation menu with the following sections:
The plugin provides visual feedback for probe status:
Assets can be assigned to any NetBox object using GenericForeignKey:
The plugin provides a full REST API following NetBox patterns:
/api/plugins/inventory-monitor/assets/ - Asset management/api/plugins/inventory-monitor/asset-types/ - Asset type management/api/plugins/inventory-monitor/probes/ - Probe data access/api/plugins/inventory-monitor/contracts/ - Contract management/api/plugins/inventory-monitor/contractors/ - Contractor management/api/plugins/inventory-monitor/invoices/ - Invoice tracking/api/plugins/inventory-monitor/asset-services/ - Service management/api/plugins/inventory-monitor/rmas/ - RMA processing/api/plugins/inventory-monitor/external-inventory/ - External inventory integration/api/docs/The plugin follows NetBox plugin best practices:
Asset ←→ Probe (via serial number matching)
Asset → AssetType
Asset → Contract (order_contract)
Asset ← GenericForeignKey (assigned to Device, Site, Location, etc.)
Asset ←→ RMA (via serial numbers)
Asset ←→ ExternalInventory (many-to-many)
default_settingsselect_related() and prefetch_related()# Recommended approach
from inventory_monitor.settings import get_probe_recent_days
days = get_probe_recent_days()
# Alternative approach
from inventory_monitor.settings import get_plugin_settings
settings = get_plugin_settings()
days = settings.get("probe_recent_days", 7)
This project is licensed under the MIT License. See the LICENSE file for more details.
FAQs
Asset Management with semi-auto discovery processes
We found that inventory-monitor demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Socket identified 80 fake candidates targeting engineering roles, including suspected North Korean operators, exposing the new reality of hiring as a security function.
Application Security
/Research
/Security News
Socket detected multiple compromised CrowdStrike npm packages, continuing the "Shai-Hulud" supply chain attack that has now impacted nearly 500 packages.
Research
/Security News
Malicious update to @ctrl/tinycolor on npm is part of a supply-chain attack hitting 40+ packages across maintainers