Overview

This node updates a Device Bay record in the NetBox API under the DCIM domain. It is useful for scenarios where you need to modify details of a device bay, such as changing its name, label, description, or associated devices. For example, updating the physical label or installing a new device in the bay can be automated using this node.

Use Case Examples

1. Updating the name and label of a device bay to reflect new hardware changes.
2. Setting the installed device ID to track which device is currently installed in the bay.
3. Adding or modifying custom fields or tags for better categorization and management.

Properties

Output

JSON

• id - ID of the updated device bay record.
• device - ID of the parent device associated with the device bay.
• name - Name of the device bay.
• label - Physical label of the device bay.
• description - Description of the device bay.
• installed_device - ID of the device installed in the bay.
• tags - Tags associated with the device bay.
• custom_fields - Custom fields data for the device bay.

Dependencies

• NetBox API
• API authentication token or API key credential

Troubleshooting

• Ensure the Device Bay ID is valid and exists in the NetBox instance to avoid 'not found' errors.
• Verify that the API credentials have sufficient permissions to update device bays.
• Check the format of custom fields JSON to avoid parsing errors.
• If the node throws an error, enabling 'Continue on Fail' will output the error message as JSON instead of stopping execution.

Links

• NetBox Device Bay API Documentation - Official documentation for the Device Bay resource in NetBox API.