TejasNms icon

TejasNms

Consume TejasNms API (v.0.1.6)

Overview

The node "TejasNms" provides integration with the Tejas Network Management System (NMS) API, allowing users to manage network devices programmatically. Specifically, for the resource ONT and operation Set SSID and WiFi password, this node enables updating the SSID and WiFi password settings on an Optical Network Terminal (ONT) device identified by its serial number.

This operation is useful in scenarios such as:

  • Automating WiFi configuration changes across multiple ONT devices.
  • Resetting or updating WiFi credentials remotely without manual intervention.
  • Integrating network device management into broader automation workflows.

For example, a user can input the serial number of an ONT device and specify new SSID and password values for both 2.4 GHz and 5 GHz WiFi bands, and the node will apply these settings via the TejasNMS API.

Properties

Name Meaning
Serial Number The unique serial number identifying the ONT device to configure.
Additional Fields Optional fields to specify WiFi configurations:
- WiFi 2.4 Configuration for the 2.4 GHz WiFi band, including:
  SSID Config Status Status string related to SSID configuration (meaning depends on API).
  SSID The SSID name to set for the 2.4 GHz WiFi network.
  Password The password to set for the 2.4 GHz WiFi network.
- WiFi 5 Configuration for the 5 GHz WiFi band, including the same fields as WiFi 2.4: SSID Config Status, SSID, Password.

Output

The node outputs JSON data representing the result of the API call to set the SSID and WiFi password on the specified ONT device. This typically includes confirmation of success or failure, status messages, and any relevant response data from the TejasNMS API.

If the operation involves binary data (not indicated here), it would be summarized accordingly, but this operation appears to only handle JSON responses.

Dependencies

  • Requires an active connection to the TejasNMS API.
  • Needs an API authentication token or key configured in n8n credentials (referred generically as "an API key credential").
  • Uses internal HTTP client and state management classes to perform requests and handle responses.
  • No additional external services beyond the TejasNMS API are required.

Troubleshooting

  • Common issues:

    • Invalid or missing serial number: Ensure the serial number corresponds exactly to a registered ONT device.
    • Incorrect or incomplete WiFi configuration fields: Provide valid SSID and password strings where required.
    • Authentication failures: Verify that the API key credential is correctly configured and has sufficient permissions.
    • Network connectivity problems: Confirm that the n8n instance can reach the TejasNMS API endpoint.
  • Error messages:

    • Authentication errors likely indicate invalid or expired API credentials.
    • Validation errors may occur if required fields are missing or malformed.
    • API response errors should be checked for detailed messages returned by the TejasNMS service.

Resolving these usually involves verifying input parameters, checking credentials, and ensuring network access.

Links and References

Discussion