NetBox icon

NetBox

Consume NetBox API

Actions243

Inventory Item → List

AI-generated

Overview

This node interacts with the NetBox API to list inventory items within the DCIM domain. It is useful for retrieving detailed information about inventory items managed in NetBox, such as devices, parts, and related metadata. Common scenarios include asset management, inventory audits, and integration with other IT management workflows.

Use Case Examples

  1. Retrieve all inventory items from the DCIM domain to generate an asset report.
  2. Filter inventory items by device ID or manufacturer to analyze specific subsets of inventory.
  3. Limit the number of returned inventory items for performance optimization in large environments.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for data center infrastructure management.
Return All Determines whether to return all inventory items or limit the results to a specified number.
Limit Maximum number of inventory items to return when 'Return All' is false.
Filters Collection of filters to narrow down the inventory items list, such as search query, device ID, name, label, role ID, manufacturer ID, part ID, serial number, asset tag, discovered status, ID, ordering, and date filters.

Output

JSON

  • id - Unique identifier of the inventory item.
  • name - Name of the inventory item.
  • device_id - Identifier of the device associated with the inventory item.
  • label - Label assigned to the inventory item.
  • role_id - Role identifier associated with the inventory item.
  • manufacturer_id - Manufacturer identifier of the inventory item.
  • part_id - Part identifier of the inventory item.
  • serial - Serial number of the inventory item.
  • asset_tag - Asset tag of the inventory item.
  • discovered - Boolean indicating if the inventory item was discovered automatically.
  • created__gt - Filter for inventory items created after a specific date.
  • created__lt - Filter for inventory items created before a specific date.
  • last_updated__gt - Filter for inventory items last updated after a specific date.
  • last_updated__lt - Filter for inventory items last updated before a specific date.

Dependencies

  • NetBox API with appropriate API key credentials

Troubleshooting

  • Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key is correctly configured.
  • Incorrect filter parameters may result in no data returned; verify filter values and types.
  • Network connectivity issues can prevent API calls; check network access to the NetBox server.
  • If 'Return All' is false and limit is set too low, the output may not include all desired items; adjust the limit accordingly.

Links

Discussion