© 2024 Cisco and/or its affiliates. All rights reserved.
Introduction
The Cisco Routed PON is the management solution for Cisco PON networks. The Cisco
Routed PON management software stack is composed of the [PON Manager] Web
Application graphical user interface and REST APIsoftware to ease the deployment of
devices and subscriber services in the PON network. See [PON Manager] for a more
complete description of the entire Cisco Routed PON solution.
The Cisco Routed PON REST API is a component of the PON Manager that provides
an application programming interface over HTTPS for managing PON devices for the
Cisco Routed PON solution. Customers can build device provisioning, service
configuration, performance monitoring, log collection, and other applications on top of
the API for managing the PON network. In addition to customer applications, the PON
Manager Web App utilizes the API’s PON and user management interfaces for its
operation. The API implements a JSON interface that aligns directly with the PON
Controller management data model and interfaces with the MongoDB datastore for
accessing configuration, state, statistics, logging, and file collections.
The Cisco Routed PON REST API implements endpoints for managing the following:
● Device configuration and status for PON Controllers, OLTs, ONUs, and
Switches.
● Service configuration, including ONU Service Configuration (SRV-CFG) files,
VLANs, Service Level Agreements (SLAs), 802.1X Authentication, DHCP Relay,
and PPPoE.
● Performance management statistics.
● Device alarms and logging.
● File management, including OLT firmware, ONU firmware, and device pictures.
Packaging and Installation
The Cisco Routed PON REST API is packaged and installed along with the Cisco
Routed PON Manager software. See [PON Manager] for requirements, dependencies
and instructions for installing and configuring the PON Manager Web Application and
REST API.
API Overview
The Cisco Routed PON REST API is designed around best practices for a RESTful
interface over a secure HTTPS transport, and provides API endpoints for provisioning
and monitoring Cisco Routed PON OLT devices, as well as the subtended Cisco
Routed PON ONU devices and third-party ONUs compliant with the XGS-PON and
10G-EPON standards. The API is aligned with the Cisco Routed PON Controller data
model in MongoDB, where most API endpoints and data map directly to collections and
documents in MongoDB. This is illustrated in Figure 1 below.