TejasNms icon

TejasNms

Consume TejasNms API (v.0.1.6)

Overview

This node integrates with the TejasNms API to perform various operations on network resources. Specifically, for the "ONT" resource and the "Modify ONT's Node Edge Point" operation, it allows users to update properties of a Node Edge Point associated with an Optical Network Terminal (ONT). This is useful in network management scenarios where administrators need to modify configuration or metadata related to ONT endpoints dynamically.

Practical examples include:

  • Updating additional metadata fields on a Node Edge Point to reflect changes in network topology or status.
  • Correcting or enriching information stored about a Node Edge Point without replacing the entire ONT record.

Properties

Name Meaning
UUID The unique identifier of the ONT whose Node Edge Point is to be modified.
Node Edge Point A collection of additional information fields to update on the Node Edge Point. Each field consists of:
- Value Name: The name/key of the property to set.
- Value: The corresponding value to assign. Multiple such fields can be provided.

Output

The node outputs JSON data representing the result of the modification operation performed on the ONT's Node Edge Point. This typically includes confirmation of the updated fields or the updated state of the Node Edge Point after modification.

If the operation involves binary data (not indicated here), it would represent files or attachments related to the Node Edge Point, but this node primarily deals with JSON structured data.

Dependencies

  • Requires connection to the TejasNms API via an API key credential configured in n8n.
  • Uses internal HTTP client logic to communicate with the TejasNms backend.
  • Depends on the TejasNms API being accessible and the credentials having sufficient permissions to modify ONT resources.

Troubleshooting

  • Invalid UUID: If the UUID provided does not correspond to an existing ONT, the API will likely return an error indicating the resource was not found. Verify the UUID is correct.
  • Insufficient Permissions: Errors related to authorization may occur if the API key lacks rights to modify ONT data. Ensure the API key has appropriate scopes.
  • Malformed Additional Information: Providing improperly structured additional information fields (e.g., missing value names or values) may cause the request to fail validation.
  • Network Issues: Connectivity problems between n8n and the TejasNms API can cause timeouts or failed requests. Check network access and API endpoint availability.

Links and References

Discussion