Cisco Optical Network Planner Configuration Guide, Releases 26.x.x

PDF

Network reports

Updated: March 10, 2026

Want to summarize with AI?

Log in

Overview

Describes the functionality of viewing network reports. Explains how the home page provides multiple tabs to access and analyze reports for specific sites, fibers, and wave properties.

The Cisco ONP home page has multiple tabs to access the reports of the analyzed network. You can also view the reports for specific site, fiber, or wave properties by clicking the respective report in the Network Tree pane. The tabs are:

  • Dashboard

  • Elements

  • Map

  • BOM

  • Layout

  • Results

View reports in the Dashboard tab

Table 1. Feature History

Feature Name

Release Information

Feature Description

View sustainability report

 Cisco ONP Release 25.1.1

The Sustainability Insights tab in the Cisco ONP Dashboard presents these sustainability metrics for a network designed in Cisco ONP:

  • Energy Consumption Distribution (kWh)

  • CO2 Emission (Kg)

  • Energy Efficiency (kWh/GHz)

  • CO2 Emission Equivalent: This shows the number of miles traveled by a car, bus, and airplane that would produce the same amount of CO2 emissions.

  • Number of Trees Needed: Indicates the number of trees that would need to be planted to absorb the network's carbon emissions.

This report helps you understand the environmental impact of the optical networks you design.

From Release 25.1.1, Cisco ONP uses the Energy Management Capability (EMC) API to display sustainability reports. The EMC API calculates sustainability metrics by considering the power consumption and the geographical location of the site. See Formulas for sustainability calculation to know how the EMC API does the calculation.

Follow these steps to view various reports of an analyzed network under the Dashboard tab.

Before you begin

Log in to the Cisco ONP web interface.

Enable Sustainability report to view the sustainability report.

Procedure

1.

Open the analyzed network for which you want to view the network summary.
2.

Click the Dashboard tab.

By default, the Network Summary tab will appear and display this information about the network:

  • Total count of sites

  • Total count of fibers

  • Total count of SRLGs (Shared Risk Link Groups)

  • Total count of services

  • Total count of waves/media channels/circuits

  • Total count of messages
3.

Click the Sustainability Insights tab to view the sustainability metrics for a network designed in Cisco ONP.

  • Energy Consumption Distribution (kWh)

  • CO2 Emission (Kg)

  • Energy Efficiency (kWh/GHz)

  • CO2 Emission Equivalent: This shows the number of miles traveled by a car, bus, and airplane that would produce the same amount of CO2 emissions.

  • Number of Trees Needed: Indicates the number of trees that would need to be planted to absorb the network's carbon emissions.

  1. Click the Bypass EMC API radio button to display default values for the metrics regardless of the site's location or its power consumption.

Enable Sustainability report

Use this task to enable the Sustainability Insights tab under the Cisco ONP Dashboard.

Procedure

1.

Log in to the server where Cisco ONP is installed.
2.

Use the cd command to go to the cnp directory and then to the conf directory.

Example:

root#cd /opt /cnp / conf
3.

use the vi feature.properties command to open the feature.properties file in the vi editor.

Example:

root:/opt/cnp/conf# vi feature.properties
4.

Edit the file.

  1. Change SustainabilityInsights.enabled=false to SustainabilityInsights.enabled=true.

  2. Press the w and q keys to save and exit the vi editor.

Example:

:wq

What to do next

View reports in the Dashboard tab

Formulas for sustainability calculation

The EMC API calculates sustainability metrics using these formulas:

  1. Energy Consumed (kWh)

    Formula:

    EnergyConsumed = PowerUtilizedByNode * ObservationPeriodicity / 60

    PowerUtilizedByNode: The total power consumed by the optical node (in Watts).

    ObservationPeriodicity: The observation duration, fixed at 300 seconds (approximately 5 minutes).

  2. Carbon Emission (kg)

    Formula:

    CarbonEmission = EnergyConsumed * CarbonIntensity

    CarbonIntensity: The value obtained from the EMC API. If the EMC API does not return a value, a default constant value of 442 is used.

  3. Energy Efficiency (kWh/GHz)

    Formula:

    EnergyEfficiency = EnergyConsumed / TrafficServed

    EnergyConsumed: The result from the first formula.

    TrafficServed: The total traffic passing or reserved in the network

