NetBox icon

NetBox

Consume NetBox API

Actions243

Inventory Item → Update

AI-generated

Overview

This node interacts with the NetBox API to update an existing Inventory Item within the DCIM domain. It is useful for scenarios where you need to modify details of inventory items such as device association, name, parent item, label, role, manufacturer, part ID, serial number, asset tag, discovery status, description, tags, and custom fields. For example, updating the serial number or asset tag of a specific inventory item in a data center management system.

Use Case Examples

  1. Updating the name and serial number of an inventory item to reflect new hardware changes.
  2. Modifying the asset tag and description of an inventory item for better tracking and documentation.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is 'dcim' for data center infrastructure management.
Inventory Item ID The unique identifier of the inventory item to update.
Update Fields A collection of fields that can be updated on the inventory item, including device ID, name, parent ID, label, role ID, manufacturer ID, part ID, serial number, asset tag, discovered status, description, tags, and custom fields.

Output

JSON

  • id - The unique identifier of the updated inventory item.
  • device - The device ID associated with the inventory item.
  • name - The name of the inventory item.
  • parent - The parent inventory item ID, if any.
  • label - The physical label on the inventory item.
  • role - The role ID of the inventory item.
  • manufacturer - The manufacturer ID of the inventory item.
  • part_id - The manufacturer-assigned part identifier.
  • serial - The serial number of the inventory item.
  • asset_tag - The unique asset tag of the inventory item.
  • discovered - Indicates if the item was discovered automatically.
  • description - Description of the inventory item.
  • tags - Tags associated with the inventory item.
  • custom_fields - Custom fields data in JSON format.

Dependencies

  • NetBox API with appropriate authentication credentials

Troubleshooting

  • Common issues include invalid or missing Inventory Item ID, incorrect domain or resource selection, and malformed update fields JSON.
  • Error messages may indicate authentication failures, resource not found, or validation errors on update fields.
  • Ensure the API credentials are valid and have sufficient permissions to update inventory items.
  • Verify that the Inventory Item ID exists and the update fields conform to expected data types and constraints.

Links

Discussion