https://github.com/diegogodoy06/netbox-maintenance-device
Netbox Plugin for maintenance devices
https://github.com/diegogodoy06/netbox-maintenance-device
netbox netbox-plugin
Last synced: 19 days ago
JSON representation
Netbox Plugin for maintenance devices
- Host: GitHub
- URL: https://github.com/diegogodoy06/netbox-maintenance-device
- Owner: diegogodoy06
- License: other
- Created: 2025-09-09T18:44:02.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2026-01-14T13:08:22.000Z (5 months ago)
- Last Synced: 2026-01-14T15:43:47.898Z (5 months ago)
- Topics: netbox, netbox-plugin
- Language: Python
- Homepage:
- Size: 567 KB
- Stars: 20
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# NetBox Maintenance Device Plugin
[](https://netbox.dev/)
[](https://pypi.org/project/netbox-maintenance-device/)
[](https://pepy.tech/projects/netbox-maintenance-device)
[](README.md)
A comprehensive NetBox plugin for managing device preventive and corrective maintenance with enhanced visual indicators, scheduling capabilities, and multi-language support.
## Features
- **Maintenance Plans**: Create and manage maintenance plans for devices with configurable frequency
- **Maintenance Executions**: Record and track maintenance executions with status monitoring
- **Device Integration**: View maintenance history directly on device pages with dedicated tabs
- **Quick Actions**: Schedule and complete maintenance directly from the interface
- **REST API**: Complete REST API for external integrations and automation
- **Advanced Filtering**: Powerful filtering and search capabilities
- **Custom Actions**: Schedule, complete, and cancel maintenance via API
- **Statistics**: Get maintenance statistics and overdue/upcoming reports
## Compatibility
| NetBox Version | Plugin Support | Notes |
|----------------|----------------|-------|
| 4.5.x | **Tested & Supported** | Current target version |
| 4.4.x | **Tested & Supported** | Fully compatible |
| 4.3.x | **Likely Compatible** | Not officially tested |
| 4.2.x | **Likely Compatible** | Not officially tested |
| 4.1.x | **Likely Compatible** | Not officially tested |
| 4.0.x | **Likely Compatible** | Not officially tested |
| 3.x | **Not Supported** | Breaking changes |
> **Note**: This version (v1.2.3) is specifically tested and certified for NetBox 4.5.x and 4.4.x. While it may work with other 4.x versions, we recommend testing in a development environment first.
> **Python Requirements**: NetBox 4.5.x requires Python 3.12, 3.13, or 3.14. If you're using NetBox 4.4.x or earlier, you can use Python 3.8+.
## Installation
### Method 1: PyPI Installation (Recommended)
**Now officially available on PyPI!**
```bash
# Install the latest version
pip install netbox-maintenance-device
# Or install a specific version
pip install netbox-maintenance-device==1.2.3
```
**For Docker deployments**, add to your `plugin_requirements.txt`:
```bash
echo "netbox-maintenance-device>=1.2.3" >> plugin_requirements.txt
```
### Method 2: GitHub Installation
```bash
# Install from GitHub (development version)
pip install git+https://github.com/diegogodoy06/netbox-maintenance-device.git
```
### Method 3: Docker Installation
For Docker-based NetBox installations using [netbox-docker](https://github.com/netbox-community/netbox-docker):
> **📋 For detailed Docker installation instructions in English and Portuguese, see [DOCKER_INSTALL.md](DOCKER_INSTALL.md)**
## Configuration
### Basic Configuration
Add the plugin to your NetBox `configuration.py`:
```python
# configuration.py
PLUGINS = [
'netbox_maintenance_device',
# ... other plugins
]
# Optional: Plugin-specific settings
PLUGINS_CONFIG = {
'netbox_maintenance_device': {
# Future configuration options will be added here
# Currently, the plugin uses default settings
}
}
```
### Language Configuration (Optional)
To enable Portuguese-BR by default:
```python
# configuration.py
# Enable internationalization
USE_I18N = True
USE_L10N = True
# Set default language
LANGUAGE_CODE = 'pt-br'
TIME_ZONE = 'America/Sao_Paulo'
# Available languages
LANGUAGES = [
('en', 'English'),
('pt-br', 'Português (Brasil)'),
]
```
### Restart Services
Restart your NetBox services:
```bash
# For systemd
sudo systemctl restart netbox netbox-rq
# For Docker
docker compose restart netbox netbox-worker
```
## Usage
For detailed usage instructions, please refer to the **[USAGE.md](USAGE.md)** guide, which includes:
- Creating and managing maintenance plans
- Scheduling and completing maintenance
- Monitoring maintenance status
- Using the REST API
- Troubleshooting common issues
**Quick Start**:
1. Create maintenance plans for your devices
2. View upcoming/overdue maintenance in the dashboard
3. Use quick action buttons to schedule or complete maintenance
4. Monitor device-specific maintenance on device pages
## Screenshots
### Device Maintenance Section
*View maintenance plans and status directly on device pages*
### Upcoming Maintenance Dashboard
*Monitor all upcoming and overdue maintenance across your infrastructure*
### Maintenance Plan Management
*Create and manage maintenance plans with flexible scheduling*
---
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## 📄 License
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgments
- NetBox community for the excellent platform
- Contributors and users providing feedback