View reports in the Elements tab

The Elements tab provides comprehensive reports of network elements and any associated messages.

Follow these steps to view the network elements report and messages.

Before you begin

Log in to the Cisco ONP web interface.

Procedure

1.

Open the analyzed network for which you want to view the network summary.
2.

Click the Elements tab.

You can view the reports described in this table.

Table 2. Reports under Elements

Report

Description

Sites

Shows the site information, which consists of the name of the sites, their types, and their X and Y coordinate values.

Fibers

Shows the information about the fiber length between the source and the destination for the corresponding sites.

You can sort and filter the fiber details available in each column of the table.

Services

Shows the service type, source and destination sites for particular service, quantity, protection type, and status.

For each service, the report shows the primary path, secondary path, and their status.

Waves

The Waves report shows the number of waves available in the network and the wave utilization. Click each wave to view the following details:

  • Wave: Consists of a wave UID and its source and destination sites.

  • Wave Details: Provides details of wave OSNR, channel path, OTN services associated to wave and excluded channels.

  • Channels: Port details of the source and destination cards, the wavelength that is used, and its utilization demands.

  • Optical Results: Provides details of optical parameters such as OSNR, SOL, EOL, power margin, CD, and PMD.

SRLGs

Lists the names of created SRLGs and their fiber details. Click Export at the bottom to export the report in .xlsx format.

Messages

Shows messages that relate to errors that occurred while analyzing the network. By default, only critical messages for the analyzed network are listed here. You can disable the Critical Only toggle button to view all messages.

Click the link in the Target column to navigate to the respective object in the network tree and take the necessary action to correct the error.
3.

Click each tab to view the respective report.
4.

Click the Pop-up icon to view the reports in a larger, resizable window.

View details of the BOM report

Table 3. Feature History

Feature Name

Release Information

Feature Description

MLP Brownfield with Diff BOM

Cisco ONP Release 4.1

This feature allows you to perform the following:

  • Compare the BOMs of two or more LNI imported networks.

  • Upgrade brownfield network.

  • Upgrade the Cisco ONP network with traffic sites.

The Bill of Materials (BOM) report includes these components:

  • Detailed price lists for each site.

  • Categories of elements such as Chassis, Controller, Mux-Demux, Line Card, Filler, and more.

  • The overall BOM for the entire network.

Follow these steps to view the BOM report for an analyzed network.

Before you begin

Log in to the Cisco ONP web interface.

Procedure

1.

Open the analyzed network for which you want to view the BOM.
2.

Click the BOM tab.

The BOM details are displayed.

To view the BOM details for OTN and DWDM separately, click each site. See Licensed PIDs available in the BOM reportfor the list of licensed PIDs added into the BOM report.

See for the list of licensed PIDs added into the BOM report.
3.

View the BOM details for any particular site.

  1. In the network tree, expand Site and click the Ellipsis icon available in the right side of the required site.

  2. Click Open BOM

    Cisco ONP opens the BoM tab and provides the BoM details of the selected site.

  3. Expand the Site to view the PID information.
4.

Click Export to export the BOM details in the form of a spreadsheet, and save it into your local system.

We recommend that you export the BOM report only in analyze mode. Exporting the reports in the upgrade and release upgrade modes may lead to inaccuracies..

From Release 24.3.1, the exported Excel file includes these updates:

  • Sales BOM Sheet: Contains information tailored for sales representatives.

  • Net BOM Sheet: Now includes the sitewide BOM count, providing a comprehensive overview of all network elements in the analyzed network.
5.

