NetBox icon

NetBox

Consume NetBox API

Actions243

Inventory Item Template → Update

AI-generated

Overview

This node updates an existing Inventory Item Template in the NetBox API under the DCIM domain. It is useful for modifying details of inventory item templates such as device type, name, parent template, label, role, manufacturer, part ID, and description. For example, it can be used to update the name or description of a specific inventory item template by providing its ID and the fields to update.

Use Case Examples

  1. Updating the name and description of an inventory item template by specifying its ID and new values.
  2. Changing the manufacturer or device type associated with an inventory item template.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is 'dcim' for device and component management.
Inventory Item Template ID The unique identifier of the inventory item template to update.
Update Fields A collection of fields to update on the inventory item template, such as device type ID, name, parent ID, label, role ID, manufacturer ID, part ID, and description.

Output

JSON

  • id - The unique identifier of the updated inventory item template.
  • name - The name of the updated inventory item template.
  • device_type - The device type ID associated with the updated template.
  • parent - The parent inventory item template ID, if any.
  • label - The physical label on the component.
  • role - The inventory item role ID.
  • manufacturer - The manufacturer ID.
  • part_id - The manufacturer-assigned part identifier.
  • description - The description of the inventory item template.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the Inventory Item Template ID is correct and exists in the NetBox instance.
  • Verify that the API credentials have permission to update inventory item templates.
  • Check that the fields provided in 'Update Fields' are valid and correctly formatted.
  • Common error messages may include authentication errors, resource not found, or validation errors on fields. Resolving these involves checking credentials, verifying resource IDs, and ensuring field values meet API requirements.

Links

Discussion