TejasNms icon

TejasNms

Consume TejasNms API (v.0.1.6)

Overview

The node "TejasNms" interacts with the TejasNms API to perform various operations on network management resources. Specifically, for the Resource "ONT" and Operation "Deactivate and Delete ONT," this node allows users to deactivate and remove an Optical Network Terminal (ONT) device from the system by specifying its serial number.

This operation is useful in scenarios where an ONT device is no longer in use, needs to be removed from the network inventory, or requires deactivation due to maintenance or replacement. For example, a network administrator can automate the removal of decommissioned ONTs from the network management system to keep the inventory up to date.

Properties

Name Meaning
Serial Number The unique serial number identifier of the ONT device to be deactivated and deleted.

Output

The node outputs JSON data representing the result of the deactivate and delete operation on the specified ONT. This typically includes confirmation of success or failure, status messages, and any relevant metadata returned by the TejasNms API.

If the operation involves binary data (not indicated here), it would represent related files or device-specific data, but based on the provided code and properties, the output is JSON structured.

Dependencies

  • Requires an active connection to the TejasNms API.
  • Needs an API authentication credential configured in n8n (referred to generically as an API key credential).
  • Uses internal helper classes for HTTP requests, state management, and resource-operation resolution.
  • No additional external services beyond the TejasNms API are indicated.

Troubleshooting

  • Common Issues:

    • Invalid or missing serial number: Ensure the serial number is correctly provided and corresponds to an existing ONT.
    • Authentication failures: Verify that the API credentials are valid and have sufficient permissions.
    • Network connectivity problems: Confirm that the n8n instance can reach the TejasNms API endpoint.
  • Error Messages:

    • Errors related to authorization usually indicate invalid or expired API credentials.
    • Errors about resource not found suggest the serial number does not match any ONT in the system.
    • Timeout or connection errors imply network issues or API unavailability.

Resolving these typically involves checking input parameters, refreshing credentials, and ensuring network access.

Links and References

Discussion