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, specifically allowing users to update a Device Bay Template within the DCIM domain. It is useful for network administrators and infrastructure engineers who manage physical device configurations in NetBox and need to programmatically modify device bay templates. For example, you might update the name, label, description, or associated device type of a device bay template to reflect changes in hardware or organizational standards.
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. For this operation, it must be "DCIM". |
| Device Bay Template ID | The unique numeric identifier of the device bay template to update. |
| Update Fields | A collection of fields to update on the device bay template: |
| - Device Type ID | Numeric ID of the device type associated with the device bay template. |
| - Name | New name for the device bay template. |
| - Label | Physical label for the device bay template. |
| - Description | Textual description of the device bay template. |
Output
The node outputs JSON data representing the updated device bay template as returned by the NetBox API. This typically includes all properties of the device bay template after the update, such as its ID, name, label, description, and associated device type details.
The node does not output binary data.
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 to the NetBox API.
- The node depends on internal helper functions (from
./helpers/executeOperation) to perform the actual API call.
Troubleshooting
- Common issues:
- Invalid or missing Device Bay Template ID will cause the update to fail.
- Insufficient permissions or invalid API token may result in authorization errors.
- Providing invalid field values (e.g., non-existent device type ID) can cause API validation errors.
- Error messages:
- Errors from the NetBox API are caught and returned as JSON error messages if "Continue on Fail" is enabled.
- Typical errors include HTTP 400 (bad request), 401 (unauthorized), or 404 (not found).
- Resolution tips:
- Verify that the Device Bay Template ID exists in your NetBox instance.
- Ensure the API token has write permissions for the DCIM domain.
- Double-check the format and validity of fields in the "Update Fields" collection.