NetBox icon

NetBox

Consume NetBox API

Actions243

Module Bay Template → Update

AI-generated

Overview

This node updates a Module Bay Template resource in the NetBox API under the DCIM domain. It is useful for modifying existing module bay templates by changing properties such as device type ID, module type ID, name, label, position, and description. For example, it can be used to rename a module bay template or update its physical label or description.

Use Case Examples

  1. Updating the name and label of a specific module bay template by providing its ID and new values.
  2. Changing the device type or module type associated with a module bay template.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is 'dcim' for device and component management.
Module Bay Template ID The unique identifier of the module bay template to update.
Update Fields A collection of fields to update on the module bay template, including device type ID, module type ID, name, label, position, and description.

Output

JSON

  • id - The unique identifier of the updated module bay template.
  • device_type - The device type ID associated with the updated module bay template.
  • module_type - The module type ID associated with the updated module bay template.
  • name - The updated name of the module bay template.
  • label - The updated physical label of the module bay template.
  • position - The updated position identifier of the module bay template.
  • description - The updated description of the module bay template.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Module Bay Template ID is valid and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential has sufficient permissions to update module bay templates.
  • If the update fields are empty or invalid, the API may reject the request; ensure fields are correctly specified.
  • Common error messages include authentication failures, invalid resource IDs, or validation errors on update fields.

Links

Discussion