NetBox icon

NetBox

Consume NetBox API

Actions243

Module Type → List

AI-generated

Overview

This node interacts with the NetBox API to list module types within the DCIM domain. It is useful for retrieving information about different module types available in a data center infrastructure management context. For example, users can fetch a list of module types filtered by specific criteria such as module type ID, model name, manufacturer ID, or part number, and control the number of results returned.

Use Case Examples

  1. Retrieve all module types without limit.
  2. Retrieve up to 50 module types with specific filters like manufacturer ID or model name.

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 results to return when 'Return All' is false.
Filters Filters to narrow down the list of module types based on criteria such as module type ID, model name, manufacturer ID, or part number.

Output

JSON

  • id - Unique identifier of the module type.
  • model - Model name of the module type.
  • manufacturer_id - Identifier of the manufacturer associated with the module type.
  • part_number - Part number of the module type.
  • other_properties - Additional properties returned by the NetBox API for each module type.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the NetBox API credentials are correctly configured and have the necessary permissions to access the DCIM domain and module types resource.
  • If the node returns an error, check the filter values for correctness and compatibility with the NetBox API.
  • If 'Return All' is set to false and the limit is too low, you might not get all desired results; adjust the limit accordingly.
  • Network connectivity issues to the NetBox API endpoint can cause failures; verify network access and API availability.

Links

Discussion