NetBox icon

NetBox

Consume NetBox API

Actions243

Device Type → List

AI-generated

Overview

This node interacts with the NetBox API to list device types within the DCIM domain. It is useful for retrieving detailed information about various device types managed in NetBox, such as models, manufacturers, and physical attributes. Practical applications include inventory management, asset tracking, and integration with other IT management systems.

Use Case Examples

  1. List all device types in the DCIM domain to get an overview of available hardware models.
  2. Filter device types by manufacturer or model to find specific equipment.
  3. Retrieve device types with certain physical characteristics, such as height or presence of console ports.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for device-related data.
Return All Determines whether to return all results or limit the number of results.
Limit Maximum number of device types to return when 'Return All' is false.
Filters Collection of filters to narrow down the list of device types based on various attributes such as ID, model, manufacturer, physical features, and tags.

Output

JSON

  • id - Unique identifier of the device type.
  • model - Model name of the device type.
  • slug - Slug identifier for the device type.
  • part_number - Part number associated with the device type.
  • manufacturer - Manufacturer details of the device type.
  • console_ports - Indicates if the device type has console ports.
  • console_server_ports - Indicates if the device type has console server ports.
  • power_ports - Indicates if the device type has power ports.
  • power_outlets - Indicates if the device type has power outlets.
  • interfaces - Indicates if the device type has interfaces.
  • pass_through_ports - Indicates if the device type has pass-through ports.
  • device_bays - Indicates if the device type has device bays.
  • tag - Tags associated with the device type.
  • u_height - Rack height in units for the device type.
  • is_full_depth - Indicates if the device type consumes both front and rear rack faces.
  • subdevice_role - Role of the device type as parent or child subdevice.

Dependencies

  • NetBox API
  • API key credential for authentication

Troubleshooting

  • Ensure the API key credential is correctly configured and has sufficient permissions to access the DCIM domain and device types resource.
  • If the node returns an error, check the network connectivity to the NetBox API endpoint.
  • Verify that the filter values are valid and correctly formatted to avoid API errors.
  • If 'Return All' is set to false, ensure the 'Limit' value is a positive integer to avoid unexpected results.

Links

Discussion