NetBox icon

NetBox

Consume NetBox API

Actions243

Device Type → Update

AI-generated

Overview

This node updates a device type record in the NetBox API under the DCIM domain. It is useful for managing and modifying device type details such as manufacturer, model, slug, part number, height, depth, airflow, weight, comments, tags, and custom fields. For example, it can be used to update the model name or manufacturer ID of a device type in an automated network management workflow.

Use Case Examples

  1. Updating the model name of a device type to reflect a new hardware revision.
  2. Changing the manufacturer ID of a device type after a supplier change.
  3. Adding tags or comments to a device type for better categorization and documentation.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is 'dcim' for device management.
Device Type ID The unique identifier of the device type record to update.
Update Fields Collection of fields to update on the device type, including manufacturer ID, model, slug, part number, height, depth, subdevice role, airflow, weight, weight unit, comments, tags, and custom fields.

Output

JSON

  • id - ID of the updated device type record.
  • manufacturer - Manufacturer ID of the device type.
  • model - Model name of the device type.
  • slug - Slug identifier of the device type.
  • part_number - Manufacturer part number.
  • u_height - Height in rack units.
  • is_full_depth - Boolean indicating if device is full depth.
  • subdevice_role - Role of the device as parent or child in rack.
  • airflow - Airflow direction of the device.
  • weight - Weight of the device type.
  • weight_unit - Unit of the weight.
  • comments - Comments associated with the device type.
  • tags - Tags associated with the device type.
  • custom_fields - Custom fields data in JSON format.

Dependencies

  • NetBox API
  • API key credential for authentication

Troubleshooting

  • Ensure the Device Type ID is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential is valid and has sufficient permissions to update device types.
  • Check that the update fields are correctly formatted and valid according to NetBox API specifications.
  • If the node throws an error, enabling 'Continue on Fail' allows the workflow to proceed and returns the error message as output for debugging.

Links

Discussion