NetBox icon

NetBox

Consume NetBox API

Actions243

Inventory Item Template → Create

AI-generated

Overview

This node interacts with the NetBox API to create a new Inventory Item Template within the DCIM domain. It is useful for network administrators or IT professionals who want to automate the creation of inventory item templates in NetBox, which helps in managing device components and their templates efficiently. For example, it can be used to programmatically add new inventory item templates for device types, including details like name, parent template, role, manufacturer, and description.

Use Case Examples

  1. Creating an inventory item template for a specific device type to standardize component details across devices.
  2. Automating the addition of inventory item templates during device provisioning workflows.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management.
Device Type ID The ID of the device type for which the inventory item template is being created.
Name The name of the inventory item template.
Additional Fields Optional additional fields to specify more details about the inventory item template, such as parent template ID, label, role ID, manufacturer ID, part ID, and description.

Output

JSON

  • id - The unique identifier of the created inventory item template.
  • name - The name of the created inventory item template.
  • device_type_id - The device type ID associated with the inventory item 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 - Description of the inventory item template.

Dependencies

  • NetBox API
  • An API key credential for authenticating with the NetBox API

Troubleshooting

  • Ensure the Device Type ID provided exists in NetBox; otherwise, the API will return an error.
  • Verify that the API key credential is valid and has sufficient permissions to create inventory item templates.
  • If the node throws an error, check the error message for details such as missing required fields or invalid data formats.
  • Enable 'Continue on Fail' option to handle errors gracefully and receive error details in the output.

Links

Discussion