Actions243
- Cable Actions
- Cable Termination Actions
- Connected Device Actions
- Console Port Actions
- Console Port Template Actions
- Console Server Port Actions
- Console Server Port Template Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Front Port Actions
- Front Port Template Actions
- Interface Actions
- Interface Template Actions
- Inventory Item Actions
- Inventory Item Role Actions
- Inventory Item Template Actions
- Location Actions
- MAC Address Actions
- Manufacturer Actions
- Module Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Module Type Profile Actions
- Platform Actions
- Power Feed Actions
- Power Outlet Actions
- Power Outlet Template Actions
- Power Panel Actions
- Power Port Actions
- Power Port Template Actions
- Rack Actions
- Rack Reservation Actions
- Rack Role Actions
- Rack Type Actions
- Rear Port Actions
- Rear Port Template Actions
- Region Actions
- Site Actions
- Site Group Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
- Virtual Link Actions
Device Bay Template → Update
AI-generatedOverview
This node updates a Device Bay Template in the NetBox API under the DCIM domain. It is useful for automating the modification of device bay templates, such as changing the device type, name, label, or description. For example, it can be used to update the label or description of a device bay template programmatically based on external data or workflow triggers.
Use Case Examples
- Updating the name and description of a device bay template to reflect new hardware changes.
- Changing the device type associated with a device bay template as part of an inventory update process.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to use, here it is 'dcim' for device-related resources. |
| Device Bay Template ID | The unique identifier of the device bay template to update. |
| Update Fields | Fields to update on the device bay template, including device type ID, name, label, and description. |
Output
JSON
id- The ID of the updated device bay template record.device_type- The device type ID associated with the updated template.name- The updated name of the device bay template.label- The updated physical label of the device bay template.description- The updated description of the device bay template.
Dependencies
- NetBox API with appropriate credentials
Troubleshooting
- Ensure the Device Bay Template ID is valid and exists in the NetBox instance.
- Verify that the API credentials have permission to update device bay templates.
- Check that the update fields are correctly formatted and valid according to NetBox API specifications.
- Common error messages may include authorization errors, resource not found, or validation errors on fields. Resolving these involves checking credentials, IDs, and field values.
Links
- NetBox API Documentation for Device Bay Templates - Official documentation for the Device Bay Template resource in the NetBox API, including update operations.