Cisco WAE Design 7.0.1 Integration and Development Guide
Bias-Free Language
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
- Updated:
- January 31, 2019
Chapter: Overview
Overview
Use this guide if you are integrating the WAE Design application and doing related developmental work, such as creating custom add-ons. This guide includes the following topics:
- Plan Files and Tables —Describes plan file formats and how information is stored in tables. It also describes how to create user-defined columns and user-defined tables.
- Importing Objects —Explains how to import Layer 1 (L1) models, SRLGs, QoS models, demand groupings, and tags from other plan files.
- Importing Traffic and Growth Rates —Explains how to import traffic and growth values into plan files, and describes the tool that lets you create representative plan files by aggregating a series of plans over a time period.
- Exporting Routes —Explains how to export the routes of demands, IGP shortest paths, LSPs, LSP paths, circuits, and L1 circuits. It also describes how to export LSP explicit path settings, export L1 circuit Lambda Sim values, and how to export the current table showing in the WAE Design GUI.
- Importing Offline Collections —Describes the WAE Design GUI tools for importing router configuration files and IGP databases into plan files.
- Add-Ons and GUI Customizations —Explains how to create add-on applications that can be accessed from the WAE Design GUI, as well as other means of customizing the GUI.
- Reporting Tools —Describes tools for managing reports integrated into plan files.
- Command-Line Interface —Describes the file for setting default options used by calls to the tools through the CLI or through the GUI, as well as options that control the level of CLI logging.
Note
This guide references $CARIDEN_HOME, which is the directory in which the Cisco WAE executables and binaries are installed. On Linux, the default $CARIDEN_HOME is /opt/cariden/software/mate/current, where /opt/cariden is the default installation directory.
Integration with Other Systems and Workflows
The information in a plan file is readily available for integration into other systems or workflows. All plan information is saved in tables, which you can retrieve, filter, and export to ordinary.txt format plan files. The easiest way to become familiar with the tables in a plan file is from the GUI, using the Plan Table Database Editor. This interface displays a list of all the tables in a plan and provides options for extracting plan information, from simple text searches to complex SQLite queries. The data you extract can be useful for critical tasks, such as:
- Creating reports about utilization and routing for a single simulation scenario or multi-scenario analysis.
- Extracting paths for node pairs, specific demands, or LSPs for analysis by third-party applications.
If you have a custom task that is part of your workflow, you can add that task as a menu item to the WAE Design GUI, using the Add-on capability. Add-ons can simplify the task of data extraction for other systems, as well as for any WAE Design task that you perform frequently.
Feedback