TejasNms icon

TejasNms

Consume TejasNms API (v.0.1.6)
Join our community

Actions21

Overview

The node "TejasNms" provides integration with the TejasNms API, specifically supporting operations on various resources including ONT (Optical Network Terminal). The "Change Speed Profile" operation under the ONT resource allows users to modify the speed profile settings of a specific service endpoint. This is useful in network management scenarios where bandwidth profiles or connectivity parameters need to be updated dynamically for services provisioned on an ONT device.

Practical examples include:

  • Adjusting upstream bandwidth profiles for a customer’s service endpoint to accommodate changing usage patterns.
  • Updating VLAN tagging and priority settings on connectivity endpoints to optimize traffic handling.
  • Adding additional metadata or configuration information related to the endpoint.

Properties

Name Meaning
Services UUID The unique identifier of the service whose speed profile is to be changed. Required to specify which service is targeted.
Services Endpoint UUID The unique identifier of the specific endpoint within the service that will have its speed profile changed.
End Point A collection of detailed settings for the endpoint, including:
- Layer Protocol Name The name of the layer protocol associated with the endpoint (e.g., Ethernet, IP).
- Upstream Bandwidth Profile Contains the UUID of the upstream bandwidth profile to apply, allowing bandwidth allocation changes.
- Nrp Carrier Eth Connectivity End Point Resource Nested collection describing Ethernet connectivity details such as VLAN IDs and priority tagging:
-- Ce Vlan Id List And Untag List of VLAN IDs with options for untagged and priority-tagged inclusion, specifying how VLANs are handled on this endpoint.
-- Cos Identifier List List of Class of Service (CoS) names defining traffic prioritization classes applied to the endpoint.
- Additional Information Arbitrary key-value pairs for extra metadata or configuration parameters related to the endpoint.

Output

The node outputs JSON data representing the result of the "Change Speed Profile" operation. This typically includes confirmation of the updated speed profile settings, status messages, or error details if the operation failed. The exact structure depends on the API response but generally reflects the new state of the service endpoint after applying changes.

No binary data output is indicated by the source code or properties.

Dependencies

  • Requires an API key credential for authenticating with the TejasNms API.
  • Depends on the external TejasNms API service being accessible and properly configured.
  • Uses internal helper classes for HTTP requests, state management, and operation resolution/execution.
  • No additional environment variables beyond the API credential appear necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing UUIDs for services or endpoints will cause the API call to fail.
    • Incorrectly formatted nested collections (e.g., VLAN lists) may lead to validation errors.
    • Network connectivity issues or invalid API credentials will prevent successful execution.

  • Error Messages:

    • Authentication failures usually indicate problems with the provided API key credential; verify and update as needed.
    • Validation errors from the API often point to missing required fields or incorrect data types in the input properties.
    • Timeout or connection errors suggest network issues or API service downtime.

To resolve these, ensure all required fields are correctly filled, validate UUID formats, confirm API credentials, and check network connectivity.

Links and References

Discussion