NetBox icon

NetBox

Consume NetBox API

Actions243

Module Type → Create

AI-generated

Overview

This node interacts with the NetBox API to create a new Module Type within the DCIM domain. It is useful for network administrators or IT professionals who want to automate the addition of module types to their NetBox inventory, ensuring consistent and efficient management of hardware components.

Use Case Examples

  1. Creating a new module type with a specified model name and manufacturer ID.
  2. Adding additional details such as part number, weight, description, comments, tags, and custom fields to a module type during creation.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management.
Model The model name of the module type to be created.
Manufacturer ID The ID of the manufacturer associated with the module type.
Additional Fields Optional additional details for the module type such as part number, weight, weight unit, description, comments, tags, and custom fields.

Output

JSON

  • id - Unique identifier of the created module type
  • model - Model name of the created module type
  • manufacturer - Manufacturer ID associated with the module type
  • part_number - Part number of the module type if provided
  • weight - Weight of the module type if provided
  • weight_unit - Unit of weight measurement if provided
  • description - Description of the module type if provided
  • comments - Comments about the module type if provided
  • tags - Tags associated with the module type if provided
  • custom_fields - Custom fields associated with the module type if provided

Dependencies

  • NetBox API
  • An API key credential for authenticating with the NetBox API

Troubleshooting

  • Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
  • Validation errors may occur if required fields like model or manufacturer ID are missing or invalid. Verify all required inputs are provided and correctly formatted.
  • Network connectivity issues can prevent the node from reaching the NetBox API endpoint. Check network settings and API availability.

Links

  • NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and data models.

Discussion