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 update a "Module Bay" resource within the "DCIM" domain. The "Module Bay" represents a physical or logical bay in a device where modules can be installed. This node is useful for network engineers and data center managers who want to programmatically update details about module bays in their infrastructure management system.
Typical use cases include:
- Updating the name or label of a module bay.
- Changing the installed module associated with a bay.
- Modifying metadata such as position, description, tags, or custom fields.
- Associating the module bay with a different device by ID.
For example, if a new module is installed in a specific bay of a device, this node can update the record to reflect that change automatically.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to interact with. For this operation, it must be "DCIM". |
| Module Bay ID | The unique numeric identifier of the module bay to update. |
| Update Fields | A collection of fields to update on the module bay: |
| - Device ID | Numeric ID of the device to which the module bay belongs. |
| - Name | New name for the module bay. |
| - Installed Module ID | Numeric ID of the module installed in the bay. |
| - Label | Label string for the module bay. |
| - Position | Position description of the module bay. |
| - Description | Textual description of the module bay. |
| - Tags | Comma-separated list of tag IDs to associate with the module bay. |
| - Custom Fields | JSON string representing custom fields for the module bay. |
Output
The node outputs the response from the NetBox API after attempting to update the specified module bay. The output is structured as JSON containing the updated module bay's data as returned by the API.
If an error occurs and "Continue on Fail" is enabled, the output will contain a JSON object with an error field describing the issue.
No binary data is produced by this node.
Dependencies
- Requires an active connection to a NetBox instance via its REST API.
- Requires an API authentication token credential configured in n8n to authorize requests.
- The node depends on an internal helper function (
executeOperation) to perform the actual API call.
Troubleshooting
Common issues:
- Invalid or missing Module Bay ID will cause the update to fail.
- Incorrect or insufficient API credentials will result in authorization errors.
- Providing malformed JSON in the "Custom Fields" property may cause request failures.
- Attempting to update fields not supported by the API or sending invalid values may trigger validation errors.
Error messages:
"error": "Not Found"indicates the specified Module Bay ID does not exist."error": "Unauthorized"suggests invalid or missing API credentials.- JSON parsing errors related to custom fields should be corrected by ensuring valid JSON syntax.
To resolve errors, verify all input parameters, ensure proper API credentials are set, and confirm the target Module Bay exists in NetBox.