Compare the BOM of the existing network with other networks:

  1. Click Compare with: Other Networks.

  2. From the Other Networks dialog box, choose the network that you want to be compared with.

You can view both BOM reports displayed on the same page for comparison.
6.

Use the Search box on top of the BOM reports to search for any specific site or wave in the reports.

  1. Enter the name of the specific site or wave in the Search box.

  2. Choose equals or contains from the drop-down list.

  3. Click the Search icon to search for the required site or wave.

Licensed PIDs available in the BOM report

Cisco ONP introduces new licensing PIDs with each platform release to incorporate the latest updates and features.

Table 4. Feature History

Feature Name

Release Information

Feature Description

Support for New PIDs for SMR-20 Card

Cisco ONP Release 4.2

The following new licensed PIDs for the SMR-20 card are displayed on the BOM page so that you can view the price details and consider ordering.

  • NCS2K-FSSMR-2LIC=

  • E-NCS2K-1P-LIC=

  • E-NCS2K-5P-LIC=

  • E-NCS2K-10P-LIC=

This table lists the licensed PIDs included in the BOM report for different Cisco ONP releases.

Table 5. Licensed PIDs added to BOM report

Cisco ONP release supported from

Platform

PIDs and description

4.2

NCS 2000

  • NCS2K-FSSMR-2-LIC= : 20-port FS-SMR licensed to enable two ports

  • E-NCS2K-1P-LIC= : Software license to enable one port on licensed 20-port FS-SMR

  • E-NCS2K-5P-LIC= : Software license to enable five ports on licensed 20-port FS-SMR

  • E-NCS2K-10P-LIC= : Software license to enable ten ports on licensed 20-port FS-SMR

5.2

NCS 1010 from Release 7.11.1

  • NCS1K10-ATO= : NCS 1010 ATO

  • SF-NCS1K10-7111K9S= : Software license to download the COSM NETCONF XML file for the COSM UI.

  • NCS1K4-CCMD-C= : 16-port, C-Band Colorless Coherent Multiplexer/Demultiplexer with an EDFA

  • NCS1K4-CCMD-L= : 16-port, L-Band Colorless Coherent Multiplexer/Demultiplexer with an EDFA

24.3.1

NCS 1020 from Release 24.3.1

NCS 1001 from Release 7.10.1

  • NCS1020-SA= : NCS 1020 Shelf Assembly

  • NCS1020-FAN= : NCS 1020 Fan for NCS 1014 Slots

  • NCS1020-FAN-BLANK= : NCS 1020 Fan Blank

  • CWDM-SFP-1510=: CWDM 1510 NM SFP Gigabit Ethernet and 1G/2G FC

  • CWDM-SFP-1610=: CWDM 1610 NM SFP Gigabit Ethernet and 1G/2G FC

  • ONS-SC-Z3-1510=: SFP - OC48/STM16/GE, CWDM, 1510 nm, Commercial Temp

  • ONS-SC-Z3-1610=: SFP - OC48/STM16/GE, CWDM, 1610 nm, Commercial Temp

  • ONS-SE-155-1510= : SFP - OC3/STM1 CWDM, 1510 nm, EXT

