TejasNms icon

TejasNms

Consume TejasNms API (v.0.1.6)
Join our community

Actions21

Overview

This node integrates with the TejasNms API to manage Optical Network Terminals (ONTs), specifically allowing users to add a User Network Interface (UNI) across multiple connectivity services. It is useful in telecommunications network management scenarios where operators need to configure or update multiple service endpoints on an ONT simultaneously.

Typical use cases include:

  • Provisioning new UNIs on an ONT for multiple services at once.
  • Automating bulk configuration changes to ONTs in a network.
  • Streamlining network operations by managing multiple connectivity services in a single operation.

For example, a network operator can use this node to add a UNI that connects several Ethernet services with specific VLAN configurations and bandwidth profiles, all in one execution step.

Properties

Name Meaning
Connectivity Services A collection of multiple connectivity service entries to which the UNI will be added. Each entry includes:
- UUID The unique identifier of the connectivity service.
- End Point One or more end points associated with the connectivity service. Each end point contains:
-- Name Multiple key-value pairs representing the name attributes of the end point.
-- Layer Protocol Name The protocol layer name used for the end point.
-- Nrp Carrier Eth Connectivity End Point Resource Contains detailed Ethernet connectivity settings including:
--- Ce Vlan Id List And Untag VLAN IDs (multiple allowed), VLAN ID mapping type, and whether untagged and priority tagged frames are included.
--- Cos Identifier List List of Class of Service (CoS) names associated with the end point.
-- Upstream Bandwidth Profile UUID reference to the upstream bandwidth profile applied to the end point.
-- Downstream Bandwidth Profile UUID reference to the downstream bandwidth profile applied to the end point.
-- Additional Information Arbitrary key-value pairs for any extra metadata or parameters related to the end point.
- Name The name of the connectivity service.

This structure allows detailed specification of multiple connectivity services and their respective end points, VLAN configurations, bandwidth profiles, and additional metadata when adding a UNI.

Output

The node outputs JSON data representing the result of the "Add UNI in Multiple Services" operation. This typically includes confirmation details such as identifiers of created or updated UNIs, status messages, and any relevant metadata returned by the TejasNms API.

If the operation involves binary data (not indicated in the provided code or properties), it would represent files or raw data related to the ONT configuration, but no explicit binary output is described here.

Dependencies

  • Requires an active connection to the TejasNms API via an API authentication token or key credential configured in n8n.
  • Uses internal HTTP client utilities to communicate with the TejasNms backend.
  • Depends on the TejasNms API version specified in the node (v. from bundled source).
  • No other external services or environment variables are explicitly required beyond the API credentials.

Troubleshooting

  • Authentication Errors: If the API key or token is invalid or missing, the node will fail to authenticate. Ensure the correct API credentials are configured in n8n.
  • Invalid UUIDs: Providing incorrect or non-existent UUIDs for connectivity services or bandwidth profiles may cause errors. Verify UUID values before execution.
  • Malformed Input: The complex nested structure for connectivity services and end points must follow the expected schema. Missing required fields or incorrect types can lead to request failures.
  • API Limitations: The TejasNms API might impose rate limits or restrictions on simultaneous modifications; hitting these limits could cause errors.
  • Network Issues: Connectivity problems between n8n and the TejasNms API endpoint will prevent successful execution.

Common error messages will likely relate to authentication failure, validation errors on input data, or HTTP request failures. Reviewing the API response messages and ensuring compliance with the expected input format will help resolve issues.

Links and References

Discussion