NetBox icon

NetBox

Consume NetBox API

Actions243

Device → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific device within the DCIM domain. It is useful for scenarios where you need to fetch detailed data about a device by its ID from the NetBox infrastructure management system, such as in network automation, asset management, or monitoring workflows.

Use Case Examples

  1. Retrieve device details by providing the device ID in the DCIM domain to integrate with network management systems.
  2. Fetch device information to update or audit network inventory automatically.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, e.g., DCIM, IPAM, Tenancy, etc.
Device ID The unique identifier of the device to retrieve from the DCIM domain.

Output

JSON

  • id - The unique identifier of the device retrieved.
  • name - The name of the device.
  • status - The current status of the device.
  • device_type - Details about the type of the device.
  • site - Information about the site where the device is located.
  • rack - Rack details where the device is mounted.
  • serial - Serial number of the device.
  • asset_tag - Asset tag associated with the device.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Device ID is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential is valid and has sufficient permissions to access device data.
  • Check network connectivity to the NetBox API endpoint to prevent request failures.
  • If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message as JSON.

Links

Discussion