NetBox icon

NetBox

Consume NetBox API

Actions243

Module Type Profile → Create

AI-generated

Overview

This node interacts with the NetBox API to create a new Module Type Profile within the DCIM domain. It is useful for network administrators or IT professionals who want to automate the creation and management of module type profiles in their NetBox instance. For example, it can be used to add new module type profiles with specific names, descriptions, tags, and custom fields programmatically, streamlining infrastructure management.

Use Case Examples

  1. Creating a new module type profile named 'High Density Module' with a description and tags for categorization.
  2. Automating the addition of module type profiles with custom JSON fields for enhanced metadata management.

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.
Name The name of the module type profile to be created.
Additional Fields Optional additional fields for the module type profile, including description, tags, and custom fields in JSON format.

Output

JSON

  • id - Unique identifier of the created module type profile.
  • name - Name of the created module type profile.
  • description - Description of the module type profile if provided.
  • tags - Tags associated with the module type profile.
  • custom_fields - Custom fields data in JSON format.

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 'Name' are missing or if the JSON in custom fields is malformed. Verify input data before execution.
  • 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 structures.

Discussion