Cisco Optical Network Planner API

The Cisco Optical Network Planner API allows developers to interact programmatically with the Cisco Optical Network Planner web application over RESTful interface. Cisco Optical Network Planner API is designed to model and test Optical Transport Networks (OTN) and Dense Wavelength Division Multiplexing (DWDM) optical networks using an external API tool.

Cisco Optical Network Planner API is a RESTful API that allows you to plan, design, and manage optical networks at scale.

Key Features

  • Network Design and Validation: Design and validate networks for NCS 1001, NCS 1004, NCS 1010, NCS 2000, and NCS 4000 series.
  • Instance Management: Create multiple instances of a network, modify parameters, and compare different instances.
  • Rack View: Generate a rack view of all deployed sites in the network.
  • Comparison and Reporting: Show differences between instances and provide a complete Bill of Materials (BoM).
  • Detailed Reports: Access detailed network information such as Cabling report, Optical report, Device Configuration file, and Traffic matrix.

Use Cases

  • Network Planning: Ideal for network engineers planning and validating optical transport networks.
  • Instance Comparison: Useful for comparing different network setups and configurations.
  • Material Management: Generate and manage Bills of Materials for network deployments.

Cisco Optical Network Planner API Functionalities

The Cisco Optical Network Planner API enables external tools to interact programmatically with Cisco Optical Network Planner, offering a wide range of functionalities to design, manage, and analyze optical networks. The main functionalities include:

  • Create new network designs.
  • Open and modify existing designs.
  • Add or edit topology elements such as sites, fibers, and demands.
  • Execute analysis to validate network designs.
  • Fetch all generated reports, including detailed documents like cabling reports, optical reports, device configuration files, and traffic matrices.
  • Check the status of ongoing actions, such as whether the design is being analyzed, is in the process of loading, or if files are being fetched post-analysis.
  • Force Raman amplification at the span level.
  • Choose the required amplifier or default setting, enabling multiple iterations of the design with varying Raman settings.