Cisco WAE 6.2 Documentation Roadmap
July 2015
Cisco Systems, Inc.
www.cisco.com
Cisco has more than 200 offices worldwide.
Addresses, phone numbers, and fax numbers
are listed on the Cisco website at
www.cisco.com/go/offices.
Text Part Number:
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL
STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT
SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE
OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public
domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH
ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF
DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,
WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO
OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
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.
CH A P T E R
1
Documentation Roadmap
This reference helps direct you to the appropriate WAE documentation. The following terms are used in
describing directories in which documentation resides.
•
$CARIDEN_HOME—Directory in which the WAE Design, WAE Live, and 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 WAE Design GUI and the WAE web UI each have Help menus that provide access to relevant
documentation.
Guides
Tasks
Interface
Resource
Installation
Install server for single-system
Installer script
deployment (For distributed deployments,
contact your service representative)
WAE Server Installation Guide
Install FlexNet Publisher license server
WAE Server Installation Guide
CLI tools
WAE Design GUI Installation Guide
Install WAE Design GUI
Zip files (Windows or Mac)
or installer script (Linux)
WAE Design GUI Installation Guide
Install or upgrade a WAE Live datastore
CLI tools
WAE Live Configuration Guide
Cisco WAE 6.2 Documentation Roadmap
1-1
Chapter 1
Documentation Roadmap
Guides
Tasks
Interface
Resource
Install licenses
CLI tools, web System UI,
WAE Design GUI
WAE Server Installation Guide
Configuration files
WAE Platform Configuration Guide
WAE Collector UI
WAE Platform Configuration Guide
WAE Design GUI Installation Guide
Configuration
Configure single-system WAE Core
Discover topology, operational state, and
traffic statistics
•
Configure the Collector server
•
Configure the WAE Network Interface WAE Collector UI, snapshot
(NI) server
configuration files
WAE Platform Configuration Guide
•
Collect using snapshot files
Snapshot configuration files
and CLI tools
WAE Platform Configuration Guide
•
WAE Collector CLI tools used in
snapshot configurations
CLI tools
WAE Design Plan Table Schema and CLI
Reference
$CARIDEN_HOME/bin
•
Manage archives for use in augmented CLI tools
and manual discovery processes
WAE Platform Configuration Guide
Get the collected information into WAE
Live
WAE Live UI
WAE Live Configuration Guide
Deploy changes to a live network
WAE Design GUI
WAE Platform Configuration Guide
WAE Core APIs
$WAE_HOME/wae-core/docs/api
Back up and restore a WAE Live datastore CLI tools
WAE Live Configuration Guide
System Administration
Manage services
CLI tools
WAE System Administration Guide
Monitor WAE
Statistics UI
WAE System Administration Guide
Manage administration tasks for the local System UI
server, such as setting up licenses and
users (for Collector server, WAE Live, and
WAE Design Archive)
WAE System Administration Guide
Application Customization
Customize the WAE Live application
WAE Live UI
WAE Live Configuration Guide
Customize the WAE Design Archive
application
WAE Design Archive UI and WAE Design Archive User and Administration
configuration files
Guide
Create templates for visualizing the
network
WAE Design GUI
WAE Network Visualization Guide
Using the Applications (after installation and configuration tasks are complete)
WAE Live
WAE Live UI
WAE Live User Guide
WAE Design
WAE Design GUI
WAE Design User Guide
WAE Network Visualization Guide
Cisco WAE 6.2 Documentation Roadmap
1-2
Chapter 1
Documentation Roadmap
Guides
Tasks
Interface
Resource
WAE Design GUI to create templates for
use in the web applications
WAE Design GUI
WAE Network Visualization Guide
WAE Design Archive
WAE Design Archive UI
WAE Design Archive User and Administration
Guide
Integration and Development
Use WAE Design tools for integration and Plan tables, external tables,
and CLI
development purposes, such as creating
add-ons and importing traffic into plan
files
WAE Design Integration and Development
Guide
WAE Design plan file schema
WAE Design Plan Table Schema and CLI
Reference
HTML file
$CARIDEN_HOME/docs/table_schema.html
CLI tools for WAE Collector, WAE Live,
WAE Design Archive, and WAE Design
(Only Linux distributions contain the full
set)
CLI
WAE Design Plan Table Schema and CLI
Reference
$CARIDEN_HOME/bin
APIs
Design APIs
Directory with index.html file $CARIDEN_HOME/docs/api/design
WAE NI server APIs
Directory with index.html file $WAE_HOME/wae-ni/docs/api
WAE Live APIs
Web UI
Help menu
Directory with index.html file $CARIDEN_HOME/docs/api/live
WAE Core REST APIs
Directory with index.html file $WAE_HOME/wae-core/docs/api/rest
WAE Core Thrift APIs
File
$WAE_HOME/wae-core/docs/api/thrift
Cisco WAE 6.2 Documentation Roadmap
1-3
Chapter 1
Guides
Cisco WAE 6.2 Documentation Roadmap
1-4
Documentation Roadmap