TejasNms icon

TejasNms

Consume TejasNms API (v.0.1.6)

Overview

The node "TejasNms" integrates with the TejasNms API to manage network elements. Specifically, the operation Add ONT Using The Serial Number allows users to add an Optical Network Terminal (ONT) device by specifying its serial number along with various configuration and provisioning details.

This node is beneficial in scenarios where network administrators need to automate the onboarding of ONT devices into their network management system using serial numbers as unique identifiers. For example, when deploying new ONTs in a fiber optic network, this operation can streamline the provisioning process by programmatically sending all necessary data to the backend system.

Properties

Name Meaning
Preprovision Data A collection of detailed provisioning parameters for the ONT device, including:
- Eth Circuitpack Preprovision Data Contains Node Edge Point Count (number) related to Ethernet circuit pack preprovisioning.
- Id Numeric identifier for the ONT or provisioning context.
- Ont Mode String indicating the mode or type of the ONT device.
- Serial Number The unique serial number string of the ONT device to be added.
- Location String describing the physical or logical location of the ONT.
- Pots Circuitpack Preprovision Data Contains Node Edge Point Count (number) related to POTS circuit pack preprovisioning.
- Pon Node Edge Point Ref Collection referencing PON node edge points, including nested properties:
- Node Contains Name (string) of the node.
- Node Edge Point Contains Ci Si Pn (string) and Is Lct (string) properties related to the node edge point.
- Upstream Mapping Type String defining the upstream mapping type for the ONT.
- Pbit Control String controlling priority bits or QoS settings.

Output

The node outputs JSON data representing the result of the Add ONT operation. This typically includes confirmation of the ONT addition, any assigned identifiers, status messages, or error information returned from the TejasNms API.

If the node supports binary data output (not explicitly shown in the provided code), it would represent any associated files or raw data returned by the API, but based on the static analysis, the primary output is structured JSON.

Dependencies

  • Requires 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 indicated.

Troubleshooting

  • Common Issues:

    • Invalid or missing serial number may cause the API to reject the request.
    • Incorrect or incomplete preprovision data fields could lead to validation errors.
    • Network connectivity issues or invalid API credentials will prevent successful communication.
  • Error Messages:

    • Authentication failures indicate problems with the API key or credential setup.
    • Validation errors from the API usually specify which input property is incorrect or missing.
    • Timeout or network errors suggest connectivity problems; verify endpoint accessibility.

To resolve these, ensure all required fields are correctly filled, credentials are valid, and the network connection to the TejasNms API is stable.

Links and References

Discussion