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 integrates with the NetBox API, a popular infrastructure resource modeling tool used for managing IP addresses, devices, virtual machines, and other network resources. The node allows users to perform various operations on different domains and resources within NetBox.
Specifically, the Module Type - Get operation retrieves details about a specific module type in the DCIM domain of NetBox. This is useful when you want to fetch metadata or configuration information about hardware module types (e.g., line cards, power supplies) associated with devices managed in NetBox.
Common scenarios:
- Automating inventory management by fetching module type details.
- Integrating NetBox data into monitoring or asset management systems.
- Validating device configurations against known module types.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to interact with. Options include: DCIM, IPAM, Tenancy, Extras, Virtualization, Circuits, Core, Users, Plugins, VPN, Wireless, Status. Default is DCIM. |
| Resource | The specific resource within the selected domain. For DCIM domain, options include Device, Device Bay, Device Bay Template, Device Role, Device Type, Interface, Manufacturer, Module, Module Bay, Module Bay Template, Module Type, Platform, Region, Site, Virtual Chassis, Virtual Device Contexts. Default is devices. |
| Operation | The action to perform on the resource. In this case, "Get" to retrieve a record. |
| Module Type ID | The numeric ID of the module type to retrieve. Required when Domain is DCIM and Resource is Module Type. |
| ID | The string ID of the record to retrieve. Used for some domains/resources like Tenancy. |
Output
The node outputs JSON data representing the retrieved module type record from NetBox. The structure corresponds directly to the NetBox API response for a module type, typically including fields such as:
id: Unique identifier of the module type.name: Name of the module type.manufacturer: Manufacturer details.part_number: Part number of the module.description: Description of the module type.- Other metadata fields relevant to the module type.
No binary data output is involved in this operation.
Dependencies
- Requires an active connection to a NetBox instance via its REST API.
- Requires an API authentication token or key configured in n8n credentials to authorize requests.
- No additional external services are needed beyond the NetBox API.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Providing an incorrect or non-existent Module Type ID will result in a "not found" error.
- Network connectivity issues to the NetBox server can cause request timeouts or failures.
Error messages:
"error": "Request failed with status code 404"indicates the specified module type ID does not exist.- Authentication errors usually return 401 or 403 HTTP status codes.
Resolutions:
- Verify API credentials and permissions.
- Confirm the Module Type ID exists in NetBox.
- Check network access and URL correctness for the NetBox API endpoint.