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 new Device Bay within a specified device in the DCIM domain. A Device Bay represents a physical bay or slot on a device where other devices or modules can be installed. This node is useful for network administrators and data center managers who want to automate inventory management and device configuration by programmatically adding bays to devices.
Practical examples:
- Automatically creating device bays when provisioning new hardware.
- Integrating with infrastructure-as-code workflows to maintain up-to-date device layouts.
- Bulk importing device bays from external asset management systems.
Properties
| Name | Meaning |
|---|---|
| Domain | The API domain to use; here it must be "DCIM" for device bays. |
| Device ID | Numeric ID of the parent device to which the device bay will be added. |
| Device Bay Name | The name identifier for the new device bay being created. |
| Additional Fields | Optional extra details about the device bay: |
| - Label | Physical label of the device bay (string). |
| - Description | Text description of the device bay (string). |
| - Installed Device ID | Numeric ID of a device installed inside this bay (optional). |
| - Tags | Comma-separated list of tag IDs to associate with the device bay (string). |
| - Custom Fields | JSON string representing custom fields for the device bay (default is empty JSON object). |
Output
The node outputs a JSON object representing the newly created device bay as returned by the NetBox API. This typically includes all properties of the device bay such as its ID, name, label, description, installed device reference, tags, and any custom fields.
No binary data output is produced by this node.
Dependencies
- Requires an active connection to a NetBox instance via its REST API.
- Needs an API authentication token credential configured in n8n to authorize requests.
- The node depends on internal helper functions (not fully shown) to perform the actual API call.
Troubleshooting
Common issues:
- Invalid or missing device ID: Ensure the parent device exists and the ID is correct.
- Authentication errors: Verify that the API key/token credential is valid and has sufficient permissions.
- Malformed additional fields: Custom fields must be valid JSON strings.
- Network connectivity problems to the NetBox server.
Error messages:
- Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as error objects in the output.
- Typical error messages include HTTP 4xx/5xx responses from the NetBox API indicating invalid input or server issues.
Links and References
This summary focuses on the "Device Bay" resource and the "Create" operation within the DCIM domain of the NetBox node.