NetBox icon

NetBox

Consume NetBox API

Actions243

Device Bay Template → Create

AI-generated

Overview

This node interacts with the NetBox API to create a new Device Bay Template within the DCIM domain. It is useful for network and data center administrators who want to automate the creation of device bay templates in NetBox, which helps in managing physical device bays in device types. For example, it can be used to programmatically add templates for device bays to standardize hardware configurations across multiple devices.

Use Case Examples

  1. Creating a device bay template named 'Module Bay {module}' for a specific device type ID in the DCIM domain.
  2. Adding a device bay template with a physical label and description to document hardware layout.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for data center infrastructure management.
Device Type ID The unique identifier of the device type to which the device bay template will be associated.
Device Bay Template Name The name of the device bay template. Supports substitution of '{module}' to dynamically insert module names.
Additional Fields Optional additional properties for the device bay template, including 'Label' (physical label of the device bay) and 'Description' (description of the device bay template).

Output

JSON

  • id - The unique identifier of the created device bay template in NetBox.
  • name - The name of the created device bay template.
  • device_type - The device type ID associated with the device bay template.
  • label - The physical label of the device bay template, if provided.
  • description - The description of the device bay template, if provided.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the Device Type ID is valid and exists in the NetBox instance to avoid errors.
  • Verify that the API credentials have sufficient permissions to create device bay templates in the DCIM domain.
  • If the node throws an error, check the error message for details; enabling 'Continue on Fail' allows the workflow to proceed with error output.

Discussion