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 "TejasNms" node integrates with the TejasNms API to perform various operations on network resources, including Optical Network Terminals (ONTs). Specifically, the "Detect ONT State" operation allows users to query and retrieve the current state of an ONT device by providing its serial number. This is useful in network management scenarios where monitoring the status of ONTs is critical for troubleshooting, maintenance, or automation workflows.
Practical examples include:
- Automatically checking if a specific ONT is online or offline before triggering further actions.
- Gathering ONT state information as part of a larger network health dashboard.
- Integrating ONT state detection into alerting systems to notify operators of state changes.
Properties
| Name | Meaning |
|---|---|
| Serial Number | The unique serial number identifier of the ONT device whose state you want to detect. |
| Additional Information | Optional key-value pairs to provide extra context or parameters for the detection operation. Multiple fields can be added, each with a "Value Name" and corresponding "Value". |
Output
The node outputs JSON data representing the detected state of the specified ONT. This typically includes status indicators such as operational state, connectivity, alarms, or other relevant metadata returned by the TejasNms API.
If binary data is returned (not explicitly shown in the code), it would represent any associated files or raw data related to the ONT state, but this is not indicated in the provided source.
Dependencies
- Requires an active connection to the TejasNms API via an API authentication credential.
- The node depends on the
@digital-boss/n8n-designpatternspackage for resource-operation resolution and execution patterns. - Proper configuration of the API credentials within n8n is necessary to authenticate requests.
- The node uses internal helper classes for HTTP communication and state management.
Troubleshooting
Common Issues:
- Invalid or missing serial number will likely cause the API call to fail or return no data.
- Incorrect or expired API credentials will result in authentication errors.
- Network connectivity issues between n8n and the TejasNms API endpoint may cause timeouts or request failures.
Error Messages:
- Authentication errors usually indicate invalid API keys or misconfigured credentials; verify and update them accordingly.
- "Resource or operation not found" errors suggest incorrect resource or operation names; ensure "ont" and "detectOntState" are correctly selected.
- API response errors should be checked against the TejasNms API documentation for specific error codes and remedies.
Links and References
- TejasNms API Documentation (Replace with actual URL)
- n8n Documentation on Creating Custom Nodes
- General info on Optical Network Terminals (ONTs): https://en.wikipedia.org/wiki/Optical_network_terminal