NetBox icon

NetBox

Consume NetBox API

Actions243

Device Type → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific Device Type within the DCIM domain. It is useful for scenarios where you need to fetch detailed data about a device type by its ID, such as in network management, inventory tracking, or automation workflows involving hardware assets.

Use Case Examples

  1. Retrieve details of a device type by providing its unique ID to integrate with asset management systems.
  2. Fetch device type information to automate network documentation or configuration processes.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for device-related data.
Device Type ID The unique identifier of the device type to retrieve from the NetBox API.

Output

JSON

  • id - The unique identifier of the device type retrieved.
  • name - The name of the device type.
  • manufacturer - Information about the manufacturer of the device type.
  • model - The model designation of the device type.
  • slug - A URL-friendly identifier for the device type.
  • part_number - The part number associated with the device type.
  • u_height - The height of the device in rack units.
  • is_full_depth - Indicates if the device is full depth.
  • comments - Additional comments or notes about the device type.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Device Type ID is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential has sufficient permissions to access the DCIM domain and device types.
  • Check network connectivity to the NetBox API endpoint to prevent request failures.
  • Common error messages include authentication failures, resource not found, and permission denied. Resolving these involves verifying credentials, IDs, and user permissions.

Links

Discussion