Network reports
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
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:
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
Enable Sustainability report to view the sustainability report.
Procedure
Step 1 |
Open the analyzed network for which you want to view the network summary. |
Step 2 |
Click the Dashboard tab. By default, the Network Summary tab will appear and display this information about the network:
|
Step 3 |
Click the Sustainability Insights tab to view the sustainability metrics for a network designed in Cisco ONP.
|
Enable Sustainability report
Procedure
Step 1 |
Log in to the server where Cisco ONP is installed. |
Step 2 |
Use the cd command to go to the cnp directory and then to the conf directory. Example:
|
Step 3 |
use the vi feature.properties command to open the feature.properties file in the vi editor. Example:
|
Step 4 |
Edit the file.
Example:
|
What to do next
Formulas for sustainability calculation
The EMC API calculates sustainability metrics using these formulas:
-
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).
-
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.
-
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
Procedure
Step 1 |
Open the analyzed network for which you want to view the network summary. |
||||||||||||||
Step 2 |
Click the Elements tab. You can view the reports described in this table.
|
||||||||||||||
Step 3 |
Click each tab to view the respective report. |
||||||||||||||
Step 4 |
Click the Pop-up icon to view the reports in a larger, resizable window. |
View details of the BOM report
Feature Name |
Release Information |
Feature Description |
---|---|---|
MLP Brownfield with Diff BOM |
Cisco ONP Release 4.1 |
This feature allows you to perform the following:
|
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
Procedure
Step 1 |
Open the analyzed network for which you want to view the BOM. |
Step 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. |
Step 3 |
View the BOM details for any particular site. |
Step 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:
|
Step 5 |
Compare the BOM of the existing network with other networks:
You can view both BOM reports displayed on the same page for comparison. |
Step 6 |
Use the Search box on top of the BOM reports to search for any specific site or wave in the reports.
|
Licensed PIDs available in the BOM report
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.
|
Cisco ONP introduces new licensing PIDs with each platform release to incorporate the latest updates and features.
This table lists the licensed PIDs included in the BOM report for different Cisco ONP releases.
Cisco ONP release supported from |
Platform |
PIDs and description |
|
---|---|---|---|
4.2 |
NCS 2000 |
|
|
5.2 |
NCS 1010 from Release 7.11.1 |
|
|
NCS 1020 from Release 24.3.1 NCS 1001 from Release 7.10.1 |
|
||
NCS 1014 transponder cards from Release 24.3.1. |
|
||
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. |
View details of layout and internal connections
Follow these steps to obtain the layout details and internal connections of an analyzed network.
Before you begin
Procedure
Step 1 |
Click the Layout tab on the Cisco ONP homepage. |
Step 2 |
Type the site name in the search box, or select a site from the Sites drop-down list. The site layout is displayed with its racks and cards.
COSM supports up to 50 UIDs; beyond which, the site layout displays incorrect UID for the chassis. |
Step 3 |
Click the IPC tab to view the internal patch connections of the selected site. |
Export Internal connections
Cisco ONP allows you to export internal fiber connections in two ways: either at site-level or network-level.
Follow these steps to export internal fiber connections.
Before you begin
Procedure
Step 1 |
Click the Ellipsis icon available in the right side of the internal fiber connection or site. |
Step 2 |
Click Export. |
View end-to-end OCH connections
Feature Name |
Release Information |
Feature Description |
---|---|---|
View the End-to-End Optical Channel (OCH) Connectivity from Source to Destination |
Cisco ONP Release 24.3.1 |
You can now view the end-to-end OCH connection details in the graphical form for the analyzed NCS 1010 networks. The new OCH tab in Layout displays all the OCH connectivity from source to destination in:
|
You can now view the end-to-end OCH connection details in the graphical form in Degree Connection and Functional views for the analyzed NCS 1010 networks.
Follow these steps to view the end-to-end OCH connectivity from source to destination.
Before you begin
Procedure
Step 1 |
Open the analyzed NCS 1010 network for which you want to view the end-to-end OCH connectivity./ |
||||||||||||||||
Step 2 |
Click the Layout tab on the Cisco ONP homepage. |
||||||||||||||||
Step 3 |
Click the OCH tab. The OCH Pipes pane appears to display the sites and sections in the circuits tree. |
||||||||||||||||
Step 4 |
Click the ellipsis icon next to the Circuits. A pop-up list displays the view options.
|
||||||||||||||||
Step 5 |
Use the search bar or filter icon to select the required source and destination sites.
Based on the unit that you select in the circuit tree, you can see the site connectivity or the detailed end-to-end OCH connectivity.
|
||||||||||||||||
Step 6 |
In the graphical area, use the action icons to view the source and destination sites connectivity.
|
Export end-to-end OCH connections
Follow these steps to view the end-to-end OCH connectivity from source to destination.
Before you begin
Procedure
Step 1 |
In the graphical area, click the download icon. The Export pop-up list displays the circuit options.
|
||||||
Step 2 |
Click the required option to export the end-to-end OCH connectivity details to an Excel sheet. |
View power consumption and unit weight report
Feature Name |
Release Information |
Feature Description |
---|---|---|
Power Consumption and Unit Weight Report |
Cisco ONP Release 5.2 |
Now, you can generate the power consumption and unit weight report for each product ID (PID). In the layout tab, you can see the power consumption and unit weight values and export them into Excel as a report for a single site or all sites. With prior knowledge of power consumption and weight details for each PID, you can plan and design an energy-efficient network. The new options that allow you to view and export the reports are:
|
The Power Consumption and Unit Weight report includes power consumption and weight details of cards and shelves at each site.
![]() Remember |
The power consumption of the Power Supply Unit (PSU) is not included in the total power consumption for NCS 1001, NCS 1010, NCS 1014, and NCS 1020 chassis. Determine the total power consumption for these chassis by adding 8 percent of the aggregated power consumption of all the cards inside the chassis to account for the PSU power consumption. |
![]() Note |
To view the power consumption and weight report, upgrade and analyze the LNI network. |
Follow these steps to view the power consumption and unit weight report for each site.
Before you begin
Procedure
Step 1 |
Open the analyzed network for which you want to view the power consumption and weight report. |
||||||||||||||
Step 2 |
Click the Layout tab on the Cisco ONP homepage. |
||||||||||||||
Step 3 |
Click the ellipsis icon next to Sites. A pop-up list displays these options.
|
||||||||||||||
Step 4 |
Select the options as you require. |
Export power consumption and unit weight report
Follow these steps to export the power consumption and weight report of each shelf and card.
Before you begin
Procedure
Step 1 |
In the graphical area, click the download icon. The Export pop-up list displays these options.
|
||||||
Step 2 |
Click the option as you require. |
||||||
Step 3 |
Click Power Consumption & Weight to export the optical reports details in an Excel sheet. We recommend that you export the power consumption and weight report only in the analyze mode. Exporting the reports in the upgrade and release upgrade modes may be inaccurate. |
View the results of analyzed network
![]() Note |
You can refer to the optical results data to check and correct the optically not feasible channels. You can modify the network properties in the Upgrade and Release Upgrade modes. After making the necessary corrections, analyze again to update the optical results based on the new modifications. |
Follow these steps to view the details of optical reports, installation parameters, traffic reports, and cabling reports.
Before you begin
Procedure
Step 1 |
Open the analyzed network for which you want to view the optical results. |
||
Step 2 |
Click the Results tab on the Cisco ONP home page.
To view the optical report for any particular optical path: |
||
Step 3 |
From the OSNR RBW drop-down list, select the OSNR Resolution bandwidth between 0.5 nm and 0.1 nm. The default value is 0.5 nm. You can change it in Design mode, Analyzed mode, Upgrade mode, and Release upgrade mode. When set to 0.1 nm, the SOL G-OSNR and EOL G-OSNR values increase to 7 dB. |
||
Step 4 |
Click the Installation Parameters tab. The Installation Parameters report specifies the values to be provisioned at installation for each site in the network. To view the installation parameters for Automatic Node Setup (ANS) and Automatic Node Provisioning (ANP), click the respective tabs. See Installation parameters |
||
Step 5 |
Click the Traffic Report tab. You can view the aggregated demand channel data in the form of the traffic reports. See Traffic reports. In Release 5.1, you can view the traffic report for all imported networks except the imported .mpz networks. To view the traffic report for individual optical path in imported .mpz networks, you must manually search in the Search box. To view the traffic report for any particular optical path: |
||
Step 6 |
Click the Cabling Report tab. See Cabling report You can view the patch cord connections related to internal patch connections and multishelf management. This report is available for the networks starting from NCS 2000 system Release 12.1.0. To view the internal patch connections for any particular site: |
||
Step 7 |
Use the Search box on top of the reports to search for any specific site or wave in the reports
|
||
Step 8 |
Click Export Report to export the optical reports details in an Excel sheet. We recommend exporting the optical report only in analyze mode. Exporting reports in upgrade and release upgrade modes may be inaccurate. |
Compare installation parameters of two networks
Feature Name |
Release Information |
Feature Description |
---|---|---|
UI Revamp of Optical Reports |
Cisco ONP Release 4.1 |
This feature improves the user experience while comparing the installation parameters and optical reports of two networks. |
Use this task to compare the installation parameters of two networks.
Before you begin
Procedure
Step 1 |
Click the Results tab on the Cisco ONP home page. |
Step 2 |
Click Installation Parameters. |
Step 3 |
Click Other Networks. |
Step 4 |
From the list of networks, select the network with which to compare. FInd a new parameter called diffBy. |
Step 5 |
To stop comparing the two networks, click Clear. |
Step 6 |
Click Export Report to export the comparison report. |
Compare the optical reports of two networks
Follow these steps to compare the optical reports of two networks.
Before you begin
Procedure
Step 1 |
Click the Results tab on the Cisco ONP home page. |
Step 2 |
Click Optical Report. |
Step 3 |
Click Other Networks. |
Step 4 |
From the list of networks, select the network with which to compare. The optical parameters display two values. |
Step 5 |
To stop comparing the two networks, click Clear. |
Step 6 |
Click Export Report to export the comparison report. |
Optical Report
From Release 24.3.1, you can filter the results by any column available in the report for more precise data analysis. For reports represented as colored icons, you can use the first letter of the color (e.g., "g" for green) to filter the results.
Optical Parameter | |
---|---|
Name | Displays the ID number of the wave and aggregated waves. ID is automatically generated based on the site name. |
Protection | Displays the protection type of the wave. |
Protection Type |
Displays whether the path type is Protected or Working path for NCS 1001. |
SOL |
Displays an icon indicating the results summary of the analysis that is run with Start of Life (SOL) fiber loss values:
|
EOL |
Displays an icon indicating the results summary of the analysis that is run with End of Life (EOL) fiber loss values. The indicator shows the optical performance for the path at the end of the fiber life:
|
SE | Indicates a system-related error that may impact the analysis of the design. If the indicator is red, review the messages that are reported at the end of the analysis or determine which units or sites have a problem. |
P/F | Displays the present or forecast services indication. |
Source | Displays the name of the source site and side; for example, Site 1-E. |
Src Colorless | Displays whether the colorless functionality is enabled on source ports. |
Src Contentionless | Displays whether the contentionless functionality is enabled on source ports. |
Destination | Displays the name of the destination site and side; for example, Site 1-E. |
Dst Colorless | Displays whether the colorless functionality is enabled on destination ports. |
Dst Contentionless | Displays whether the contentionless functionality is enabled on destination ports. |
Wavelength | Displays the wavelength of the optical channel. |
Band Type |
Displays the band type of the optical path. |
Src Tx Type | Displays the type of DWDM unit or pluggable port module that is used at the source of the specific Optical Channel (OCH) trail. The class of the DWDM unit is also displayed. |
Dst Tx type | Displays the type of DWDM unit or pluggable port module that is used at the destination of the specific OCH Trail. The class of the DWDM unit is also displayed. |
Span | Displays the total span length (source to destination) for this path in kilometers. |
Suggested Regen Locations | Displays the regeneration locations. |
BER Target | Displays the bit error rate (BER) target for this channel, based on the capability of the channel’s optical interface. It is 1.0E-15 for the interfaces using forward error correction (FEC) and 1.0E-12 for interfaces without FEC. |
SOL OSNR | Displays the start of life average Optical Signal to Noise Ratio (OSNR) value at the receiver. |
EOL OSNR | Displays the end of life average OSNR value at the receiver. |
SOL OSNR margin | Displays the SOL OSNR margin calculation. It is the difference between the OSNR value at certain power of the working point of the receiver client and the working area boundary. |
EOL OSNR margin | Displays the EOL OSNR margin calculation, which is the difference between the OSNR value at a certain power of the working point of the receiver client and the working area boundary. |
SOL RX | Displays the SOL average power that is received at the destination site in dBm. |
EOL RX | Displays the EOL average power that is received at the destination site in dBm. |
SOL Power Margin | Displays the SOL power budget margin at the receiver in decibels. It is defined as the offset between the receiver working point and the BER curve with margin. A positive value indicates that there are no power problems. |
EOL Power Margin | Displays the EOL power budget margin at the receiver in decibels. It is defined as the offset between the receiver working point and the BER curve with margin. A positive value indicates that there are no power problems. |
SOL Overload | Displays the SOL overload margin at the receiver in decibels. A positive value indicates that there are no overload problems. |
EOL Overload | Displays the EOL overload margin at the receiver in decibels. A positive value indicates that there are no overload problems. |
Residual CD | Displays the chromatic dispersion (CD) margin of the demand. |
CD robustness | Displays the robustness to chromatic dispersion of the receiver. |
Single-Channel NLE Status | Displays the status of alarms if any nonlinear effect (NLE) is present in the demand. |
Multi-Channel NLE Status | Provides the status of the nonlinear effect (NLE) on a particular channel or demand due to other channels or demands. |
Min GB |
Displays the minimum Guard Band (GB) requirement between channels on the 40G CP-DQPSK MXP and 40G CP-DQPSK ME MXP cards, and other transponders in a mixed any-to-any connectivity. |
Filtering Penalty | Displays the value of the penalties that are caused by different filter types (OADM, ROADM, and arrayed waveguide grating (AWG)). |
PMD | Displays the calculated total Polarization Mode dispersion (PMD) for each circuit. If the overall PMD for the link overcomes the maximum that is allowed, the PMD value is displayed in a red-colored font. The maximum allowed value depends on the client interface. For these special cases, the network must be manually resolved by contacting a Cisco TAC team. |
RX Atten |
Displays the attenuation at the input of the receiver. |
TX Atten | Displays the attenuation at the output of the receiver. |
Encryption | Displays the encryption type of the channel. Possible values are N/A, Yes, No. |
Installation parameters
This table outlines the installation parameters for the ANS component.
Parameter | Description |
---|---|
Name |
Displays the name of the site |
Side |
Displays the line side |
Position |
Displays the rack number, shelf number, and slot position of the card where the patch cord originates. |
Unit |
Displays the name of the card. |
Port |
Displays the port number where the patch cord originates. |
Port ID |
Displays the port ID. |
Port Label |
Displays the name of the port. |
Parameter |
Displays the name of the parameter to be set, such as RX Power Low, PSDShape, PSD, Gain, AmpliGainRange, AddAttenuation, DropAttenuation, Control Mode, MinExpSpanLoss, MaxExpSpanLoss, and so on. For the CCMD-16 LC card connected to the ports of the OLT-E-C, the PSD is set using a specific formula and the VOA drop attenuation is set to 0dB to have optimal RX power for the circuits. |
Value |
Displays the name of the value to be set for the parameter. |
Measurement Unit |
Displays the measurement unit for the related installation parameter value, such as dBm. |
Manual Set |
Indicates with a Yes or No which parameters must be manually set using the Cisco Transport Controller (CTC) interface. |
This table outlines the installation parameters for the ANP component.
Parameter | Description |
---|---|
Name |
Displays the name of the site. |
Unit ID |
Displays the unit (slot number) of the passive units in the shelf. |
Shelf ID |
Displays the shelf identifier. |
Rack Number |
Displays the rack number. |
Rack Position |
Displays the rack position in the shelf. |
Slot Position |
Displays the slot position in the shelf for the card. |
Equipment Type |
Displays the card type. |
Description |
Displays the details of the card type. |
Traffic reports
This table displays the aggregated data of demand channel in the traffic report for the analyzed network.
Traffic report |
Description |
---|---|
Demand |
Categorizes each demand type. Each demand is further categorized into service, trails, and sections. |
Section |
Displays the sections under every service. |
Src Site |
Displays the site name for the optical channel source. |
Band Type |
Displays the band type for the optical path. |
Src Position |
Displays the rack, shelf ID, and slot identifiers for the source of the optical channel. |
Src Card |
Displays the unit name for the optical channel source. |
Dst Site |
Displays the site name for the optical channel destination. |
Dst Position |
Displays the rack, shelf ID, and slot identifiers for the destination of the optical channel. |
Dst Card |
Displays the unit name for the optical channel destination. |
Client Service Type |
Displays the client service type of the demand; for example, OC-48. |
Protection Type |
Displays the protection type of the demand |
Encryption |
Displays whether the demand is encrypted with values: NA, Yes, or No. |
Wavelength |
Displays the wavelength value of the optical channel, and the serial number of the wavelength in the wavelength band. |
Max Latency (for NCS 2000 network) |
Displays the latency time for the current circuit. This value includes all the latency components for the circuit, including fiber and DWDM units on the path. |
Fiber Latency (for NCS 1010 and NCS 1001) |
Displays the latency time for the fiber. |
Cabling report
The IPC Cabling and Patch reports are consolidated into a single view with additional columns. This streamlines connection details and eliminates the need to access multiple sources.
This table shows patch cord connections related to internal patch connections and multishelf management.
Parameter |
Description |
---|---|
Name |
Displays the name of the site. |
Src Unit Type |
Displays the source unit. |
Src Position |
Displays the rack, shelf, and slot position of the card from which the patch cord originates. |
Src Port Label |
Displays the name of the port. |
SrcFicBay |
Displays the assigned rack number. |
SrcShelfName |
Displays the type of shelf or the shelf name. |
SrcShelfNumber |
Displays the type of shelf or the shelf name. |
SrcShelfUniqueId |
Displays the unique ID assigned to the shelf. The unique ID will be used in COSM XML to push the configuration to the device. |
SrcRUPosition |
Displays the rack unit position in layout. |
SrcCardNumber |
Displays the card slot number within the shelf . |
Cable |
Displays the type of cable. |
Dst Unit Type |
Displays the source unit. |
Dst Position |
Displays the rack, shelf, and slot position of the card from which the patch cord terminated. |
Dst Port Label |
Displays the name of the port. |
DstFicBay |
Displays the assigned rack number. |
DstShelfName |
Displays the type of shelf or the shelf name. |
DstShelfNumber |
Displays the assigned shelf number. |
DstShelfUniqueId |
Displays the unique ID assigned to the shelf, which is used in COSM XML to push the configuration to the device. |
DstRUPosition |
Displays the rack unit position in layout. |
DstCardNumber |
Displays the card slot number within the shelf . |
ManuallySet/AutomaticallySet |
Indicates whether a cable connection will be automatically generated or requires manual configuration for NCS 2000 networks. |
Parameter |
Description |
---|---|
Name |
Displays the name of the site. |
Src Unit Type |
Displays the source unit. |
Src Position |
Displays the rack, shelf, and slot position of the card from which the patch cord originates. |
Src ID |
Displays the source unit ID. |
Src Port Label |
Displays the name of the port. |
Cable Type |
Displays the type of cable. |
Dst Unit Type |
Displays the source unit. |
Dst Position |
Displays the rack, shelf, and slot position of the card from which the patch cord terminated. |
Dst ID |
Displays the destination unit ID. |
Dst Port Label |
Displays the name of the port. |
W/P |
Indicates whether the connection relates to a present or forecast circuit. |
Confidential banner in exported reports
Feature Name |
Release Information |
Feature Description |
---|---|---|
Confidential Banner |
Cisco ONP Release 4.1 |
This feature indicates the confidentiality of the reports or results generated by Cisco ONP for a network. The CONFIDENTIAL banner is placed in all the exported reports. It is placed in the first row and first cell of the Excel sheet, followed by a blank row and the contents of the exported report. |
Feature Name |
Release Information |
Feature Description |
---|---|---|
Customizable Confidential Banner |
Cisco ONP Release 4.2 |
The Confidential Banner string can be customized as required. An admin user can modify the banner string when the confidentialBanner.enabled field is set to true in the feature.properties file. |
The "CONFIDENTIAL" banner appears in all exported reports. In Excel files (.xlsx), it is located in the first cell of the first row, followed by a blank row, and then the report contents. If the .xlsx file contains multiple sheets, the banner is included on each sheet.
The "CONFIDENTIAL" banner is updated only when reports are exported in .xlsx format.
Server administrators can customize the "CONFIDENTIAL" banner text by modifying the confidentialBanner.content
field. To enable banner customization, the confidentialBanner.enabled
field must be set to true
in the feature.properties
file. By default, this field is set to false
.