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 resources and operations exposed by this API. Specifically, for the Alarm Retrieval resource and the Get Active Alarm operation, the node fetches active alarm data from the TejasNms system.
This node is beneficial in network management scenarios where monitoring and retrieving real-time alarm information is critical. For example, a network operator can use this node to periodically pull batches of active alarms, enabling automated alerting, dashboard updates, or further processing workflows based on current network conditions.
Properties
| Name | Meaning |
|---|---|
| Requested Batch Size | The number of active alarm records to retrieve in one batch. |
| Batch Sequence Number | The sequence number of the batch to retrieve, useful for paginating through alarm data. |
| Timestamp | A timestamp parameter to specify the point in time for which to retrieve active alarms. |
These properties are required inputs when using the "Get Active Alarm" operation under the "Alarm Retrieval" resource.
Output
The node outputs JSON data representing the retrieved active alarms from the TejasNms API. The structure typically includes an array of alarm objects containing details such as alarm identifiers, severity, timestamps, and other relevant metadata.
If the node supports binary data output (not explicitly shown in the provided code), it would likely relate to any associated alarm attachments or logs, but this is not evident from the static analysis.
Dependencies
- Requires an API key credential for authenticating with the TejasNms API.
- Depends on the
@digital-boss/n8n-designpatternspackage for resource-operation resolution and execution patterns. - Uses internal helper classes for HTTP requests and state management.
- No additional environment variables are indicated beyond the API credential.
Troubleshooting
- Authentication Errors: Ensure that the API key credential is correctly configured and has sufficient permissions to access alarm data.
- Pagination Issues: Incorrect values for "Batch Sequence Number" or "Requested Batch Size" may result in incomplete or empty results. Verify these parameters align with the API's pagination scheme.
- Timestamp Format: The "Timestamp" property expects a numeric value; providing an invalid timestamp could cause errors or unexpected results.
- API Connectivity: Network issues or incorrect endpoint configurations might lead to request failures. Check connectivity and credential validity.
Common error messages will likely relate to authentication failures, invalid parameters, or network timeouts. Reviewing the node's error output and ensuring correct input values usually resolves these issues.
Links and References
- TejasNms API Documentation (Not provided, but recommended to consult official API docs)
- n8n Documentation on Creating Custom Nodes
- @digital-boss/n8n-designpatterns GitHub Repository (for understanding resource-operation patterns)
Note: This summary is based solely on static analysis of the provided source code and input property definitions.