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" provides integration with the TejasNms API, allowing users to interact with various network management resources. Specifically, for the resource ONT and operation Get Upstream Bandwidth Profile, the node retrieves bandwidth profile information related to upstream data flow on an Optical Network Terminal (ONT). This is useful in scenarios where network administrators need to monitor or configure bandwidth allocation profiles for different types of traffic or devices connected via ONTs.
Practical examples include:
- Fetching current upstream bandwidth profiles for WiFi or other service types to analyze network performance.
- Automating bandwidth profile retrieval as part of a larger workflow for network diagnostics or reporting.
- Integrating bandwidth profile data into dashboards or alerting systems.
Properties
| Name | Meaning |
|---|---|
| Profile Type | The type of profile to retrieve. Options include "WiFi" and potentially others depending on the API's supported profile types. |
| Size | The number of records to fetch in one request, controlling pagination size. |
| Continue | A numeric offset or token used to continue fetching results from a previous request, enabling pagination through large datasets. |
Output
The node outputs JSON data representing the upstream bandwidth profiles retrieved from the TejasNms API. The structure typically includes details about each bandwidth profile such as identifiers, bandwidth limits, associated devices or services, and status information.
If the node supports binary data output, it would represent raw or encoded data related to the bandwidth profiles, but based on the provided code and properties, the primary output is structured JSON data.
Dependencies
- Requires an API key credential for authenticating with the TejasNms API.
- Depends on the
@digital-boss/n8n-designpatternspackage for response-operation resolution and execution patterns. - Uses internal helper classes for HTTP requests and state management.
- No additional environment variables are explicitly required beyond the API authentication credential.
Troubleshooting
- Authentication errors: Ensure that the API key credential is correctly configured and has sufficient permissions to access the ONT bandwidth profile endpoints.
- Pagination issues: If the
Continueparameter is not managed properly, the node might return incomplete data or repeat results. Use theContinuevalue returned from previous executions to paginate correctly. - Invalid Profile Type: Providing a profile type not supported by the API may result in errors or empty responses. Verify available profile types with the API documentation.
- Network connectivity: Failures in HTTP requests could be due to network issues or incorrect API endpoint configuration.
Links and References
- TejasNms API Documentation (Replace with actual URL if available)
- n8n Documentation on Creating Custom Nodes
- Pagination concepts in APIs: RFC 5988 Web Linking