Skip to main content

Inventory asset management in NetBox

Project description

netbox-inventory

Manage your hardware inventory in NetBox.

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.

Settings

Setting Default value Description
used_status_name 'used' Status that indicates asset is in use. See "Automatic management of asset status" below for more info on this setting.
stored_status_name 'stored' Status that indicates asset is in storage. See "Automatic management of asset status" below for more info on this setting.
sync_hardware_serial_asset_tag False When an asset is assigned or unassigned to a device, module or inventory item, update its serial number and asset tag to be in sync with the asset?
asset_import_create_purchase False When importing assets, automatically create purchase (and supplier) if it doesn't exist
asset_import_create_device_type False When importing a device type asset, automatically create manufacturer and/or device type if it doesn't exist
asset_import_create_module_type False When importing a module type asset, automatically create manufacturer and/or device type if it doesn't exist
asset_import_create_inventoryitem_type False When importing an inventory type asset, automatically create manufacturer and/or device type if it doesn't exist
asset_disable_editing_fields_for_tags {} A dictionary of tags and fields that should be disabled for editing. This is useful if you want to prevent editing of certain fields for certain assets. The dictionary is in the form of {tag: [field1, field2]}. Example: {'no-edit': ['serial_number', 'asset_tag']}. This only affects the UI, the API can still be used to edit the fields.
asset_disable_deletion_for_tags [] List of tags that will disable deletion of assets. This only affects the UI, not the API.

Future development ideas

  • location report
  • supplier detail - show assets
  • device on_delete update asset.status (if asset assigned)
  • prevent device.device_type/serial/asset_tag change if asset assigned (and sync_hardware_serial_asset_tag=true?) see AbortRequest
  • inject asset list on manufacturer detail?
  • inventoryitem detail - show asset info
  • inventoryitem_type - assign existing, bulk, show assets, more testing
  • bootstrap scripts to generate assets from existing device/module S/N data
  • from device details view -> to change asset, assign asset
  • supplier import, bulk edit
  • how to assign MACs to device/module interfaces that is created from Asset

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netbox-inventory-1.0.1.tar.gz (28.9 kB view details)

Uploaded Source

File details

Details for the file netbox-inventory-1.0.1.tar.gz.

File metadata

  • Download URL: netbox-inventory-1.0.1.tar.gz
  • Upload date:
  • Size: 28.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for netbox-inventory-1.0.1.tar.gz
Algorithm Hash digest
SHA256 386465a2b7ea4bce1880eff2da1ec139bd20a3f5e9822949064bddc631da307a
MD5 07ab4867163204be3a906353a6194dd7
BLAKE2b-256 258a93b3b3f0577895372db27b91c68ad4a9b8c56269330f05556f43eafbc407

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page