| single |
# NetBox Inventory Plugin
A [Netbox] plugin for hardware inventory.
## Features
Keep track of your hardware, whether it is installed or in storage. You can
define assets that represent hardware that can be used as a device, module
or
inventory item in NetBox.
Each asset can have a storage location defined, when not in use. You can
assign
an asset to a device or module. The plugin can keep serial number and asset
tag
between asset and device or module in sync if enabled in settings.
To properly support inventory items (that are used in NetBox to model SFP
and
similar modules) the plugin defines inventory item types that are
equivalent to
device types and module types.
### Automatic management of asset status
Each asset has a status attribute that can indicate use of the asset. These
statuses can be set as needed by each NetBox installation.
Two statuses can have a special meaning. One to indicate asset is in
storage and one
to indicate asset is in use.
netbox_inventory can automatically set status to the value specified in
`used_status_name` configuration item when an asset is assigned to a
device, module
or inventory item.
When you remove an asset from device, module or inventory item the plugin
will set
asset status to `stored_status_name` configuration item.
To disable automatically changing status, set these two config parameters
to `None`.
### Prevent unwanted changes for tagged assets
With `asset_disable_editing_fields_for_tags` and
`asset_disable_deletion_for_tags` you can prevent changes to specified
asset data for assets that have certain tags attached. Changes are only
prevented via web interface. API modifications are allowed.
The idea is that an external system uses some assets stored in
netbox_inventory, and you want to prevent accidental changes to data
directly in NetBox web interface. Only that external system should modify
the data.
## Compatibility
This plugin requires netbox version 3.3 to work.
| NetBox Version | Plugin Version |
|----------------|----------------|
| 3.3 | 1.0.x |
| 3.4 | (none yet) |
## Installing
Review [official Netbox plugin documentation] for installation
instructions.
You install the plugin from pypi with pip. Make sure you activate Netbox's
virtual
environment first:
```bash
$ source /opt/netbox/venv/bin/activate
(venv) $ pip install netbox-inventory
```
For adding to a NetBox Docker setup see
[the general instructions for using netbox-docker with plugins].
You can install a development version directly from GitHub:
```bash
pip install git+https://github.com/ArnesSI/netbox-inventory.git@master
```
or by adding to your `local_requirements.txt` or `plugin_requirements.txt`
(netbox-docker):
```bash
git+https://github.com/ArnesSI/netbox-inventory.git@master
```
After installation, enable the plugin in
`/opt/netbox/netbox/netbox/configuration.py`,
or if you use netbox-docker, your `/configuration/plugins.py` file :
```python
|