TejasNms icon

TejasNms

Consume TejasNms API (v.0.1.6)

Overview

The node "TejasNms" provides an interface to interact with the TejasNms API, specifically for managing network elements such as ONTs (Optical Network Terminals). The "Factory Reset" operation under the ONT resource allows users to reset one or more ONTs to their factory default settings. This is useful in scenarios where devices need to be restored to a clean state, for example, before redeployment, troubleshooting persistent issues, or clearing configurations.

Practical examples:

  • A network administrator wants to reset multiple ONTs identified by their serial numbers after a firmware upgrade failed.
  • Automated workflows that prepare ONTs for reassignment by wiping previous configurations.

Properties

Name Meaning
Serial Numbers A collection of serial numbers identifying the ONTs to be factory reset. Each entry requires specifying the "Serial Number" string value. Multiple serial numbers can be provided.

Output

The node outputs JSON data representing the result of the factory reset operation for each specified ONT. The exact structure depends on the API response but typically includes status information indicating success or failure per device.

If the node supports binary data output, it would represent any associated files or logs returned by the API, but this is not evident from the static code.

Dependencies

  • Requires an active connection to the TejasNms API via an API key credential configured in n8n.
  • Uses internal HTTP client and state management classes to handle requests and responses.
  • No external environment variables are explicitly required beyond the API credentials.

Troubleshooting

  • Common Issues:

    • Invalid or missing serial numbers may cause the API to reject the request.
    • Network connectivity problems to the TejasNms API endpoint.
    • Insufficient permissions or invalid API credentials leading to authentication errors.
  • Error Messages:

    • Authentication failures: Verify the API key credential is correctly set up.
    • Validation errors on serial numbers: Ensure all serial numbers are correctly formatted strings.
    • Timeout or network errors: Check network access and API availability.

Resolving these usually involves verifying input parameters, checking credential validity, and ensuring network connectivity.

Links and References

  • TejasNms API documentation (not provided here; consult your vendor's official docs)
  • n8n documentation on creating and using API credentials
  • General best practices for factory resetting network devices

Discussion