TejasNms icon

TejasNms

Consume TejasNms API (v.0.1.6)

Overview

The node "TejasNms" integrates with the TejasNms API to perform various operations on network management resources. Specifically, for the resource ONT and operation Update Customer ID on ONT, it allows users to update attributes related to an Optical Network Terminal (ONT) device in the network.

This node is beneficial in scenarios where network administrators or automation workflows need to programmatically modify ONT configurations, such as updating customer identifiers or other metadata associated with ONTs. For example, when a customer changes their subscription or moves to a different service plan, this node can update the relevant ONT attributes accordingly without manual intervention.

Properties

Name Meaning
Attributes A collection of attribute entries to update on the ONT. Each entry includes:
- Uuid: The unique identifier of the attribute to update.
- Attribute Value: One or more name-value pairs specifying the new values for the attribute.

The Attributes property supports multiple entries, allowing batch updates of several attributes at once. Each attribute value itself can contain multiple fields, each with a "Value Name" and corresponding "Value".

Output

The node outputs JSON data representing the result of the update operation performed on the ONT resource. This typically includes confirmation of updated attributes, status messages, or error details if the update failed.

If the node supports binary data output, it would relate to any raw response or files returned by the API, but based on the provided code and properties, the primary output is structured JSON reflecting the operation's outcome.

Dependencies

  • Requires an API key credential for authenticating with the TejasNms API.
  • Depends on the @digital-boss/n8n-designpatterns package for resource-operation resolution and execution patterns.
  • Uses internal helper classes for HTTP requests, state management, and operation handling.
  • No additional external services beyond the TejasNms API are indicated.

Troubleshooting

  • Authentication Errors: If the API key credential is missing or invalid, the node will fail to authenticate. Ensure the correct API key is configured in n8n credentials.
  • Invalid Attribute UUIDs: Providing incorrect or non-existent UUIDs in the attributes may cause the API to reject the update. Verify UUIDs before running the node.
  • Malformed Attribute Values: The attribute values must be correctly structured as name-value pairs. Improper formatting could lead to errors.
  • API Connectivity Issues: Network problems or incorrect endpoint configuration can prevent successful communication with the TejasNms API.
  • Operation Not Supported: Using unsupported combinations of resource and operation parameters might trigger fallback logic or errors.

To resolve these issues, check credentials, validate input data formats, and ensure network connectivity to the TejasNms API endpoint.

Links and References


Note: The summary is based solely on static analysis of the provided source code and property definitions.

Discussion