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, specifically allowing users to create a Device Bay Template within the DCIM domain. Device Bay Templates define reusable templates for device bays, which are slots or spaces in a device where modules can be installed.
Typical use cases include automating the creation of device bay templates when managing hardware inventory or network infrastructure, ensuring consistent configuration and labeling of device bays across multiple devices.
For example, a network engineer could use this node to programmatically create a new device bay template named "Module Slot {module}" for a specific device type, including optional labels and descriptions, streamlining device setup processes.
Properties
| Name | Meaning |
|---|---|
| Domain | The NetBox API domain to target. Options: DCIM, IPAM, Tenancy, Extras, Virtualization, Circuits, Core, Users, Plugins, VPN, Wireless, Status. For this operation, must be DCIM. |
| Device Type ID | Numeric ID of the device type to which the device bay template will be associated. |
| Device Bay Template Name | Name of the device bay template. Supports {module} as a substitution variable. |
| Additional Fields | Optional additional properties: - Label: Physical label of the device bay template. - Description: Description text for the device bay template. |
Output
The node outputs JSON data representing the created device bay template as returned by the NetBox API. This typically includes fields such as the ID, name, label, description, and association to the device type.
No binary data output is produced by this node.
Dependencies
- Requires an active connection to a NetBox instance via an API key credential.
- The user must configure the node with appropriate API credentials that have permissions to create device bay templates.
- The node depends on internal helper functions (from
./helpers/executeOperation) to perform the API call.
Troubleshooting
Common Issues:
- Invalid or missing API credentials will cause authentication failures.
- Providing a non-existent Device Type ID will result in an error from the NetBox API.
- Using a domain other than "DCIM" for this operation will not work because device bay templates belong to the DCIM domain.
Error Messages:
- Authentication errors: Check that the API key credential is valid and has sufficient permissions.
- Validation errors from NetBox (e.g., missing required fields): Ensure all required properties like Device Type ID and Device Bay Template Name are provided.
- Network errors: Verify connectivity to the NetBox server.
Resolution Tips:
- Double-check all input parameters for correctness.
- Confirm that the NetBox instance URL and API key are correctly configured in n8n credentials.
- Enable "Continue on Fail" if you want the workflow to proceed despite errors, which will output the error message in the node's JSON output.
Links and References
- NetBox Official Documentation
- NetBox API Documentation
- Device Bay Templates in NetBox (for detailed schema and usage)