NetBox icon

NetBox

Consume NetBox API
Join our community

Actions88

Overview

This node interacts with the NetBox API, specifically targeting the "Module Bay Template" resource within the "DCIM" domain for the "Update" operation. It allows users to update existing module bay templates by specifying their ID and providing new values for various fields such as device type, module type, name, label, position, and description.

Typical use cases include automating updates to hardware configuration templates in a data center infrastructure management system, ensuring that module bay templates reflect current physical or logical changes without manual intervention. For example, if a device type changes or a label needs correction, this node can programmatically apply those updates.

Properties

Name Meaning
Domain The domain of the NetBox API to target. Options: DCIM, IPAM, Tenancy, Extras, Virtualization, Circuits, Core, Users, Plugins, VPN, Wireless, Status. For this operation, must be "dcim".
Module Bay Template ID The unique numeric identifier of the module bay template to update.
Update Fields A collection of fields to update on the module bay template:
- Device Type ID: Numeric ID of the device type associated with the template.
- Module Type ID: Numeric ID of the module type.
- Name: New name string for the module bay template.
- Label: Physical label string for the module bay template.
- Position: Identifier string used for renaming installed components.
- Description: Text description of the module bay template.

Output

The node outputs JSON data representing the updated module bay template record as returned by the NetBox API. This typically includes all fields of the updated resource, reflecting the new state after the update operation.

No binary data output is indicated.

Dependencies

  • Requires an active connection to a NetBox instance via its REST API.
  • Requires an API authentication token credential configured in n8n to authorize requests.
  • The node depends on an internal helper function (executeOperation) to perform the actual API call.

Troubleshooting

  • Common Issues:

    • Invalid or missing Module Bay Template ID will cause the update to fail.
    • Providing invalid field values (e.g., non-existent device type or module type IDs) may result in API errors.
    • Network connectivity issues or incorrect API credentials will prevent successful communication with NetBox.

  • Error Messages:

    • Errors from the NetBox API are caught and logged. If "Continue on Fail" is enabled, the error message is returned as part of the node's output JSON under error.
    • Typical error messages might include "Not Found" for invalid IDs or "Unauthorized" for authentication failures.

  • Resolution:

    • Verify that the Module Bay Template ID exists in NetBox.
    • Confirm that all referenced IDs (device type, module type) are valid.
    • Ensure API credentials are correctly configured and have sufficient permissions.
    • Check network connectivity to the NetBox server.

Links and References

Discussion