TejasNms icon

TejasNms

Consume TejasNms API (v.0.1.6)

Overview

The "TejasNms" node integrates with the TejasNms API, enabling users to perform various network management operations. Specifically, for the ONT resource and the "Enable Wi-Fi" operation, this node allows enabling Wi-Fi functionality on an Optical Network Terminal (ONT) device by specifying its serial number and optional Wi-Fi configuration details.

This node is beneficial in scenarios where network administrators need to remotely manage ONT devices, such as enabling or configuring Wi-Fi access on customer premises equipment without manual intervention. For example, after provisioning a new ONT, an admin can use this node to enable Wi-Fi bands (2.4 GHz and/or 5 GHz) and set their SSID configuration status programmatically.

Properties

Name Meaning
Serial Number The unique identifier of the ONT device on which to enable Wi-Fi. This is a required field.
Additional Fields Optional nested fields to specify Wi-Fi band configurations:
- WiFi 2.4 Configuration options for the 2.4 GHz Wi-Fi band.
-- SSID Config Status Status string indicating the SSID configuration state for the 2.4 GHz band.
- WiFi 5 Configuration options for the 5 GHz Wi-Fi band.
-- SSID Config Status Status string indicating the SSID configuration state for the 5 GHz band.

Output

The node outputs JSON data representing the result of the "Enable Wi-Fi" operation on the specified ONT device. This typically includes confirmation of the action taken, status messages, or any returned data from the TejasNms API related to enabling Wi-Fi.

If the operation involves binary data (not indicated in the provided code), it would represent relevant device configuration files or logs; however, based on the static analysis, the output is JSON structured.

Dependencies

  • Requires an active connection to the TejasNms API via an API key credential.
  • The node depends on internal helper classes for HTTP requests, state management, and operation resolution/execution.
  • No additional external services beyond the TejasNms API are indicated.
  • Proper configuration of the API authentication token or key within n8n credentials is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing serial number will likely cause the API call to fail.
    • Incorrect or expired API credentials will prevent successful communication with the TejasNms API.
    • Providing invalid values in the SSID Config Status fields may lead to errors or ignored settings.
  • Error Messages:

    • Authentication errors usually indicate issues with the API key credential; verify and update as needed.
    • Validation errors on input properties suggest missing required fields or incorrect formats.
    • Network or timeout errors imply connectivity problems with the TejasNms API endpoint.

To resolve these, ensure all required inputs are correctly filled, credentials are valid, and network connectivity is stable.

Links and References

Discussion