NetBox icon

NetBox

Consume NetBox API

Actions243

Module Type Profile → List

AI-generated

Overview

This node interacts with the NetBox API to list module type profiles within the DCIM domain. It is useful for users who want to retrieve information about module type profiles, such as their names, IDs, creation dates, and other attributes, from their NetBox instance. Practical examples include automating inventory management, auditing module types, or integrating NetBox data into other systems.

Use Case Examples

  1. Retrieve all module type profiles from the DCIM domain to display in a dashboard.
  2. Filter module type profiles by name or creation date to generate reports.
  3. Limit the number of module type profiles returned for performance optimization.

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.
Return All Determines whether to return all results or limit the number of results.
Limit Maximum number of module type profiles to return when 'Return All' is false.
Filters Collection of filters to refine the list of module type profiles, including search query, name, ID, ordering, and date filters.

Output

JSON

  • id - Unique identifier of the module type profile.
  • name - Name of the module type profile.
  • description - Description of the module type profile.
  • created - Creation date of the module type profile.
  • last_updated - Last updated date of the module type profile.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
  • Incorrect domain or resource selection may result in no data or errors. Verify that the domain is set to 'dcim' and resource to 'module-type-profiles' for this operation.
  • Filters must be correctly formatted; invalid filter values may cause the API to reject the request.
  • If 'Return All' is false and 'Limit' is set too low, the returned data may be incomplete. Adjust the limit or enable 'Return All' as needed.

Links

Discussion