Actions88
- Module Actions
- Platform Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Interface Actions
- Manufacturer Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Region Actions
- Site Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
Overview
This node interacts with the NetBox API, a popular infrastructure resource modeling tool. Specifically, the "Module" resource with the "Delete" operation allows users to delete a module record from the NetBox system. This is useful for automating cleanup or management of hardware modules in data centers or network environments.
Typical use cases include:
- Removing obsolete or decommissioned hardware modules from inventory.
- Automating infrastructure updates by deleting modules as part of a workflow.
- Integrating with other systems to keep NetBox data synchronized and accurate.
Example: Automatically delete a module by its ID when it is physically removed from a device.
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, "dcim" is relevant. |
| Module ID | The numeric ID of the module to delete within the selected domain/resource. Required for the "modules" resource under the "dcim" domain. |
Output
The node outputs JSON data representing the result of the delete operation. Typically, this will be an empty response or confirmation that the module was deleted successfully. If an error occurs, the output JSON will contain an error field with the error message.
No binary data output is involved.
Dependencies
- Requires connection to a NetBox instance via its REST API.
- Needs an API authentication token or key configured in n8n credentials to authorize requests.
- The node depends on an internal helper function (
executeOperation) to perform the HTTP request to NetBox.
Troubleshooting
Common issues:
- Invalid or missing Module ID: Ensure the module ID provided exists and is correct.
- Authentication errors: Verify the API key or token credentials are valid and have sufficient permissions.
- Network connectivity: Confirm that the n8n instance can reach the NetBox API endpoint.
Error messages:
- Errors returned from the NetBox API (e.g., 404 Not Found if the module does not exist).
- Node execution errors will be logged; if "Continue on Fail" is enabled, errors will be output as JSON with an
errorfield.
Resolution:
- Double-check input parameters.
- Validate API credentials.
- Review NetBox API documentation for permission requirements.