NetBox icon

NetBox

Consume NetBox API

Actions243

Module Type → Update

AI-generated

Overview

This node interacts with the NetBox API to update a Module Type resource within the DCIM domain. It allows users to modify details of a specific module type by providing its ID and the fields to update, such as model name, manufacturer ID, part number, weight, description, comments, tags, and custom fields. This is useful for network administrators or IT professionals managing hardware inventory and configurations in NetBox, enabling automated updates to module type records.

Use Case Examples

  1. Updating the model name and part number of a module type to reflect new hardware specifications.
  2. Adding comments or tags to a module type for better categorization and documentation.
  3. Changing the weight and weight unit of a module type to ensure accurate physical inventory data.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is 'dcim' for data center infrastructure management.
Module Type ID The unique identifier of the module type to update.
Update Fields A collection of fields that can be updated for the module type, including model, manufacturer ID, part number, weight, weight unit, description, comments, tags, and custom fields.

Output

JSON

  • id - ID of the updated module type record
  • model - Model name of the updated module type
  • manufacturer - Manufacturer ID of the updated module type
  • part_number - Part number of the updated module type
  • weight - Weight of the updated module type
  • weight_unit - Weight unit of the updated module type
  • description - Description of the updated module type
  • comments - Comments about the updated module type
  • tags - Tags associated with the updated module type
  • custom_fields - Custom fields of the updated module type

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Common issues include providing an invalid Module Type ID, which results in a not found error from the API.
  • Incorrectly formatted update fields, such as invalid JSON in custom fields, may cause the update to fail.
  • Network connectivity issues or invalid API credentials will prevent successful communication with the NetBox API.

Links

  • NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and data structures.

Discussion