Actions21
- Alarm Retrieval Actions
- ONT Actions
- Detect ONT State
- Add ONT Using The Serial Number
- Get ONT Using ONT's serial number
- Update Customer ID on ONT
- Get Upstream Bandwidth Profile
- Get Downstream Bandwidth Profile
- Create Customer Service
- Get Service
- Delete Customer Service
- Deactivate and Delete ONT
- Deactivate and Delete Endpoint
- Add UNI in Multiple Services
- Set State
- Change Speed Profile
- Factory Reset
- Add subscriber service
- Enable Wi-Fi
- Set SSID and WiFi password
- Delete WiFi Config
- Modify ONT's Node Edge Point
Overview
The node "TejasNms" is designed to interact with the Tejas Network Management System (NMS) API, specifically versioned as indicated in the source. It provides operations on various resources related to network management, including ONT (Optical Network Terminal) devices.
For the ONT resource and the Get Downstream Bandwidth Profile operation, this node fetches downstream bandwidth profile data from the Tejas NMS. This is useful for network administrators who want to monitor or analyze bandwidth allocation and usage profiles on ONT devices within their network infrastructure.
Practical examples include:
- Retrieving bandwidth profiles to optimize traffic shaping.
- Monitoring downstream bandwidth allocations for troubleshooting or capacity planning.
- Integrating bandwidth profile data into dashboards or reports.
Properties
| Name | Meaning |
|---|---|
| Profile Type | The type of bandwidth profile to retrieve. This defines which specific downstream profile to query. |
| Size | The number of records to return in one request. Useful for pagination or limiting data volume. |
| Continue | An offset or continuation token to paginate through large sets of bandwidth profile data. |
These properties are required inputs when performing the Get Downstream Bandwidth Profile operation on the ONT resource.
Output
The node outputs JSON data representing the downstream bandwidth profiles retrieved from the Tejas NMS API. The structure typically includes details about each bandwidth profile such as profile identifiers, bandwidth parameters, and possibly status or configuration metadata.
If the node supports binary data output, it would relate to any raw data or files returned by the API, but based on the provided code and context, the primary output is structured JSON data.
Dependencies
- Requires an active connection to the Tejas NMS API via a configured API key credential.
- Uses internal HTTP client logic to communicate with the Tejas NMS backend.
- Depends on n8n's credential system to securely store and access the necessary API authentication tokens.
- No external environment variables are explicitly mentioned, but proper network access to the Tejas NMS endpoint is necessary.
Troubleshooting
Common issues:
- Authentication failures due to invalid or expired API credentials.
- Network connectivity problems preventing access to the Tejas NMS API.
- Pagination errors if
SizeandContinueparameters are misused or out of range. - Incorrect
Profile Typevalues leading to empty or error responses.
Error messages:
- Authentication errors usually indicate invalid API keys; verify and update credentials.
- Timeout or connection errors suggest network issues; check firewall and endpoint accessibility.
- API response errors may indicate unsupported profile types or malformed requests; validate input parameters carefully.
Links and References
- Tejas NMS Official Documentation (for detailed API and product info)
- n8n Documentation on Creating Custom Nodes
- General API Pagination Concepts: REST API Pagination