NCS 1014 transponder cards from Release 24.3.1.

  • S-NCS1K14-L-100U= : NCS 1014 100G Client Capacity Smart License - 400-600

  • S-NCS1K14-L-100L= : NCS 1014 100G Client Capacity Smart License - 700-900

  • S-NCS1K14-L-100M= : NCS 1014 100G Client Capacity Smart License - 1T-1.2T

  • NCS1K14-2.4T-K9= : Network Convergence System 1014 2.4T Line Card

  • NCS1K14-2.4T-X-K9= : Network Convergence System 1014 2.4T-X Line Card

  • NCS1K4-OTN-XP=: NCS1004 4x DDQSFP56, 6x QSFP28, 2 CFP2 DCO OTN Xponder

  • NCS1K4-OTN-XPL=: NCS1004 OTN Xponder Licensed

  • NCS1K4-1.2T-K9=: NCS1K4 12x QSFP28 2 Trunk C-Band DWDM card

  • NCS1K4-1.2T-L-K9=: NCS1K4 12x QSFP28 2 Trunk C-Band DWDM card - Licensed

  • NCS1K4-QXP-K9=: NCS1004 3.2T QSFP-DD DCO Transponder

  • NCS1K4-QXP-L-K9=: NCS1004 3.2T QSFP-DD DCO Licensed Transponder

  • NCS1K4-QXP-K9= : NCS1004 3.2T QSFP-DD DCO Transponder

  • ESS-TXP-SIA3 : Essential Coherent DWDM interface SIA 36-59 months

  • ESS-TXP-SIA5 : Essential Coherent DWDM interface SIA 60-120 months

  • ESS-TXP-RTU : Essential Coherent line card interface RTU

  • ADV-TXP-SIA3 : Advance Coherent DWDM interface SIA 36-59 months

  • ADV-TXP-SIA5 : Advance Coherent DWDM interface SIA 60-120 months

  • ADV-TXP-RTU : Advance Coherent line card interface RTU

Note

This is applicable only for the newly designed and upgraded networks.

25.1.1

NCS 2000 with chassis models M6, M15, M2

NCS 1004

NCS 1014

NCS 1010

NCS 1020

OAS-COSM-MLCL

One COSM PID is added for each active card present in the chassis. If a chassis slot is occupied with any active card such as SMR, 16-AD, EDFA, RAMAN, TXP, PSM cards, OLT, ILA, NCS1K14-2.4T-K9, NCS1K14-2.4T-X-K9, and NCS1K4-QXP-K9, one license is added for each occupied slot.

26.1.1

NCS 1010 (from IOS-XR Release 24.3.1)

NCS 1014 (from IOS-XR Release 25.1.1)

These licenses are added to the BOM, with quantities determined by the chassis. SIA and RTU licenses are excluded from the BOM for the Perpetual licensing model.

  • TXP: E-NCS1K14-TXP-SW

  • CCMD/EDFA: E-NCS1K14-OLS-SW

  • OLT: E-NCS1010-OLT-SW

  • ILA: E-NCS1010-ILA-SW

The BoM includes Software licenses for both the Smart licensed model and the Perpetual model, with and without Cisco Optical Site Manager, according to the Cisco ONP Release, for the NCS 1010 and NCS 1014 chassis. See Table 3.

NCS 1014 and NCS 1004 (from IOS-XR Release 25.1.1)

  • NCS1K_LIC _TRUNK: Only applicable for NCS1K4-QXP-K9 card.

  • NCS1k4_100G: For NCS1K4-1.2T-K9, for each 100G port.

  • S_NCS1k4_400G: For each 400G port of NCS1K4-2-QDD-C-K9.

  • S_NCS1k4_100G_ENC: For each ODU4 controller of the NCS1K4-1.2T-K9 card.

  • S_NCS1K4_LH_LIC: Used for NCS1K4-2-QDD-C-K9. number of trunk ports on that slot that has bps between 2 and 4.

  • NCS1k4_400G_REGEN: number of ports that are configured in regen in each slot with 200G as the trunk rate for NCS1K4-OTN-XP card.

This table shows an example for Release 25.1.1. Similar PIDs will be added based on the Release version of NCS 1010 and NCS 1014.

Table 6. Licensed PIDs added to BOM report based on the license model

Cisco ONP Release

Licensing Model

Install with COSM

NCS 1010

NCS 1014

25.1.1

Smart Licensed

False

SF-NCS1K10-2511K9F

SF-NCS1K14-2511K9F

True

SF-NCS1K10-2511K9S

SF-NCS1K14-2511K9S

Perpetual

False

SF-NCS1K10-2511K9P

SF-NCS1K14-2511K9P

True

SF-NCS1K10-2511K9T

SF-NCS1K14-2511K9T

Export the Salesforce BoM report