Overview

This node updates a Module Bay record in the NetBox API under the DCIM domain. It is useful for scenarios where you need to modify details of a specific module bay, such as changing its name, label, position, installed module, or associated device. For example, updating the label or description of a module bay in a data center management workflow.

Use Case Examples

1. Updating the name and label of a module bay to reflect new hardware changes.
2. Changing the installed module ID to track hardware replacements.
3. Adding or modifying tags and custom fields for better categorization and metadata management.

Properties

Output

JSON

• id - The unique identifier of the updated module bay record.
• device - The device ID associated with the module bay after update.
• name - The name of the module bay after update.
• installed_module - The ID of the installed module in the bay after update.
• label - The label of the module bay after update.
• position - The position of the module bay after update.
• description - The description of the module bay after update.
• tags - Tags associated with the module bay after update.
• custom_fields - Custom fields associated with the module bay after update.

Dependencies

• NetBox API
• An API key credential for authentication

Troubleshooting

• Ensure the Module Bay ID is valid and exists in the NetBox instance to avoid 'not found' errors.
• Verify that the API key credential is correctly configured and has permissions to update module bays.
• Check that the update fields are correctly formatted, especially custom fields as JSON, to prevent validation errors.
• If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message for debugging.

Links

• NetBox API Module Bays Documentation - Official documentation for the Module Bays API endpoint in NetBox.