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 used for managing IP addresses, devices, and other network resources. Specifically, when configured to list "Modules" under the "DCIM" domain, it retrieves a collection of hardware modules associated with devices in your data center inventory.
Common scenarios where this node is beneficial include:
- Automating inventory audits by fetching all modules installed on devices.
- Filtering modules based on specific criteria like device ID or serial number to track hardware changes.
- Integrating module data into broader workflows for asset management or reporting.
For example, you could use this node to list all modules installed on a particular device by specifying the device ID filter, then process that data downstream to update an asset database or trigger maintenance tasks.
Properties
| Name | Meaning |
|---|---|
| Domain | The NetBox API domain to target. For listing modules, this should be set to DCIM. |
| Return All | Whether to return all matching results or limit the output. |
| Limit | Maximum number of results to return if not returning all. |
| Filters | Optional filters to narrow down the list of modules: |
| - Module ID | Filter by a specific module's unique identifier. |
| - Device ID | Filter modules belonging to a specific device. |
| - Module Bay ID | Filter by the module bay identifier where the module is installed. |
| - Module Type ID | Filter by the type of module. |
| - Serial Number | Filter by the module's serial number string. |
| - Asset Tag | Filter by the asset tag assigned to the module. |
Output
The node outputs JSON data representing the list of modules retrieved from the NetBox API. Each item in the output array corresponds to a module object containing its properties as defined by NetBox, such as IDs, serial numbers, types, and associations to devices or bays.
If the node is configured to return all results, the output will contain the complete dataset; otherwise, it will be limited by the specified "Limit" property.
No binary data output is produced by this node.
Dependencies
- Requires access to a NetBox instance with API enabled.
- Needs an API authentication token credential configured in n8n to authorize requests.
- The node depends on internal helper functions (from
./helpers/executeOperation) to perform the actual API calls.
Troubleshooting
Common issues:
- Authentication failures due to missing or invalid API tokens.
- Network connectivity problems reaching the NetBox server.
- Incorrect filter values leading to empty result sets.
Error messages:
- Errors during execution are logged to the console.
- If "Continue on Fail" is enabled, errors are returned as part of the node output JSON under an
errorfield. - To resolve errors, verify API credentials, ensure correct domain/resource/operation selections, and check filter parameters.