TejasNms icon

TejasNms

Consume TejasNms API (v.0.1.6)

Overview

The node "TejasNms" provides integration with the Tejas Network Management System (NMS) API, specifically versioned as indicated in the source. It allows users to perform various operations on network resources managed by Tejas NMS.

For the resource ONT and operation Add subscriber service, this node enables adding a subscriber service configuration to an Optical Network Terminal (ONT) device identified by its serial number. This is useful in scenarios where network administrators need to provision or update subscriber services on ONTs remotely via automation workflows.

Practical examples include:

  • Automatically provisioning new subscriber services when onboarding customers.
  • Updating service parameters for existing ONTs based on dynamic workflow inputs.
  • Integrating with other systems to synchronize subscriber configurations.

Properties

Name Meaning
Serial Number The unique serial number identifying the ONT device to which the subscriber service will be added. This is a required string input.
Additional Fields Optional collection of additional parameters to customize the subscriber service. These include:
- Config Name
- WAN State
- IP Option
- Protocol Mode
- Username
- Password
- Svc Name
- Vlan ID
- Priority Bit
- TP ID
- Nat
- Igmp State
- Authentication Method
- WAN Connection Status
- Firewall State

These additional fields allow fine-tuning of the subscriber service settings according to specific network requirements.

Output

The node outputs JSON data representing the result of the add subscriber service operation. This typically includes confirmation details such as success status, any identifiers returned by the API, and possibly error messages if the operation failed.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API key credential for authenticating with the Tejas NMS API.
  • Depends on the external Tejas NMS API service being accessible.
  • Uses internal helper classes for HTTP requests, state management, and operation resolution.
  • No environment variables are explicitly mentioned, but proper credential setup in n8n is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing serial number causing the API to reject the request.
    • Incorrect or incomplete additional fields leading to configuration errors.
    • Network connectivity problems preventing access to the Tejas NMS API.
    • Authentication failures due to invalid or expired API credentials.
  • Error messages:

    • Errors from the API will likely be passed through in the JSON output; these should be reviewed to identify misconfigurations.
    • Credential-related errors require checking the API key setup in n8n.
    • Timeout or connection errors suggest network or endpoint availability issues.

To resolve issues:

  • Verify that the serial number corresponds to a valid ONT device.
  • Ensure all required fields are correctly filled.
  • Confirm that the API credentials are valid and have sufficient permissions.
  • Check network connectivity and API endpoint accessibility.

Links and References

Discussion