TejasNms icon

TejasNms

Consume TejasNms API (v.0.1.6)

Overview

The TejasNms node provides integration with the Tejas Network Management System (NMS) API, allowing users to interact programmatically with network resources managed by Tejas NMS. Specifically, for the ONT resource and the Get Service operation, this node fetches service-related information from an Optical Network Terminal (ONT). This is useful in scenarios where network administrators or automation workflows need to retrieve detailed service configurations or statuses of ONTs within a network.

Practical examples include:

  • Automatically retrieving service details for an ONT to monitor its configuration state.
  • Fetching specific service attributes such as user labels or service names for reporting or auditing.
  • Integrating with other systems that require up-to-date ONT service data without manual intervention.

Properties

Name Meaning
Additional Fields Optional parameters to refine or filter the service retrieval. Possible fields include:
- Config State Whether to include the configuration state (default: "true").
- Continue Pagination continuation token or offset (default: "0").
- Cs Type Circuit switch type, e.g., "Ethernet" (default: "Ethernet").
- Size Number of records to retrieve (default: "10").
- Service Name Filter by specific service name (string).
- User Label Filter by user label associated with the service (string).
- Fields Comma-separated list of specific fields to return, e.g., "uuid,endpoints".

These additional fields allow fine-tuning the query to the Tejas NMS API when fetching ONT service data.

Output

The node outputs JSON data representing the retrieved ONT service information. The structure typically includes service details such as identifiers, endpoints, configuration states, labels, and other metadata depending on the requested fields.

If binary data were involved (not indicated here), it would represent raw service-related files or attachments, but this node focuses on JSON service data.

Dependencies

  • Requires an active connection to the Tejas NMS API via an API key credential configured in n8n.
  • Uses internal HTTP client utilities to communicate with the Tejas NMS backend.
  • No external dependencies beyond the Tejas NMS API and the provided credentials.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect or unsupported values in additional fields may result in API errors or empty responses.
    • Network connectivity issues between n8n and the Tejas NMS server can cause request timeouts or failures.
  • Error Messages:

    • Authentication errors typically indicate invalid API keys or expired tokens; verify and update credentials.
    • Validation errors on input fields suggest incorrect parameter formats; ensure fields like "Size" are numeric strings.
    • API response errors might indicate server-side problems or misconfigured requests; check the Tejas NMS API documentation and logs.

Links and References

Discussion