NetBox icon

NetBox

Consume NetBox API

Actions243

Module → Update

AI-generated

Overview

This node interacts with the NetBox API to update a module resource within the DCIM domain. It allows users to modify various attributes of a module such as device ID, module bay ID, module type ID, serial number, asset tag, description, comments, tags, and custom fields. This is useful in scenarios where network or data center administrators need to keep module information current in their NetBox inventory system, for example, updating the serial number or asset tag of a hardware module.

Use Case Examples

  1. Updating the serial number and asset tag of a module in the DCIM domain to reflect new hardware information.
  2. Modifying the description and comments of a module to add additional details or notes for documentation purposes.

Properties

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

Output

JSON

  • id - The unique identifier of the updated module.
  • device - The device ID associated with the module after update.
  • module_bay - The module bay ID after update.
  • module_type - The module type ID after update.
  • serial - The serial number of the module after update.
  • asset_tag - The asset tag of the module after update.
  • moduleDescription - The description of the module after update.
  • comments - Comments about the module after update.
  • tags - Tags associated with the module after update.
  • custom_fields - Custom fields of the module after update.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Common issues include invalid module ID or missing required fields leading to API errors.
  • Errors related to authentication if the API key or credentials are incorrect or expired.
  • Network connectivity issues preventing access to the NetBox API endpoint.
  • Malformed JSON in custom fields causing update failures.

Discussion