Search Dattormm Devices icon

Search Dattormm Devices

Search for devices in Dattormm

Overview

This node allows users to search for devices within the Dattormm system using various filter criteria. It supports pagination and customizable data selection, enabling efficient retrieval of device information based on specific attributes such as device ID, UID, hostname, IP address, operating system, and more.

Common scenarios where this node is beneficial include:

  • Inventory management: Quickly find devices matching certain criteria to audit or update records.
  • Monitoring and reporting: Retrieve device statuses filtered by software or patch status.
  • Integration workflows: Use device data as input for further automation or analysis in n8n.

For example, a user could search for all devices running a particular operating system with pending patches, retrieving only relevant fields like hostname, IP address, and patch status.

Properties

Name Meaning
Device ID Filter results by a specific device's numeric ID.
UID Filter results by the unique string identifier (UID) of a device.
Site ID Filter results by the numeric ID of the site associated with the device.
Hostname Filter results by the device's hostname (string).
IP Address Filter results by the device's internal IP address (string).
Operating System Filter results by the device's operating system (string).
Device Class Filter results by the class/category of the device (string).
Software Status Filter results by the software status of the device (string).
Patch Status Filter results by the patch status of the device (string).
Page Specify the page number for paginated results (0-indexed).
Limit Number of results to return per page.
Data Selection Multiline string specifying which fields to return in the response. If left empty, defaults are used. Example fields include id, uid, hostname, intIpAddress, online, deviceClass.

Output

The node outputs two main items:

  1. Output (main):
    An array of objects containing:

    • devices: An array of device objects matching the query, each including the requested fields.
    • totalCount: Total number of devices matching the filters.
    • page: Current page number of the results.
    • limit: Number of results per page.

  2. Tool (ai_tool):
    A simplified array mapping the above output into a structure with keys:

    • devices (array of device data),
    • totalCount (number),
    • page (number),
    • limit (number).

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Dattormm GraphQL endpoint.
  • The node uses a GraphQL client base class internally to perform queries against the Dattormm API.
  • Users must configure the node with valid credentials and endpoint details to connect successfully.

Troubleshooting

  • Empty Results:
    Ensure that the filter criteria are correct and that the specified page and limit values are within valid ranges. Also verify that the API key has sufficient permissions.

  • Invalid Field Names in Data Selection:
    If custom fields are specified in the "Data Selection" property, ensure they match valid device field names supported by the API; otherwise, the query may fail.

  • API Authentication Errors:
    Check that the API key credential is correctly configured and has not expired or been revoked.

  • GraphQL Query Errors:
    These might occur if unsupported filters or invalid parameter types are provided. Review the input parameters carefully.

  • Pagination Issues:
    Remember that the page number is zero-indexed. Using negative numbers or excessively high page numbers may result in no data returned.

If the node is set to continue on failure, errors will be included in the output JSON under an error key instead of stopping execution.

Links and References

Discussion