Skip to content

Asset Index Plugin for Netbox

To learn about allocations/asset index, please refer to the documentation at Platform Inventory and the SRB

The Asset Index Plugin for Netbox allows you to manage rack and server allocations in Netbox. It provides a RESTful API to create, update, and delete rack and server allocations through asynchronous jobs in Netbox. The plugin is setup to sync with Platform Inventory on the backend.

This is the flow of the plugin:

  • User submits an API request
  • Netbox validates & accepts the request
  • Netbox initiates a backend job for the request
  • Validations are run against allocations similar to platform-inventory
  • A sync PR is created and merged to Platform-Inventory to update the allocations

Requesting access to the Asset Index Plugin

To access Asset Index Plugin, Users are currently requested to raise access for dcim-asset-index-reader/ dcim-asset-index-reader-gc please note that users with the above access will only be able to perfom READ actions on netbox UI and hit API's which contain -job in them. These API's and payloads are stop gap solution until we move away from platform-inventory.

Access to the plugin is controlled through AccessHub - please choose the appropriate bluegroup.

Token generation for API request

After the access is approved/granted. Open the NetBox UI and go to the Profile section in the top-right corner. Select API Tokens, then click Add Token. You can provide a custom key or leave it blank to auto-generate one. Keep the other settings as default and click Create. A new token will be generated, which can be used for future API requests.