NetBox icon

NetBox

Consume NetBox API

Actions243

Manufacturer → List

AI-generated

Overview

This node interacts with the NetBox API to list manufacturers within the DCIM domain. It is useful for retrieving manufacturer data from a NetBox instance, which can be applied in network infrastructure management, asset tracking, or inventory systems. For example, a user can fetch all manufacturers or filter them by specific criteria such as ID, name, slug, description, or tag.

Use Case Examples

  1. Retrieve all manufacturers in the DCIM domain to populate a network device inventory.
  2. Filter manufacturers by name or tag to find specific vendor information.

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 manufacturer results or limit the number of results.
Limit Maximum number of manufacturer results to return when 'Return All' is false.
Filters Optional filters to narrow down the list of manufacturers by ID, name, slug, description, or tag.

Output

JSON

  • id - Unique identifier of the manufacturer.
  • name - Name of the manufacturer.
  • slug - Slug (URL-friendly identifier) of the manufacturer.
  • description - Description of the manufacturer.
  • tag - Tag associated with the manufacturer.

Dependencies

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

Troubleshooting

  • If the node returns an error, check that the API key credential is valid and has sufficient permissions to access the manufacturers resource.
  • Ensure the domain is set to 'dcim' as manufacturers are part of the DCIM domain in NetBox.
  • If filtering by fields like name or slug, verify the filter values are correct and exist in the NetBox instance.
  • If 'Return All' is false and no results are returned, try increasing the 'Limit' value.

Links

Discussion