NetBox icon

NetBox

Consume NetBox API

Actions243

Module Bay Template → Create

AI-generated

Overview

This node interacts with the NetBox API to create a new Module Bay Template within the DCIM domain. It is useful for automating the addition of module bay templates in network infrastructure management, allowing users to specify details such as the template name, device type, module type, label, position, and description. For example, a network administrator can use this node to programmatically add standardized module bay templates to their NetBox instance, improving consistency and efficiency.

Use Case Examples

  1. Creating a new module bay template named 'Standard Module {module}' for a specific device type and module type.
  2. Adding a module bay template with a custom label and position to organize device components.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for device and component management.
Module Bay Template Name The name of the module bay template to create, supports substitution with '{module}'.
Additional Fields Optional additional fields to specify details about the module bay template such as device type ID, module type ID, label, position, and description.

Output

JSON

  • id - Unique identifier of the created module bay template.
  • name - Name of the created module bay template.
  • device_type - ID of the device type associated with the template.
  • module_type - ID of the module type associated with the template.
  • label - Physical label of the module bay template.
  • position - Position identifier of the module bay template.
  • description - Description of the module bay template.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the API credentials are correctly configured and have permissions to create module bay templates in the DCIM domain.
  • Verify that the device type ID and module type ID provided in additional fields exist in the NetBox instance.
  • If the node throws an error, check the error message for details; enabling 'Continue on Fail' allows the workflow to proceed with error output.

Links

Discussion