SmartOLT icon

SmartOLT

Consume SmartOLT API (v0.2.17)

Overview

This node operation "Get All ONUs Details" retrieves detailed information about Optical Network Units (ONUs) from the SmartOLT system. It allows filtering the ONUs by various parameters such as OLT ID, board, port, and zone. This operation is useful for network administrators who need comprehensive data on ONUs for monitoring, management, or troubleshooting purposes. For example, an admin can get details of all ONUs connected to a specific OLT or within a particular zone to analyze network performance or plan maintenance.

Use Case Examples

  1. Retrieve all ONUs details from all OLTs without filters.
  2. Get ONUs details for a specific OLT by providing the OLT ID.
  3. Filter ONUs details by specifying the OLT board and port to narrow down the results.
  4. Fetch ONUs located in a specific zone for targeted network management.

Properties

Name Meaning
Additional Fields Optional filters to specify which ONUs details to retrieve, including OLT ID, board, port, and zone.

Output

JSON

  • onus - Array of ONU details objects containing comprehensive information about each ONU matching the filter criteria.

Dependencies

  • Requires SmartOLT API credentials for authentication.

Troubleshooting

  • Ensure the SmartOLT API credentials are correctly configured and have the necessary permissions.
  • If no ONUs are returned, verify that the filter parameters (OLT ID, board, port, zone) are correct and that ONUs exist matching those filters.
  • API request failures may occur due to network issues or incorrect endpoint usage; check connectivity and API documentation for updates.

Links

Discussion