TejasNms icon

TejasNms

Consume TejasNms API (v.0.1.6)

Overview

This node, named "TejasNms," interacts with the TejasNms API to perform various operations related to network management. Specifically, for the resource ONT and operation Get ONT Using ONT's serial number, it retrieves detailed information about an Optical Network Terminal (ONT) device by using its unique serial number. This is useful in scenarios where you need to fetch device details for inventory management, troubleshooting, or monitoring purposes based on a known serial number.

Practical examples include:

  • Automatically fetching ONT device status or configuration during network audits.
  • Integrating with other workflows that require ONT details for validation or reporting.
  • Triggering alerts or updates when specific ONTs are identified by their serial numbers.

Properties

Name Meaning
Serial Number The unique serial number of the ONT device to retrieve information for. This is required.

Output

The node outputs JSON data containing the details of the ONT device corresponding to the provided serial number. The exact structure depends on the API response but typically includes fields such as device identifiers, status, configuration parameters, and possibly performance metrics.

If the node supports binary data output (not explicitly shown in the code), it would represent any associated files or raw data related to the ONT device, but this is not indicated here.

Dependencies

  • Requires an active connection to the TejasNms API via an API key credential configured in n8n.
  • Uses internal helper classes for HTTP requests, state management, and operation resolution/execution.
  • No additional external services beyond the TejasNms API are needed.

Troubleshooting

  • Common issues:

    • Invalid or missing serial number input will cause the API call to fail or return no results.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity problems can prevent successful communication with the TejasNms API.
  • Error messages:

    • Authentication failures usually indicate invalid API keys; verify and update credentials.
    • "Resource not found" or empty responses suggest the serial number does not exist in the system.
    • Timeout or connection errors imply network issues; check connectivity and API endpoint availability.

Links and References

Discussion