TejasNms icon

TejasNms

Consume TejasNms API (v.0.1.6)

Overview

The node "TejasNms" provides integration with the TejasNms API, allowing users to interact with various resources and operations exposed by this system. Specifically, for the resource ONT and operation Set State, the node enables updating or setting the state of an Optical Network Terminal (ONT) device identified by its serial number. This is useful in network management scenarios where operators need to programmatically update the status or metadata of ONT devices within their infrastructure.

Practical examples include:

  • Changing the operational state of an ONT after maintenance.
  • Adding or updating location information or additional metadata fields related to a specific ONT.
  • Automating network inventory updates based on real-time data.

Properties

Name Meaning
Serial Number The unique identifier (serial number) of the ONT device whose state is to be set.
Additional Fields Optional extra information to associate with the ONT state update. Includes:
- Equipment Location A string specifying the physical or logical location of the equipment.
- Additional Information A collection of key-value pairs allowing multiple custom fields to be added as metadata.

Output

The node outputs JSON data representing the result of the Set State operation on the ONT resource. This typically includes confirmation of the updated state, any returned metadata, or error details if the operation failed.

If binary data were involved (not indicated here), it would represent files or attachments related to the ONT state, but this node appears focused on JSON-based state updates only.

Dependencies

  • Requires an active connection to the TejasNms API via an API authentication credential.
  • The node depends on internal helper classes for HTTP communication, state management, and operation resolution.
  • No external environment variables are explicitly required beyond the configured API credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing serial number: The node requires a valid serial number; ensure this is correctly provided.
    • Authentication failures: Verify that the API key or authentication token is correctly configured and has sufficient permissions.
    • Network connectivity problems: Ensure the n8n instance can reach the TejasNms API endpoint.
    • Incorrect additional fields format: When adding multiple additional information fields, ensure the structure matches the expected key-value pairs.
  • Error messages:

    • Authentication errors typically indicate invalid credentials; reconfigure the API key.
    • Validation errors may occur if required parameters like serial number are missing or malformed.
    • API response errors might indicate server-side issues or incorrect usage of the API; consult the API documentation for error codes.

Links and References

Discussion