Cisco WAE 6.3 Documentation Roadmap

Available Languages

Download Options

  • PDF     (139.3 KB)
    View with Adobe Reader on a variety of devices
  • ePub     (73.0 KB)
    View in various apps on iPhone, iPad, Android, Sony Reader, or Windows Phone
  • Mobi (Kindle)     (70.8 KB)
    View on Kindle device or Kindle app on multiple devices
Updated:December 22, 2015

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.

Table of Contents

Cisco WAN Automation Engine 6.3 Documentation Roadmap

Where to Find Documentation

Guides

Obtaining Documentation and Submitting a Service Request

Cisco WAN Automation Engine 6.3 Documentation Roadmap

First Published: 2015-12-22

 

You can access the Cisco WAN Automation Engine (Cisco WAE) end-user documentation on Cisco.com at http://www.cisco.com/c/en/us/support/routers/quantum-wan-automation-visibility-engine/tsd-products-support-series-home.html.

note.gif

Noteblank.gif We sometimes update the documentation after original publication. Therefore, you should review the documentation on Cisco.com for any updates.

This reference helps direct you to the appropriate Cisco WAE documentation. The following terms are used in describing directories in which documentation resides:

  • $CARIDEN_HOME —Directory in which the Cisco WAE Design, Cisco WAE Live, and Cisco WAE Collector executables and binaries are installed. The Linux default is /opt/cariden/software/mate/current.
  • $WAE_HOME —Directory in which the packages are installed. The default is /opt/cariden/software.

Where to Find Documentation

  • Documentation for each $WAE_HOME subdirectory is located in its docs directory. For example, $WAE_HOME/wae-core/docs contains its relevant documentation.
  • All documentation is in the $CARIDEN_HOME/docs directory and in $WAE_HOME/docs/<package> directory.
  • The Cisco WAE Design GUI and the Cisco WAE web UI each have Help menus that provide access to relevant documentation.

Guides

 

Tasks
Interface
Resource
Installation

Install server for single-system deployment. (For distributed deployments, contact your service representative.)

Installer script

Cisco WAE Server Installation Guide

Install FlexNet Publisher license server

CLI tools

Cisco WAE Server Installation Guide

Cisco WAE Design GUI Installation Guide

Install Cisco WAE Design GUI

Zip files (Windows or MAC) or installer script (Linux)

Cisco WAE Design GUI Installation Guide

Install or upgrade a Cisco WAE Live datastore

CLI tools

Cisco WAE Live Administration Guide

Install licenses

CLI tools, web System UI, Cisco WAE Design GUI

Cisco WAE Server Installation Guide

Cisco WAE Design GUI Installation Guide

Install add-on applications (WAE Coordinated Maintenance or customized applications)

System UI

Cisco WAE System Administration Guide

Configuration

Configure single-system Cisco WAE Core

Configuration files

Cisco WAE Platform Configuration Guide

Discover topology, operational state, and traffic statistics

 

 
  • Configure the Collector server

Cisco WAE Collector UI

Cisco WAE Platform Configuration Guide

  • Configure the Cisco WAE Network Interface (NI) server

Cisco WAE Collector UI, snapshot configuration files

Cisco WAE Platform Configuration Guide

  • Collect using snapshot files

Snapshot configuration files and CLI tools

Cisco WAE Platform Configuration Guide

  • Cisco WAE Collector CLI tools used in snapshot configurations

CLI tools

Cisco WAE Plan Table Schema and CLI Reference

$CARIDEN_HOME/bin

  • Manage archives for use in augmented and manual discovery processes

CLI tools

Cisco WAE Platform Configuration Guide

Get the collected information into Cisco WAE Live

Cisco WAE Live UI

Cisco WAE Live Administration Guide

Deploy changes to a live network

Cisco WAE Design GUI

Cisco WAE Platform Configuration Guide

Cisco WAE Core APIs

$WAE_HOME/wae-core/docs/api

Back up and restore a Cisco WAE Live datastore

CLI tools

Cisco WAE Live Administration Guide

System Administration

Manage services

CLI tools

Cisco WAE System Administration Guide

Monitor Cisco WAE

Statistics UI

Cisco WAE System Administration Guide

Manage administration tasks for the local server, such as setting up licenses and users (for Collector server, Cisco WAE Live, and Cisco WAE Design Archive)

System UI

Cisco WAE System Administration Guide

Application Customization

Customize the Cisco WAE Live application

Cisco WAE Live UI

Cisco WAE Live Administration Guide

Customize the Cisco WAE Design Archive application

Cisco WAE Design Archive UI and configuration files

Cisco WAE Design Archive User and Administration Guide

Create templates for visualizing the network

Cisco WAE Design GUI

Cisco WAE Network Visualization Guide

Using the Applications (after installation and configuration tasks are complete)

Cisco WAE Live

Cisco WAE Live UI

Cisco WAE Live User Guide

Cisco WAE Design

Cisco WAE Design GUI

Cisco WAE Design User Guide

Cisco WAE Network Visualization Guide

Cisco WAE Design GUI to create templates for use in the web applications

Cisco WAE Design GUI

Cisco WAE Network Visualization Guide

Cisco WAE Design Archive

Cisco WAE Design Archive UI

Cisco WAE Design Archive User and Administration Guide
Integration and Development

Use Cisco WAE Design tools for integration and development purposes, such as creating add-ons and importing traffic into plan files

Plan tables, external tables, and CLI

Cisco WAE Design Integration and Development Guide

Cisco WAE plan table file schema

HTML file

Cisco WAE Plan Table Schema and CLI Reference

$CARIDEN_HOME/docs/table_schema.html

CLI tools for Cisco WAE Collector, Cisco WAE Live, Cisco WAE Design Archive, and Cisco WAE Design (only Linux distributions contain the full set)

CLI

Cisco WAE Plan Table Schema and CLI Reference

$CARIDEN_HOME/bin

APIs

Cisco WAE Design APIs

Directory with index.html file

On Planning server:

$CARIDEN_HOME/docs/api/design

Cisco WAE NI server APIs

Directory with index.html file

On Planning server:

$WAE_HOME/wae-ni/docs/api

Cisco WAE Live APIs

Web UI

Directory with index.html file

Help menu

On Planning server:

$CARIDEN_HOME/docs/api/live

Cisco WAE Core REST APIs

Directory with index.html file

On Automation server:

$WAE_HOME/wae-core/docs/api/services/rest

Cisco WAE Core Thrift APIs

File

On Automation server:

$WAE_HOME/wae-core/docs/api/services/thrift

Stage Management API

Directory with index.html file

On Automation server:

$WAE_HOME/wae-core/docs/api/stage-manager

Design REST API

Directory with index.html file

On Automation server:

$WAE_HOME/wae-core/docs/api/appengine

Dynamic SLA Management API

Directory with index.html file

On Automation server:

$WAE_HOME/wae-core/docs/api/reactive-te

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see What’s New in Cisco Product Documentation at: http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to What’s New in Cisco Product Documentation, which lists all new and revised Cisco technical documentation, as an RSS feed and deliver content directly to your desktop using a reader application. The RSS feeds are a free service.

 

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.

© 2015 Cisco Systems, Inc. All rights reserved.

Was this Document Helpful?

FeedbackFeedback

Contact Cisco