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 targeting the "Device Bay" resource within the "DCIM" domain for the "List" operation. It allows users to retrieve a list of device bays from their NetBox instance, optionally filtered by various criteria such as device bay ID, device ID, name, or installed device ID.
Common scenarios where this node is beneficial include:
- Inventory management: Automatically fetching device bay information to keep track of hardware placements.
- Automation workflows: Integrating device bay data into broader IT automation pipelines.
- Reporting: Generating reports on device bay usage or status.
For example, a user might want to list all device bays associated with a particular device or filter device bays by name to find specific slots in network racks.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to use. Options include: DCIM, IPAM, Tenancy, Extras, Virtualization, Circuits, Core, Users, Plugins, VPN, Wireless, Status. For this operation, "DCIM" is used. |
| Return All | Whether to return all results or limit the number of returned items. |
| Limit | Maximum number of results to return when "Return All" is false. |
| Filters | Collection of filters to narrow down the list of device bays: |
| - Device Bay ID | Filter by specific device bay ID (number). |
| - Device ID | Filter by device ID to get device bays belonging to a particular device (number). |
| - Name | Filter by device bay name (string). |
| - Installed Device ID | Filter by installed device ID (number). |
Output
The node outputs an array of JSON objects representing device bays retrieved from the NetBox API. Each object corresponds to a device bay and contains its properties as defined by the NetBox API response schema.
If the node encounters an error during execution and "Continue on Fail" is enabled, it outputs an object with an error field containing the error message.
No binary data output is involved in this operation.
Dependencies
- Requires access to a NetBox instance with the appropriate API enabled.
- Requires an API authentication token credential configured in n8n to authenticate requests to the NetBox API.
- The node depends on an internal helper function (
executeOperation) to perform the actual API call based on the selected domain, resource, operation, and parameters.
Troubleshooting
Common issues:
- Authentication failures due to invalid or missing API tokens.
- Network connectivity problems preventing access to the NetBox API endpoint.
- Incorrect filter values leading to empty result sets.
- Exceeding API rate limits if requesting too many records without pagination.
Error messages:
- Errors thrown by the node will be logged to the console.
- If "Continue on Fail" is disabled, errors will stop the workflow execution.
- If enabled, errors are returned as part of the output JSON under the
errorkey.
Resolutions:
- Verify API credentials and permissions.
- Check network connectivity and API endpoint URL.
- Adjust filters to valid values.
- Use "Return All" carefully to avoid large data requests.