NetBox icon

NetBox

Consume NetBox API

Actions243

Module Type Profile → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific Module Type Profile within the DCIM domain. It is useful for users who need to fetch detailed data about module type profiles in their network infrastructure managed by NetBox, such as for inventory management or configuration auditing.

Use Case Examples

  1. Retrieve details of a Module Type Profile by specifying its ID within the DCIM domain.
  2. Use the node to get module type profile information to integrate with other network management workflows.

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.
Module Type Profile ID The unique identifier of the module type profile to retrieve. This is required to specify which profile to get details for.

Output

JSON

  • id - The unique identifier of the retrieved module type profile.
  • name - The name of the module type profile.
  • manufacturer - Manufacturer details associated with the module type profile.
  • part_number - Part number of the module type profile.
  • description - Description of the module type profile.
  • created - Timestamp when the module type profile was created.
  • last_updated - Timestamp when the module type profile was last updated.

Dependencies

  • NetBox API with appropriate authentication credentials

Troubleshooting

  • Ensure the Module Type Profile ID is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API credentials provided have sufficient permissions to access the DCIM domain and module type profiles.
  • Check network connectivity to the NetBox API endpoint to prevent connection errors.

Links

Discussion